Trendsic Platform Service

<back to all web services

DispatchPickupPageRequest

The following routes are available for this service:
GET,OPTIONS/v1/dispatch/public/pickup/{SchedulerUrl}
DispatchPickupPageRequest Parameters:
NameParameterData TypeRequiredDescription
SchedulerUrlpathstringNo
DispatchPickupPageResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyNameformstringNo
ZonesformList<DispatchZoneView>No
NeedsformList<DispatchNeedView>No
CardEnabledformboolNo
PublishableKeyformstringNo
ResponseStatusformResponseStatusNo
DispatchZoneView Parameters:
NameParameterData TypeRequiredDescription
ZoneformstringNo
BaseformdecimalNo
PerBagformdecimalNo
PremiumUpliftPctformdecimalNo
DriversformintNo
IdleDriversformintNo
DispatchNeedView Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
LabelformstringNo
SubformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/dispatch/public/pickup/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CompanyName":"String","Zones":[{"Zone":"String","Base":0,"PerBag":0,"PremiumUpliftPct":0,"Drivers":0,"IdleDrivers":0}],"Needs":[{"Id":"String","Label":"String","Sub":"String"}],"CardEnabled":false,"PublishableKey":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}