Trendsic Platform Service

<back to all web services

ShiftPatternArchiveRequest

Requires Authentication
The following routes are available for this service:
DELETE/v1/workforce/patterns/{ShiftPatternID}
ShiftPatternArchiveRequest Parameters:
NameParameterData TypeRequiredDescription
ShiftPatternIDpathintNo
ShiftPatternsResponse Parameters:
NameParameterData TypeRequiredDescription
PatternsformList<ShiftPattern>No
ResponseStatusformResponseStatusNo
ShiftPattern Parameters:
NameParameterData TypeRequiredDescription
ShiftPatternIDformintNo
BranchIdformGuid?No
CodeformstringNo
NameformstringNo
StructformstringNo
HoursPerDayformdecimalNo
OnDaysformintNo
OffDaysformintNo
PatternTypeformstringNo
IsNightformboolNo
HasBoundaryformboolNo
IsHitchformboolNo
HasTravelformboolNo
IsSeasonalformboolNo
SeasonalWindowformstringNo
IsDayRateformboolNo
OtRuleIdformstringNo
PerDiemRuleIdformstringNo
PacksformstringNo
StatusformstringNo
IsSeedformboolNo
AssignedCountformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /v1/workforce/patterns/{ShiftPatternID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Patterns: 
	[
		{
			ShiftPatternID: 0,
			BranchId: 00000000000000000000000000000000,
			Code: String,
			Name: String,
			Struct: String,
			HoursPerDay: 0,
			OnDays: 0,
			OffDays: 0,
			PatternType: String,
			IsNight: False,
			HasBoundary: False,
			IsHitch: False,
			HasTravel: False,
			IsSeasonal: False,
			SeasonalWindow: String,
			IsDayRate: False,
			OtRuleId: String,
			PerDiemRuleId: String,
			Packs: String,
			Status: String,
			IsSeed: False,
			AssignedCount: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}