Antel API

<back to all web services

UpliftAction

Requires Authentication
The following routes are available for this service:
POST/uplift/action
import Foundation
import ServiceStack

public class UpliftAction : ApiServiceRequest
{
    public var id:Int
    public var action:UpliftScheduleAction

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

    private enum CodingKeys : String, CodingKey {
        case id
        case action
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        action = try container.decodeIfPresent(UpliftScheduleAction.self, forKey: .action)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if action != nil { try container.encode(action, forKey: .action) }
    }
}

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 enum UpliftScheduleAction : Int, Codable
{
    case Confirm = 0
    case Cancel = 1
}


Swift UpliftAction DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /uplift/action HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0,"action":0,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"apiKey":"String","latitude":0,"longitude":0}