| GET | /uplift/auth |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class UpliftAuthStatus : ApiServiceRequest()
{
var upliftAuthRequestIds:ArrayList<UUID> = ArrayList<UUID>()
}
open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
var apiKey:String? = null
/**
* Latitude of the user making this request
*/
@ApiMember(DataType="double", Description="Latitude of the user making this request")
var latitude:Double? = null
/**
* Longitude of the user making this request
*/
@ApiMember(DataType="double", Description="Longitude of the user making this request")
var longitude:Double? = null
}
open class UpliftAuthStatusResponse : ApiServiceResponse()
{
var upliftAuthStatuses:ArrayList<AuthStatusData> = ArrayList<AuthStatusData>()
}
open class ApiServiceResponse : IServiceResponse
{
/**
* Information about the response.
*/
@ApiMember(Description="Information about the response.", IsRequired=true)
var description:String? = null
/**
* Heading or summary of the response.
*/
@ApiMember(Description="Heading or summary of the response.", IsRequired=true)
var heading:String? = null
/**
* Did the intended operation for this response complete successfully?
*/
@ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
var wasSuccessful:Boolean? = null
var responseStatus:ResponseStatus? = null
}
open class AuthStatusData
{
var status:AuthStatusDataAuthStatus? = null
var upliftAuthRequestId:UUID? = null
var found:Boolean? = null
}
enum class AuthStatusDataAuthStatus(val value:Int)
{
@SerializedName("0") Pending(0),
@SerializedName("1") Cancelled(1),
@SerializedName("2") 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
}
}
}