Trendsic Platform Service

<back to all web services

DispatchModulesSaveRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/dispatch/settings/modules

export class DispatchModuleView
{
    public Key: string;
    public Mode: string;
    public Allowed: boolean;
    public Enabled: boolean;
    public InFlight: number;

    public constructor(init?: Partial<DispatchModuleView>) { (Object as any).assign(this, init); }
}

export class DispatchPatternView
{
    public PatternId: string;
    public Name: string;
    public Source: string;
    public Facility: string;
    public Unit: string;
    public HasQuotas: boolean;
    public IsInverted: boolean;
    public LoadLimitMins: number;
    public TicketSource: string;
    public PayBasis: string;
    public IsActive: boolean;

    public constructor(init?: Partial<DispatchPatternView>) { (Object as any).assign(this, init); }
}

export class DispatchModulesResponse
{
    public Modules: DispatchModuleView[] = [];
    public Patterns: DispatchPatternView[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DispatchModulesResponse>) { (Object as any).assign(this, init); }
}

export class DispatchModulesSaveRequest
{
    public Key: string;
    public Enabled: boolean;

    public constructor(init?: Partial<DispatchModulesSaveRequest>) { (Object as any).assign(this, init); }
}

TypeScript DispatchModulesSaveRequest 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/modules HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Key: String,
	Enabled: False
}
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
		}
	}
}