Antel API

EndSeal

The following routes are available for this service:
POST	/stock/seal/end

import Foundation
import ServiceStack

public class EndSeal : ApiServiceRequest
{
    public var sealNumber:String
    public var bucketId:Int

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

    private enum CodingKeys : String, CodingKey {
        case sealNumber
        case bucketId
    }

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

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

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 EndSealResponse : ApiServiceResponse
{
    public var sealData:AntelSealData
    public var inBucket:Bool

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

    private enum CodingKeys : String, CodingKey {
        case sealData
        case inBucket
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        sealData = try container.decodeIfPresent(AntelSealData.self, forKey: .sealData)
        inBucket = try container.decodeIfPresent(Bool.self, forKey: .inBucket)
    }

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

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 AntelSealData : Codable
{
    public var sealNumber:String
    public var principalName:String
    public var sealId:Int
    public var operatorName:String
    public var outletName:String
    public var upliftDate:String
    public var sealExists:Bool
    public var isPaused:Bool
    public var pausedAwaitingAuth:Bool

    required public init(){}
}

Swift EndSeal 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 /stock/seal/end HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"sealData":{"sealNumber":"String","principalName":"String","sealId":0,"operatorName":"String","outletName":"String","upliftDate":"String","sealExists":false,"isPaused":false,"pausedAwaitingAuth":false},"inBucket":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"}}}