Antel API

<back to all web services

IncompleteUpliftList

Requires Authentication
The following routes are available for this service:
GET/sync/incompleteuplifts
import Foundation
import ServiceStack

public class IncompleteUpliftList : ApiServiceRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

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 IncompleteUpliftListResponse : ApiServiceResponse
{
    public var incompleteUplifts:[IncompleteUpliftData] = []
    public var allowLogin:Bool

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

    private enum CodingKeys : String, CodingKey {
        case incompleteUplifts
        case allowLogin
    }

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

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

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 IncompleteUpliftData : Codable
{
    public var systemUserId:Int
    public var incompleteUpliftId:String
    public var upliftSchedulePrincipleId:Int
    public var lastSynced:Date
    public var isSubmitted:Bool
    public var deleteFromDevice:Bool
    public var checkedOutDeviceId:String
    public var checkedOutOperatorName:String
    public var createdByOperatorName:String

    required public init(){}
}


Swift IncompleteUpliftList 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 /sync/incompleteuplifts HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"incompleteUplifts":[{}],"allowLogin":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"}}}