| GET | /uplift/auth |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UpliftAuthRequestIds | query | List<Guid> | 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 |
|---|---|---|---|---|
| UpliftAuthStatuses | form | List<AuthStatusData> | 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 |
|---|---|---|---|---|
| Status | form | AuthStatusDataAuthStatus | No | |
| UpliftAuthRequestId | form | Guid | No | |
| Found | form | bool | No |
| Name | Value | |
|---|---|---|
| Pending | 0 | |
| Cancelled | 1 | |
| Authorised | 2 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /uplift/auth HTTP/1.1 Host: antel.api.dev.86degrees.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
upliftAuthStatuses:
[
{
status: 0,
found: False
}
],
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
}
}
}