Antel Merchandiser App API

UpliftRequestAuthStatus

The following routes are available for this service:
GET	/upliftrequest/auth

import Foundation
import ServiceStack

public class UpliftRequestAuthStatus : ApiServiceRequest
{
    public var upliftRequestAuthRequestIds:[String] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case upliftRequestAuthRequestIds
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        upliftRequestAuthRequestIds = try container.decodeIfPresent([String].self, forKey: .upliftRequestAuthRequestIds) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if upliftRequestAuthRequestIds.count > 0 { try container.encode(upliftRequestAuthRequestIds, forKey: .upliftRequestAuthRequestIds) }
    }
}

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 UpliftRequestAuthStatusResponse : ApiServiceResponse
{
    public var upliftRequestAuthStatuses:[AuthStatusData] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case upliftRequestAuthStatuses
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        upliftRequestAuthStatuses = try container.decodeIfPresent([AuthStatusData].self, forKey: .upliftRequestAuthStatuses) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if upliftRequestAuthStatuses.count > 0 { try container.encode(upliftRequestAuthStatuses, forKey: .upliftRequestAuthStatuses) }
    }
}

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 upliftRequestAuthRequestId:String?
    public var found:Bool?

    required public init(){}
}

// @Flags()
public enum AuthStatusDataAuthStatus : Int, Codable
{
    case Pending = 0
    case Cancelled = 1
    case Authorised = 2
}

Swift UpliftRequestAuthStatus DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}