Trendsic Platform Service

<back to all web services

DispatchIncidentLoadRequest

Requires Authentication
Requires any of the permissions:DISPATCH:HAUL:MANAGE, DISPATCH:JOB:MANAGE, DISPATCH:ONDEMAND:MANAGE
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/incidents/{IncidentId}/load
DispatchIncidentLoadRequest Parameters:
NameParameterData TypeRequiredDescription
IncidentIdpathintNo
ActionbodystringNo
TransloadTruckCodebodystringNo
DispatchIncidentsResponse Parameters:
NameParameterData TypeRequiredDescription
IncidentsformList<DispatchIncidentView>No
EmptyTrucksformList<DispatchIncidentTruckView>No
TrucksformList<DispatchIncidentTruckView>No
TransloadTruckCodeformstringNo
ResponseStatusformResponseStatusNo
DispatchIncidentView Parameters:
NameParameterData TypeRequiredDescription
IncidentIdformintNo
CodeformstringNo
KindformstringNo
KindDetailformstringNo
LoadIdformint?No
LoadCodeformstringNo
LoadStatusformstringNo
SourceLabelformstringNo
DestinationLabelformstringNo
QtyTextformstringNo
TruckCodeformstringNo
TruckLabelformstringNo
LocationTextformstringNo
Latformdecimal?No
Lngformdecimal?No
DriverPrefformstringNo
OpenedByformstringNo
OpenedViaformstringNo
ResolverformstringNo
StatusformstringNo
TruckRecoveryformstringNo
TruckRecoveredUtcformDateTime?No
LoadRecoveryformstringNo
LoadRecoveredUtcformDateTime?No
TransloadTruckCodeformstringNo
HoldIdformint?No
HoldCodeformstringNo
PhotoCountformintNo
OpenedUtcformDateTimeNo
ResolvedUtcformDateTime?No
ResolvedByformstringNo
ReopenedUtcformDateTime?No
MessagesformList<DispatchIncidentMessageView>No
DispatchIncidentMessageView Parameters:
NameParameterData TypeRequiredDescription
MessageIdformintNo
WhoformstringNo
RoleformstringNo
MsgformstringNo
AtUtcformDateTimeNo
DispatchIncidentTruckView Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
DriverNameformstringNo
StageformstringNo
OpenLoadCodeformstringNo

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dispatch/incidents/{IncidentId}/load HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"IncidentId":0,"Action":"String","TransloadTruckCode":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Incidents":[{"IncidentId":0,"Code":"String","Kind":"String","KindDetail":"String","LoadId":0,"LoadCode":"String","LoadStatus":"String","SourceLabel":"String","DestinationLabel":"String","QtyText":"String","TruckCode":"String","TruckLabel":"String","LocationText":"String","Lat":0,"Lng":0,"DriverPref":"String","OpenedBy":"String","OpenedVia":"String","Resolver":"String","Status":"String","TruckRecovery":"String","TruckRecoveredUtc":"0001-01-01T00:00:00.0000000","LoadRecovery":"String","LoadRecoveredUtc":"0001-01-01T00:00:00.0000000","TransloadTruckCode":"String","HoldId":0,"HoldCode":"String","PhotoCount":0,"OpenedUtc":"0001-01-01T00:00:00.0000000","ResolvedUtc":"0001-01-01T00:00:00.0000000","ResolvedBy":"String","ReopenedUtc":"0001-01-01T00:00:00.0000000","Messages":[{"MessageId":0,"Who":"String","Role":"String","Msg":"String","AtUtc":"0001-01-01T00:00:00.0000000"}]}],"EmptyTrucks":[{"Code":"String","DriverName":"String","Stage":"String","OpenLoadCode":"String"}],"Trucks":[{"Code":"String","DriverName":"String","Stage":"String","OpenLoadCode":"String"}],"TransloadTruckCode":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}