Trendsic Platform Service

<back to all web services

CourierRunBuildRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/courier/runs
CourierRunBuildRequest Parameters:
NameParameterData TypeRequiredDescription
ProfileIdbodyintNo
FacilityCodebodystringNo
CodesbodyList<string>No
DriverContactIdbodyint?No
EquipmentIDbodyint?No
CourierRunResponse Parameters:
NameParameterData TypeRequiredDescription
RunsformList<CourierRunView>No
RunformCourierRunViewNo
MessageformstringNo
ResponseStatusformResponseStatusNo
CourierRunView Parameters:
NameParameterData TypeRequiredDescription
CourierRunIDformintNo
CodeformstringNo
StatusformstringNo
CourierProfileIdformintNo
ProfileNameformstringNo
CourierFacilityIdformintNo
FacilityNameformstringNo
FacilityAddressformstringNo
DriverContactIdformint?No
DriverNameformstringNo
EquipmentIDformint?No
VehicleUnitformstringNo
UnitOneformstringNo
UnitManyformstringNo
UnitsformintNo
StopCountformintNo
StopsDoneformintNo
Payformdecimal?No
BuiltUtcformDateTime?No
StartedUtcformDateTime?No
CompletedUtcformDateTime?No
ToLoadformintNo
ToReturnformintNo
StopsformList<CourierStopView>No
CourierStopView Parameters:
NameParameterData TypeRequiredDescription
SequenceformintNo
StatusformstringNo
DispatchOdRequestIDformintNo
CodeformstringNo
CourierStepformstringNo
AddressformstringNo
UnitformstringNo
CityformstringNo
ZipformstringNo
Latformdecimal?No
Lngformdecimal?No
CustomerNameformstringNo
CustomerPhoneformstringNo
HandoffformstringNo
GateCodeformstringNo
InstructionsformstringNo
UnitsformintNo
DueTextformstringNo
NoteformstringNo
NeedsformList<string>No
ItemsformList<CourierItemView>No
CourierItemView Parameters:
NameParameterData TypeRequiredDescription
CourierItemIDformintNo
DispatchOdRequestIDformintNo
SeqformintNo
TagCodeformstringNo
CustodyformstringNo
IsOpenformboolNo
IsMissingformboolNo
MissingReasonformstringNo
IsManualformboolNo
ReTagFlagformboolNo
ScannedformboolNo

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.

POST /v1/dispatch/courier/runs HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ProfileId":0,"FacilityCode":"String","Codes":["String"],"DriverContactId":0,"EquipmentID":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Runs":[{"CourierRunID":0,"Code":"String","Status":"String","CourierProfileId":0,"ProfileName":"String","CourierFacilityId":0,"FacilityName":"String","FacilityAddress":"String","DriverContactId":0,"DriverName":"String","EquipmentID":0,"VehicleUnit":"String","UnitOne":"String","UnitMany":"String","Units":0,"StopCount":0,"StopsDone":0,"Pay":0,"BuiltUtc":"0001-01-01T00:00:00.0000000","StartedUtc":"0001-01-01T00:00:00.0000000","CompletedUtc":"0001-01-01T00:00:00.0000000","ToLoad":0,"ToReturn":0,"Stops":[{"Sequence":0,"Status":"String","DispatchOdRequestID":0,"Code":"String","CourierStep":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","Units":0,"DueText":"String","Note":"String","Needs":["String"],"Items":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}]}]}],"Run":{"CourierRunID":0,"Code":"String","Status":"String","CourierProfileId":0,"ProfileName":"String","CourierFacilityId":0,"FacilityName":"String","FacilityAddress":"String","DriverContactId":0,"DriverName":"String","EquipmentID":0,"VehicleUnit":"String","UnitOne":"String","UnitMany":"String","Units":0,"StopCount":0,"StopsDone":0,"Pay":0,"BuiltUtc":"0001-01-01T00:00:00.0000000","StartedUtc":"0001-01-01T00:00:00.0000000","CompletedUtc":"0001-01-01T00:00:00.0000000","ToLoad":0,"ToReturn":0,"Stops":[{"Sequence":0,"Status":"String","DispatchOdRequestID":0,"Code":"String","CourierStep":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","Units":0,"DueText":"String","Note":"String","Needs":["String"],"Items":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}]}]},"Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}