Trendsic Platform Service

<back to all web services

CourierVansRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/courier/vans
CourierOfficeResponse Parameters:
NameParameterData TypeRequiredDescription
OfficeformCourierOfficeViewNo
AvailableformboolNo
ResponseStatusformResponseStatusNo
CourierOfficeView Parameters:
NameParameterData TypeRequiredDescription
ServerUtcformDateTimeNo
VansformList<CourierOfficeVan>No
HeldformList<CourierHeldView>No
VehiclesformList<CourierVehicleOption>No
ProfilesformList<CourierProfileOption>No
DriversformList<CourierDriverOption>No
DeskformList<CourierDeskRow>No
GoCountformintNo
HeldCountformintNo
ReadyToOfferformintNo
IntakeMinformint?No
FacilityNounformstringNo
CourierOfficeVan Parameters:
NameParameterData TypeRequiredDescription
DriverContactIdformintNo
DriverCodeformstringNo
NameformstringNo
OnlineformboolNo
ZoneformstringNo
VehicleUnitformstringNo
FacilityNameformstringNo
StateformstringNo
LeaveByUtcformDateTime?No
LeaveByTextformstringNo
SlackMinformint?No
InVanformintNo
CommittedformintNo
Capformdecimal?No
CapUnitformstringNo
UnitManyformstringNo
CriticalCodeformstringNo
DriveMinformintNo
SendNoteformstringNo
AboardformList<CourierVanChip>No
QueuedformList<CourierVanChip>No
CourierVanChip Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
CourierStepformstringNo
LevelCodeformstringNo
LevelNameformstringNo
UnitsformintNo
AreaformstringNo
DueUtcformDateTime?No
DueTextformstringNo
MovableformboolNo
NoMoveWhyformstringNo
TargetsformList<CourierMoveTarget>No
CourierMoveTarget Parameters:
NameParameterData TypeRequiredDescription
DriverContactIdformintNo
NameformstringNo
OkformboolNo
WhyformstringNo
LeaveByTextformstringNo
CourierHeldView Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
AreaformstringNo
UnitsformintNo
UnitManyformstringNo
Milesformdecimal?No
LevelCodeformstringNo
LevelNameformstringNo
DueTextformstringNo
HeldReasonformstringNo
HeldMinformint?No
WhyformList<string>No
BestDriverContactIdformint?No
BestNameformstringNo
BestLeaveByTextformstringNo
CourierVehicleOption Parameters:
NameParameterData TypeRequiredDescription
CourierProfileIdformintNo
EquipmentIDformintNo
UnitNumberformstringNo
VehicleTypeformstringNo
CapacityUnitformstringNo
CapacityLimitformdecimal?No
IsRefrigeratedformboolNo
StatusformstringNo
CourierProfileOption Parameters:
NameParameterData TypeRequiredDescription
CourierProfileIDformintNo
NameformstringNo
RouteShapeformstringNo
EnabledformboolNo
UnitOneformstringNo
UnitManyformstringNo
FacilityNounformstringNo
FacilitiesformList<CourierFacilityOption>No
CourierFacilityOption Parameters:
NameParameterData TypeRequiredDescription
CourierFacilityIDformintNo
CodeformstringNo
NameformstringNo
AddressformstringNo
IntakeMinformintNo
CourierDriverOption Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
CodeformstringNo
NameformstringNo
OnlineformboolNo
ZoneformstringNo
VehicleUnitformstringNo
EquipmentIDformint?No
SentToFacilityformboolNo
CourierDeskRow Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
CourierProfileIdformintNo
FacilityNameformstringNo
LevelCodeformstringNo
LevelNameformstringNo
DueUtcformDateTime?No
DueTextformstringNo
UnitsformintNo
UnitsFoundformint?No
UnitManyformstringNo
Fareformdecimal?No
FinalPriceformdecimal?No
TipAmountformdecimal?No
PayModeformstringNo
CaptureModeformstringNo
CustomerNameformstringNo
AreaformstringNo
IntakeUtcformDateTime?No
IntakeMinAgoformint?No
DamageNoteformstringNo
FinalPriceAfterCountformboolNo
NeedsPriceformboolNo
ItemCountformintNo
MissingCountformintNo
PhotoCountformintNo

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.

GET /v1/dispatch/courier/vans HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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

{"Office":{"ServerUtc":"0001-01-01T00:00:00.0000000","Vans":[{"DriverContactId":0,"DriverCode":"String","Name":"String","Online":false,"Zone":"String","VehicleUnit":"String","FacilityName":"String","State":"String","LeaveByUtc":"0001-01-01T00:00:00.0000000","LeaveByText":"String","SlackMin":0,"InVan":0,"Committed":0,"Cap":0,"CapUnit":"String","UnitMany":"String","CriticalCode":"String","DriveMin":0,"SendNote":"String","Aboard":[{"Code":"String","CourierStep":"String","LevelCode":"String","LevelName":"String","Units":0,"Area":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Movable":false,"NoMoveWhy":"String","Targets":[{"DriverContactId":0,"Name":"String","Ok":false,"Why":"String","LeaveByText":"String"}]}],"Queued":[{"Code":"String","CourierStep":"String","LevelCode":"String","LevelName":"String","Units":0,"Area":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Movable":false,"NoMoveWhy":"String","Targets":[{"DriverContactId":0,"Name":"String","Ok":false,"Why":"String","LeaveByText":"String"}]}]}],"Held":[{"Code":"String","Area":"String","Units":0,"UnitMany":"String","Miles":0,"LevelCode":"String","LevelName":"String","DueText":"String","HeldReason":"String","HeldMin":0,"Why":["String"],"BestDriverContactId":0,"BestName":"String","BestLeaveByText":"String"}],"Vehicles":[{"CourierProfileId":0,"EquipmentID":0,"UnitNumber":"String","VehicleType":"String","CapacityUnit":"String","CapacityLimit":0,"IsRefrigerated":false,"Status":"String"}],"Profiles":[{"CourierProfileID":0,"Name":"String","RouteShape":"String","Enabled":false,"UnitOne":"String","UnitMany":"String","FacilityNoun":"String","Facilities":[{"CourierFacilityID":0,"Code":"String","Name":"String","Address":"String","IntakeMin":0}]}],"Drivers":[{"ContactId":0,"Code":"String","Name":"String","Online":false,"Zone":"String","VehicleUnit":"String","EquipmentID":0,"SentToFacility":false}],"Desk":[{"Code":"String","CourierProfileId":0,"FacilityName":"String","LevelCode":"String","LevelName":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Units":0,"UnitsFound":0,"UnitMany":"String","Fare":0,"FinalPrice":0,"TipAmount":0,"PayMode":"String","CaptureMode":"String","CustomerName":"String","Area":"String","IntakeUtc":"0001-01-01T00:00:00.0000000","IntakeMinAgo":0,"DamageNote":"String","FinalPriceAfterCount":false,"NeedsPrice":false,"ItemCount":0,"MissingCount":0,"PhotoCount":0}],"GoCount":0,"HeldCount":0,"ReadyToOffer":0,"IntakeMin":0,"FacilityNoun":"String"},"Available":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}