| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SystemUserId | query | int | No | |
| Otp | query | string | No | |
| UtcOffset | query | int | No | |
| PushPlayerId | query | string | No | The user's push token - used for push messages. |
| 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 | No |
| 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 | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SystemUserId | form | int | No | |
| RefreshToken | form | string | No | |
| HasActivePanicCover | form | bool | No | |
| AccountInArrears | form | bool | No | |
| UpdateClientInformation | form | bool | No | |
| NextPanicDate | form | string | No | |
| PanicReference | form | string | No | |
| ClientData | form | ClientData | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FirstName | form | string | No | |
| Surname | form | string | No | |
| form | string | No | ||
| MobileNumber | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| DateOfBirth | form | string | No | |
| SourceOfIncome | form | string | 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 /csv/reply/ConfirmOtp HTTP/1.1
Host: legalguard-api-dev.happen.zone
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"systemUserId":0,"otp":"String","utcOffset":0,"pushPlayerId":"String","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"data":{"systemUserId":0,"refreshToken":"String","hasActivePanicCover":false,"accountInArrears":false,"updateClientInformation":false,"nextPanicDate":"String","panicReference":"String","clientData":{"firstName":"String","surname":"String","email":"String","mobileNumber":"String","address1":"String","address2":"String","city":"String","dateOfBirth":"String","sourceOfIncome":"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"}}}