| GET | /uplift/auth |
|---|
import Foundation
import ServiceStack
public class UpliftAuthStatus : ApiServiceRequest
{
public var upliftAuthRequestIds:[String] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftAuthRequestIds
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
upliftAuthRequestIds = try container.decodeIfPresent([String].self, forKey: .upliftAuthRequestIds) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if upliftAuthRequestIds.count > 0 { try container.encode(upliftAuthRequestIds, forKey: .upliftAuthRequestIds) }
}
}
public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, Codable
{
/**
* The API Key required for authentication
*/
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public var apiKey:String
/**
* Latitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
public var latitude:Double
/**
* Longitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
public var longitude:Double
required public init(){}
}
public class UpliftAuthStatusResponse : ApiServiceResponse
{
public var upliftAuthStatuses:[AuthStatusData] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftAuthStatuses
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
upliftAuthStatuses = try container.decodeIfPresent([AuthStatusData].self, forKey: .upliftAuthStatuses) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if upliftAuthStatuses.count > 0 { try container.encode(upliftAuthStatuses, forKey: .upliftAuthStatuses) }
}
}
public class ApiServiceResponse : IServiceResponse, Codable
{
/**
* Information about the response.
*/
// @ApiMember(Description="Information about the response.", IsRequired=true)
public var Description:String
/**
* Heading or summary of the response.
*/
// @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
public var heading:String
/**
* Did the intended operation for this response complete successfully?
*/
// @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
public var wasSuccessful:Bool
public var responseStatus:ResponseStatus
required public init(){}
}
public class AuthStatusData : Codable
{
public var status:AuthStatusDataAuthStatus
public var upliftAuthRequestId:String
public var found:Bool
required public init(){}
}
public enum AuthStatusDataAuthStatus : Int, Codable
{
case Pending = 0
case Cancelled = 1
case 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
}
}
}