| GET,OPTIONS | /v1/dispatch/courier/profiles/{Id}/availability |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | int | No | |
| Date | query | string | No | |
| Zip | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Availability | form | Availability | No | |
| Date | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InArea | form | bool | No | |
| ZipChecked | form | bool | No | |
| Closed | form | bool | No | |
| Windows | form | List<Window> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| DayIx | form | int | No | |
| StartMin | form | int | No | |
| EndMin | form | int | No | |
| Label | form | string | No | |
| Asap | form | bool | No | |
| Levels | form | List<LevelOffer> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| Name | form | string | No | |
| Ok | form | bool | No | |
| Why | form | string | No | |
| Promise | form | string | No | |
| Surcharge | form | decimal | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}