Antel API

<back to all web services

CloseOperatorArrival

Requires Authentication
The following routes are available for this service:
POST/stock/closeArrival/operator
import Foundation
import ServiceStack

public class CloseOperatorArrival : ApiServiceRequest
{
    public var operatorId:Int

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

    private enum CodingKeys : String, CodingKey {
        case operatorId
    }

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

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

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 CloseOperatorArrivalResponse : ApiServiceResponse
{
    public var operationSummary:StockOperationSummary

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

    private enum CodingKeys : String, CodingKey {
        case operationSummary
    }

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

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

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 StockOperationSummary : Codable
{
    public var scannedSeals:[StockOperationSealItem] = []
    public var missingSeals:[StockOperationSealItem] = []
    public var unknownUpliftSeals:[StockOperationSealItem] = []
    public var pausedSeals:[StockOperationSealItem] = []
    public var weightDifferenceSeals:[StockOperationSealItem] = []
    public var hasScannedSeals:Bool
    public var hasMissingSeals:Bool
    public var hasWeightDifferenceSeals:Bool
    public var hasUnknownUpliftSeals:Bool
    public var hasPausedSeals:Bool
    public var hasException:Bool
    public var totalSealsCount:Int
    public var totalSealsWeight:Double

    required public init(){}
}

public class StockOperationSealItem : Codable
{
    public var upliftNumber:String
    public var sealNumber:String
    public var principalName:String
    public var currentWeight:Double
    public var weightDifference:Double
    public var operatorName:String
    public var outletName:String
    public var upliftDate:String
    public var pausedAwaitingAuth:Bool
    public var upliftPdfLink:String

    required public init(){}
}


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

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

{"operationSummary":{"scannedSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"missingSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"unknownUpliftSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"pausedSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"weightDifferenceSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"hasScannedSeals":true,"hasMissingSeals":true,"hasWeightDifferenceSeals":true,"hasUnknownUpliftSeals":true,"hasPausedSeals":true,"hasException":true,"totalSealsCount":4,"totalSealsWeight":0},"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"}}}