Trendsic Platform Service

<back to all web services

DispatchPatternRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/dispatch/settings/pattern
"use strict";
export class DispatchModuleView {
    /** @param {{Key?:string,Mode?:string,Allowed?:boolean,Enabled?:boolean,InFlight?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Mode;
    /** @type {boolean} */
    Allowed;
    /** @type {boolean} */
    Enabled;
    /** @type {number} */
    InFlight;
}
export class DispatchPatternView {
    /** @param {{PatternId?:string,Name?:string,Source?:string,Facility?:string,Unit?:string,HasQuotas?:boolean,IsInverted?:boolean,LoadLimitMins?:number,TicketSource?:string,PayBasis?:string,IsActive?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PatternId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Source;
    /** @type {string} */
    Facility;
    /** @type {string} */
    Unit;
    /** @type {boolean} */
    HasQuotas;
    /** @type {boolean} */
    IsInverted;
    /** @type {number} */
    LoadLimitMins;
    /** @type {string} */
    TicketSource;
    /** @type {string} */
    PayBasis;
    /** @type {boolean} */
    IsActive;
}
export class DispatchModulesResponse {
    /** @param {{Modules?:DispatchModuleView[],Patterns?:DispatchPatternView[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DispatchModuleView[]} */
    Modules = [];
    /** @type {DispatchPatternView[]} */
    Patterns = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchPatternRequest {
    /** @param {{PatternId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PatternId;
}

JavaScript DispatchPatternRequest 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.

PUT /v1/dispatch/settings/pattern 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
		}
	}
}