Trendsic Platform Service

<back to all web services

DispatchPatternSampleRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/settings/pattern/sample
import Foundation
import ServiceStack

public class DispatchPatternSampleRequest : Codable
{
    public var patternId:String

    required public init(){}
}

public class DispatchModulesResponse : Codable
{
    public var modules:[DispatchModuleView] = []
    public var patterns:[DispatchPatternView] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DispatchModuleView : Codable
{
    public var key:String
    public var mode:String
    public var allowed:Bool
    public var enabled:Bool
    public var inFlight:Int

    required public init(){}
}

public class DispatchPatternView : Codable
{
    public var patternId:String
    public var name:String
    public var source:String
    public var facility:String
    public var unit:String
    public var hasQuotas:Bool
    public var isInverted:Bool
    public var loadLimitMins:Int
    public var ticketSource:String
    public var payBasis:String
    public var isActive:Bool

    required public init(){}
}


Swift DispatchPatternSampleRequest 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.

POST /v1/dispatch/settings/pattern/sample HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PatternId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Modules: 
	[
		{
			Key: String,
			Mode: String,
			Allowed: False,
			Enabled: False,
			InFlight: 0
		}
	],
	Patterns: 
	[
		{
			PatternId: String,
			Name: String,
			Source: String,
			Facility: String,
			Unit: String,
			HasQuotas: False,
			IsInverted: False,
			LoadLimitMins: 0,
			TicketSource: String,
			PayBasis: String,
			IsActive: False
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}