| POST | /uplift/auth/cancel |
|---|
import Foundation
import ServiceStack
public class CancelUpliftAuth : ApiServiceRequest
{
public var upliftAuthRequestId:String
public var reason:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftAuthRequestId
case reason
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
upliftAuthRequestId = try container.decodeIfPresent(String.self, forKey: .upliftAuthRequestId)
reason = try container.decodeIfPresent(String.self, forKey: .reason)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if upliftAuthRequestId != nil { try container.encode(upliftAuthRequestId, forKey: .upliftAuthRequestId) }
if reason != nil { try container.encode(reason, forKey: .reason) }
}
}
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 CancelUpliftAuthResponse : ApiServiceResponse
{
public var status:AuthStatusDataAuthStatus
public var statusChanged:Bool
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case status
case statusChanged
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
status = try container.decodeIfPresent(AuthStatusDataAuthStatus.self, forKey: .status)
statusChanged = try container.decodeIfPresent(Bool.self, forKey: .statusChanged)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if status != nil { try container.encode(status, forKey: .status) }
if statusChanged != nil { try container.encode(statusChanged, forKey: .statusChanged) }
}
}
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 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 .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /uplift/auth/cancel HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"reason":"String","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"status":0,"statusChanged":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"}}}