Antel API

<back to all web services

CompleteDepotDropOff

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

public class CompleteDepotDropOff : ApiServiceRequest
{
    public var sealId:Int
    public var weight:Double
    public var weightConfirmed:Bool

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

    private enum CodingKeys : String, CodingKey {
        case sealId
        case weight
        case weightConfirmed
    }

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

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

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 CompleteDepotDropOffResponse : ApiServiceResponse
{
    public var weightIssue:Bool
    public var weightDifference:Double

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

    private enum CodingKeys : String, CodingKey {
        case weightIssue
        case weightDifference
    }

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

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

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(){}
}


Swift CompleteDepotDropOff DTOs

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

HTTP + OTHER

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

POST /stock/depotDropoff/complete HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"sealId":0,"weight":0,"weightConfirmed":false,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"weightIssue":false,"weightDifference":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"}}}