Trendsic Platform Service

<back to all web services

DispatchRequestDeclineRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/requests/{RequestId}/decline
DispatchRequestDeclineRequest Parameters:
NameParameterData TypeRequiredDescription
RequestIdpathintNo
ReasonbodystringNo
DispatchRequestsResponse Parameters:
NameParameterData TypeRequiredDescription
RequestsformList<DispatchRequestView>No
RequestformDispatchRequestViewNo
RigCountsformList<DispatchRigCountView>No
CarriersformList<DispatchCarrierPickView>No
QuoteLinkformstringNo
DeliveryformstringNo
ResponseStatusformResponseStatusNo
DispatchRequestView Parameters:
NameParameterData TypeRequiredDescription
RequestIdformintNo
CodeformstringNo
CustomerNameformstringNo
CustomerPhoneformstringNo
CustomerEmailformstringNo
CargoformstringNo
UnitsformintNo
FromLocformstringNo
ToLocformstringNo
Milesformint?No
WindowTextformstringNo
IsUrgentformboolNo
NotesformstringNo
SourceformstringNo
StatusformstringNo
RequiredRigformstringNo
UnitsPerTruckformint?No
RatePerLoadformdecimal?No
UrgencyPctformdecimalNo
CostPerLoadformdecimal?No
LoadsNeededformint?No
QuoteTotalformdecimal?No
QuoteVersionformintNo
QuotedUtcformDateTime?No
QuotedByformstringNo
AcceptTokenExpiresUtcformDateTime?No
AcceptedUtcformDateTime?No
AcceptedViaformstringNo
DeclinedUtcformDateTime?No
DeclinedByformstringNo
DeclineReasonformstringNo
JobsCreatedformintNo
JobsDoneformintNo
JobsNeedDriverformintNo
CreatedUtcformDateTimeNo
CreatedByformstringNo
EventsformList<DispatchRequestEventView>No
DispatchRequestEventView Parameters:
NameParameterData TypeRequiredDescription
EventIdformintNo
KindformstringNo
DetailformstringNo
AtUtcformDateTimeNo
ByWhoformstringNo
DispatchRigCountView Parameters:
NameParameterData TypeRequiredDescription
RigTypeformstringNo
RigsformintNo
DispatchCarrierPickView Parameters:
NameParameterData TypeRequiredDescription
VendorIDformintNo
VendorNameformstringNo

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/requests/{RequestId}/decline HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RequestId":0,"Reason":"String"}

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

{"Requests":[{"RequestId":0,"Code":"String","CustomerName":"String","CustomerPhone":"String","CustomerEmail":"String","Cargo":"String","Units":0,"FromLoc":"String","ToLoc":"String","Miles":0,"WindowText":"String","IsUrgent":false,"Notes":"String","Source":"String","Status":"String","RequiredRig":"String","UnitsPerTruck":0,"RatePerLoad":0,"UrgencyPct":0,"CostPerLoad":0,"LoadsNeeded":0,"QuoteTotal":0,"QuoteVersion":0,"QuotedUtc":"0001-01-01T00:00:00.0000000","QuotedBy":"String","AcceptTokenExpiresUtc":"0001-01-01T00:00:00.0000000","AcceptedUtc":"0001-01-01T00:00:00.0000000","AcceptedVia":"String","DeclinedUtc":"0001-01-01T00:00:00.0000000","DeclinedBy":"String","DeclineReason":"String","JobsCreated":0,"JobsDone":0,"JobsNeedDriver":0,"CreatedUtc":"0001-01-01T00:00:00.0000000","CreatedBy":"String","Events":[{"EventId":0,"Kind":"String","Detail":"String","AtUtc":"0001-01-01T00:00:00.0000000","ByWho":"String"}]}],"Request":{"RequestId":0,"Code":"String","CustomerName":"String","CustomerPhone":"String","CustomerEmail":"String","Cargo":"String","Units":0,"FromLoc":"String","ToLoc":"String","Miles":0,"WindowText":"String","IsUrgent":false,"Notes":"String","Source":"String","Status":"String","RequiredRig":"String","UnitsPerTruck":0,"RatePerLoad":0,"UrgencyPct":0,"CostPerLoad":0,"LoadsNeeded":0,"QuoteTotal":0,"QuoteVersion":0,"QuotedUtc":"0001-01-01T00:00:00.0000000","QuotedBy":"String","AcceptTokenExpiresUtc":"0001-01-01T00:00:00.0000000","AcceptedUtc":"0001-01-01T00:00:00.0000000","AcceptedVia":"String","DeclinedUtc":"0001-01-01T00:00:00.0000000","DeclinedBy":"String","DeclineReason":"String","JobsCreated":0,"JobsDone":0,"JobsNeedDriver":0,"CreatedUtc":"0001-01-01T00:00:00.0000000","CreatedBy":"String","Events":[{"EventId":0,"Kind":"String","Detail":"String","AtUtc":"0001-01-01T00:00:00.0000000","ByWho":"String"}]},"RigCounts":[{"RigType":"String","Rigs":0}],"Carriers":[{"VendorID":0,"VendorName":"String"}],"QuoteLink":"String","Delivery":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}