| POST | /schedule/getschedule |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FromDate | body | DateTime | No | |
| ToDate | body | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Latitude | form | double | No | Latitude of the user making this request |
| Longitude | form | double | No | Longitude of the user making this request |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DateItems | form | List<ScheduleDateItem> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | Yes | Information about the response. |
| Heading | form | string | Yes | Heading or summary of the response. |
| WasSuccessful | form | boolean | Yes | Did the intended operation for this response complete successfully? |
| ResponseStatus | form | ResponseStatus | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Date | form | DateTime | No | |
| FormattedDateString | form | string | Yes | |
| ScheduleItems | form | List<ScheduleItems> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OutletName | form | string | Yes | |
| PrincipalName | form | string | Yes | |
| ReferenceNumber | form | string | Yes | |
| IsSubmitted | form | bool | 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.
POST /schedule/getschedule HTTP/1.1
Host: returnit-api-dev.happen.zone
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"DateItems":[{}],"Description":"String","Heading":"String","WasSuccessful":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}