| GET,OPTIONS | /v1/book/{Slug} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Slug | path | string | No | |
| Profile | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | form | CourierBookPageView | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Available | form | bool | No | |
| BookingOn | form | bool | No | |
| Business | form | CourierTrackBusiness | No | |
| Profile | form | CourierBookProfile | No | |
| Profiles | form | List<CourierBookProfileLink> | No | |
| CardEnabled | form | bool | No | |
| PublishableKey | form | string | No | |
| AppUrl | form | string | No | |
| Today | form | string | No | |
| Weekday | form | int | No | |
| NowMin | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Phone | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| Name | form | string | No | |
| Shape | form | string | No | |
| Template | form | string | No | |
| UnitOne | form | string | No | |
| UnitMany | form | string | No | |
| UnitOneEs | form | string | No | |
| UnitManyEs | form | string | No | |
| FacilityNoun | form | string | No | |
| FacilityNounEs | form | string | No | |
| FacilityName | form | string | No | |
| Levels | form | List<CourierBookLevel> | No | |
| Asap | form | bool | No | |
| Recurring | form | bool | No | |
| PayTiming | form | string | No | |
| FinalAfterCount | form | bool | No | |
| CancelFee | form | decimal | No | |
| MissedFee | form | decimal | No | |
| MissedWaitMin | form | int | No | |
| ServiceArea | form | List<string> | No | |
| Zips | form | List<string> | No | |
| Handoffs | form | HandoffOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| Name | form | string | No | |
| Ready | form | string | No | |
| WithinMin | form | int | No | |
| InBy | form | string | No | |
| Surcharge | form | decimal | No | |
| Days | form | List<int> | No | |
| DeadlineMin | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Hand | form | bool | No | |
| Porch | form | bool | No | |
| Desk | form | bool | No | |
| SigRequired | form | bool | No | |
| IdRequired | form | bool | No | |
| CodeRequired | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| Name | form | string | No | |
| Shape | form | string | No |
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
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"}}}