Trendsic Platform Service

<back to all web services

CourierBookPageRequest

The following routes are available for this service:
GET,OPTIONS/v1/book/{Slug}
CourierBookPageRequest Parameters:
NameParameterData TypeRequiredDescription
SlugpathstringNo
ProfilequerystringNo
CourierBookPageResponse Parameters:
NameParameterData TypeRequiredDescription
PageformCourierBookPageViewNo
ResponseStatusformResponseStatusNo
CourierBookPageView Parameters:
NameParameterData TypeRequiredDescription
AvailableformboolNo
BookingOnformboolNo
BusinessformCourierTrackBusinessNo
ProfileformCourierBookProfileNo
ProfilesformList<CourierBookProfileLink>No
CardEnabledformboolNo
PublishableKeyformstringNo
AppUrlformstringNo
TodayformstringNo
WeekdayformintNo
NowMinformintNo
CourierTrackBusiness Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PhoneformstringNo
CourierBookProfile Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
ShapeformstringNo
TemplateformstringNo
UnitOneformstringNo
UnitManyformstringNo
UnitOneEsformstringNo
UnitManyEsformstringNo
FacilityNounformstringNo
FacilityNounEsformstringNo
FacilityNameformstringNo
LevelsformList<CourierBookLevel>No
AsapformboolNo
RecurringformboolNo
PayTimingformstringNo
FinalAfterCountformboolNo
CancelFeeformdecimalNo
MissedFeeformdecimalNo
MissedWaitMinformintNo
ServiceAreaformList<string>No
ZipsformList<string>No
HandoffsformHandoffOptionsNo
CourierBookLevel Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
ReadyformstringNo
WithinMinformintNo
InByformstringNo
SurchargeformdecimalNo
DaysformList<int>No
DeadlineMinformint?No
HandoffOptions Parameters:
NameParameterData TypeRequiredDescription
HandformboolNo
PorchformboolNo
DeskformboolNo
SigRequiredformboolNo
IdRequiredformboolNo
CodeRequiredformboolNo
CourierBookProfileLink Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
ShapeformstringNo

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/book/{Slug} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Page":{"Available":false,"BookingOn":false,"Business":{"Name":"String","Phone":"String"},"Profile":{"Code":"String","Name":"String","Shape":"String","Template":"String","UnitOne":"String","UnitMany":"String","UnitOneEs":"String","UnitManyEs":"String","FacilityNoun":"String","FacilityNounEs":"String","FacilityName":"String","Levels":[{"Code":"String","Name":"String","Ready":"String","WithinMin":0,"InBy":"String","Surcharge":0,"Days":[0],"DeadlineMin":0}],"Asap":false,"Recurring":false,"PayTiming":"String","FinalAfterCount":false,"CancelFee":0,"MissedFee":0,"MissedWaitMin":0,"ServiceArea":["String"],"Zips":["String"],"Handoffs":{"Hand":false,"Porch":false,"Desk":false,"SigRequired":false,"IdRequired":false,"CodeRequired":false}},"Profiles":[{"Code":"String","Name":"String","Shape":"String"}],"CardEnabled":false,"PublishableKey":"String","AppUrl":"String","Today":"String","Weekday":0,"NowMin":0},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}