| GET | /upliftrequest/auth |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UpliftRequestAuthRequestIds | query | List<Guid> | Yes |
| 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 |
|---|---|---|---|---|
| UpliftRequestAuthStatuses | form | List<AuthStatusData> | 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 |
|---|---|---|---|---|
| Status | form | AuthStatusDataAuthStatus | No | |
| UpliftRequestAuthRequestId | 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 /upliftrequest/auth HTTP/1.1 Host: returnit-api-dev.happen.zone Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
UpliftRequestAuthStatuses:
[
{
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
}
}
}