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
DispatchModulesSaveRequest Parameters:
NameParameterData TypeRequiredDescription
KeybodystringNo
EnabledbodyboolNo
DispatchModulesResponse Parameters:
NameParameterData TypeRequiredDescription
ModulesformList<DispatchModuleView>No
PatternsformList<DispatchPatternView>No
ResponseStatusformResponseStatusNo
DispatchModuleView Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
ModeformstringNo
AllowedformboolNo
EnabledformboolNo
InFlightformintNo
DispatchPatternView Parameters:
NameParameterData TypeRequiredDescription
PatternIdformstringNo
NameformstringNo
SourceformstringNo
FacilityformstringNo
UnitformstringNo
HasQuotasformboolNo
IsInvertedformboolNo
LoadLimitMinsformintNo
TicketSourceformstringNo
PayBasisformstringNo
IsActiveformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"Key":"String","Enabled":false}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}