Trendsic Platform Service

<back to all web services

CourierAvailabilityRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/courier/profiles/{Id}/availability
CourierAvailabilityRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
DatequerystringNo
ZipquerystringNo
CourierAvailabilityResponse Parameters:
NameParameterData TypeRequiredDescription
AvailabilityformAvailabilityNo
DateformstringNo
ResponseStatusformResponseStatusNo
Availability Parameters:
NameParameterData TypeRequiredDescription
InAreaformboolNo
ZipCheckedformboolNo
ClosedformboolNo
WindowsformList<Window>No
Window Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DayIxformintNo
StartMinformintNo
EndMinformintNo
LabelformstringNo
AsapformboolNo
LevelsformList<LevelOffer>No
LevelOffer Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
OkformboolNo
WhyformstringNo
PromiseformstringNo
SurchargeformdecimalNo

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.

GET /v1/dispatch/courier/profiles/{Id}/availability HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Availability":{"InArea":false,"ZipChecked":false,"Closed":false,"Windows":[{"Id":"String","DayIx":0,"StartMin":0,"EndMin":0,"Label":"String","Asap":false,"Levels":[{"Code":"String","Name":"String","Ok":false,"Why":"String","Promise":"String","Surcharge":0}]}]},"Date":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}