Trendsic Platform Service

<back to all web services

DriverIncidentMessageRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/worker/dispatch/incident/{IncidentId}/message
DriverIncidentMessageRequest Parameters:
NameParameterData TypeRequiredDescription
IncidentIdpathintNo
MsgbodystringNo
DriverMeResponse Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
NameformstringNo
PhoneformstringNo
PayPlanNameformstringNo
PayPlanBasisformstringNo
PayPlanRateformdecimal?No
TruckformDriverTruckViewNo
RigformDriverRigViewNo
JobsformList<DriverJobView>No
OdformDriverOdViewNo
IncidentsformList<DriverIncidentView>No
PayformList<DriverPayLineView>No
ServerUtcformDateTimeNo
MessageformstringNo
ResponseStatusformResponseStatusNo
DriverTruckView Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
StageformstringNo
StageSinceUtcformDateTime?No
LoadsTodayformintNo
NetTodayformdecimalNo
EstLoadformdecimal?No
SlotformstringNo
SiteNameformstringNo
SupplierNameformstringNo
NextSiteNameformstringNo
FacilityformstringNo
FacilityShortformstringNo
UnitformstringNo
QueuePositionformint?No
HoldCodeformstringNo
HoldReasonformstringNo
HoldEndUtcformDateTime?No
OpenLoadIdformint?No
OpenLoadCodeformstringNo
OpenLoadPhotosformintNo
StampsformList<DriverStampView>No
DriverStampView Parameters:
NameParameterData TypeRequiredDescription
StageformstringNo
AtUtcformDateTimeNo
NoteformstringNo
DriverRigView Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
RigTypeformstringNo
IsFreeformboolNo
HoldCodeformstringNo
HoldReasonformstringNo
HoldEndUtcformDateTime?No
DriverJobView Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
CodeformstringNo
CargoformstringNo
CustomerformstringNo
CustomerPhoneformstringNo
HoldContactformstringNo
HoldPhoneformstringNo
FromLocformstringNo
ToLocformstringNo
MilesformintNo
WindowTextformstringNo
StageformstringNo
Rateformdecimal?No
RequiredRigformstringNo
EtaTextformstringNo
OfferExpiresUtcformDateTime?No
RequestIdformint?No
LoadIdformint?No
LoadCodeformstringNo
LoadPayformdecimal?No
PhotosformintNo
StampsformList<DriverStampView>No
DriverOdView Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
ZoneformstringNo
StatusformstringNo
TierformstringNo
CapabilitiesformstringNo
PingCodeformstringNo
PingAddressformstringNo
PingZoneformstringNo
PingBagsformint?No
PingNeedsformstringNo
PingNoteformstringNo
PingExpiresUtcformDateTime?No
RunCodeformstringNo
RunAddressformstringNo
RunZoneformstringNo
RunBagsformint?No
RunStageformstringNo
RunNeedsformstringNo
RunNoteformstringNo
RunEtaformstringNo
OdBaseformdecimal?No
OdPerBagformdecimal?No
HoldCodeformstringNo
HoldReasonformstringNo
HoldEndUtcformDateTime?No
DriverIncidentView Parameters:
NameParameterData TypeRequiredDescription
IncidentIdformintNo
CodeformstringNo
KindformstringNo
KindDetailformstringNo
StatusformstringNo
LoadCodeformstringNo
TruckCodeformstringNo
LocationTextformstringNo
DriverPrefformstringNo
TruckRecoveryformstringNo
LoadRecoveryformstringNo
TransloadTruckCodeformstringNo
HoldCodeformstringNo
OpenedUtcformDateTimeNo
ResolvedUtcformDateTime?No
MessagesformList<DispatchIncidentMessageView>No
DispatchIncidentMessageView Parameters:
NameParameterData TypeRequiredDescription
MessageIdformintNo
WhoformstringNo
RoleformstringNo
MsgformstringNo
AtUtcformDateTimeNo
DriverPayLineView Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
ModuleformstringNo
SourceLabelformstringNo
DestinationLabelformstringNo
QtyTextformstringNo
Payformdecimal?No
PayPlanLabelformstringNo
StatusformstringNo
ClosedUtcformDateTime?No
OpenedUtcformDateTimeNo
TicketCodeformstringNo

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/worker/dispatch/incident/{IncidentId}/message HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"IncidentId":0,"Msg":"String"}

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

{"ContactId":0,"Name":"String","Phone":"String","PayPlanName":"String","PayPlanBasis":"String","PayPlanRate":0,"Truck":{"Code":"String","Stage":"String","StageSinceUtc":"0001-01-01T00:00:00.0000000","LoadsToday":0,"NetToday":0,"EstLoad":0,"Slot":"String","SiteName":"String","SupplierName":"String","NextSiteName":"String","Facility":"String","FacilityShort":"String","Unit":"String","QueuePosition":0,"HoldCode":"String","HoldReason":"String","HoldEndUtc":"0001-01-01T00:00:00.0000000","OpenLoadId":0,"OpenLoadCode":"String","OpenLoadPhotos":0,"Stamps":[{"Stage":"String","AtUtc":"0001-01-01T00:00:00.0000000","Note":"String"}]},"Rig":{"Code":"String","Name":"String","RigType":"String","IsFree":false,"HoldCode":"String","HoldReason":"String","HoldEndUtc":"0001-01-01T00:00:00.0000000"},"Jobs":[{"Kind":"String","Code":"String","Cargo":"String","Customer":"String","CustomerPhone":"String","HoldContact":"String","HoldPhone":"String","FromLoc":"String","ToLoc":"String","Miles":0,"WindowText":"String","Stage":"String","Rate":0,"RequiredRig":"String","EtaText":"String","OfferExpiresUtc":"0001-01-01T00:00:00.0000000","RequestId":0,"LoadId":0,"LoadCode":"String","LoadPay":0,"Photos":0,"Stamps":[{"Stage":"String","AtUtc":"0001-01-01T00:00:00.0000000","Note":"String"}]}],"Od":{"Code":"String","Name":"String","Zone":"String","Status":"String","Tier":"String","Capabilities":"String","PingCode":"String","PingAddress":"String","PingZone":"String","PingBags":0,"PingNeeds":"String","PingNote":"String","PingExpiresUtc":"0001-01-01T00:00:00.0000000","RunCode":"String","RunAddress":"String","RunZone":"String","RunBags":0,"RunStage":"String","RunNeeds":"String","RunNote":"String","RunEta":"String","OdBase":0,"OdPerBag":0,"HoldCode":"String","HoldReason":"String","HoldEndUtc":"0001-01-01T00:00:00.0000000"},"Incidents":[{"IncidentId":0,"Code":"String","Kind":"String","KindDetail":"String","Status":"String","LoadCode":"String","TruckCode":"String","LocationText":"String","DriverPref":"String","TruckRecovery":"String","LoadRecovery":"String","TransloadTruckCode":"String","HoldCode":"String","OpenedUtc":"0001-01-01T00:00:00.0000000","ResolvedUtc":"0001-01-01T00:00:00.0000000","Messages":[{"MessageId":0,"Who":"String","Role":"String","Msg":"String","AtUtc":"0001-01-01T00:00:00.0000000"}]}],"Pay":[{"Code":"String","Module":"String","SourceLabel":"String","DestinationLabel":"String","QtyText":"String","Pay":0,"PayPlanLabel":"String","Status":"String","ClosedUtc":"0001-01-01T00:00:00.0000000","OpenedUtc":"0001-01-01T00:00:00.0000000","TicketCode":"String"}],"ServerUtc":"0001-01-01T00:00:00.0000000","Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}