| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SystemUserId | query | int | No | |
| RefreshToken | query | string | Yes | |
| UtcOffset | query | int | 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 |
|---|---|---|---|---|
| Data | form | LoginData | 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 |
|---|---|---|---|---|
| SystemUserId | form | int | No | |
| ClientId | form | int | No | |
| VatValue | form | decimal | No | |
| RefreshToken | form | string | Yes | |
| FriendlyName | form | string | Yes | |
| Outlets | form | List<OutletData> | Yes | |
| UpliftRequestSyncInterval | form | int | No | |
| EnableReturnOfStock | form | bool | No | |
| EnableTimeKeeping | form | bool | No | |
| EnableCustomerComplaintForm | form | bool | No | |
| ClientLogoUrl | form | string | Yes | |
| ClientColor | form | string | Yes | |
| ClientName | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | Yes | |
| LastRequestedDate | form | string | Yes | |
| HasGeneralUpliftRequest | form | bool | No | |
| UpliftRequestCount | form | int | No | |
| AssignedPrincipalIds | form | List<int> | Yes | |
| AssignedRegions | form | List<OutletRegionData> | Yes | |
| Channel | form | string | Yes | |
| NextScheduledDate | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PrincipalId | form | int | No | |
| Region | form | string | Yes |
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 /csv/reply/AutoLogin HTTP/1.1
Host: returnit-api-dev.happen.zone
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"SystemUserId":0,"RefreshToken":"String","UtcOffset":0,"ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Data":{"SystemUserId":0,"ClientId":0,"VatValue":0,"RefreshToken":"String","FriendlyName":"String","Outlets":[{}],"UpliftRequestSyncInterval":0,"EnableReturnOfStock":false,"EnableTimeKeeping":false,"EnableCustomerComplaintForm":false,"ClientLogoUrl":"String","ClientColor":"String","ClientName":"String"},"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"}}}