Trendsic Platform Service

<back to all web services

ShiftPatternsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/workforce/patterns
import Foundation
import ServiceStack

public class ShiftPatternsRequest : Codable
{
    required public init(){}
}

public class ShiftPatternsResponse : Codable
{
    public var patterns:[ShiftPattern] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ShiftPattern : Codable
{
    public var shiftPatternID:Int
    public var branchId:String?
    public var code:String
    public var name:String
    public var `struct`:String
    public var hoursPerDay:Double
    public var onDays:Int
    public var offDays:Int
    public var patternType:String
    public var isNight:Bool
    public var hasBoundary:Bool
    public var isHitch:Bool
    public var hasTravel:Bool
    public var isSeasonal:Bool
    public var seasonalWindow:String
    public var isDayRate:Bool
    public var otRuleId:String
    public var perDiemRuleId:String
    public var packs:String
    public var status:String
    public var isSeed:Bool
    public var assignedCount:Int

    required public init(){}
}


Swift ShiftPatternsRequest DTOs

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.

GET /v1/workforce/patterns 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
		}
	}
}