Antel API

<back to all web services

DepotDropOff

import Foundation
import ServiceStack

public class DepotDropOff : ApiServiceRequest
{
    public var sealNumber:String

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

    private enum CodingKeys : String, CodingKey {
        case sealNumber
    }

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

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

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 DepotDropOffResponse : ApiServiceResponse
{
    public var sealData:AntelSealData
    public var weightRequired:Bool
    public var atDepot:Bool
    public var skipConfirm:Bool

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

    private enum CodingKeys : String, CodingKey {
        case sealData
        case weightRequired
        case atDepot
        case skipConfirm
    }

    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)
        weightRequired = try container.decodeIfPresent(Bool.self, forKey: .weightRequired)
        atDepot = try container.decodeIfPresent(Bool.self, forKey: .atDepot)
        skipConfirm = try container.decodeIfPresent(Bool.self, forKey: .skipConfirm)
    }

    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 weightRequired != nil { try container.encode(weightRequired, forKey: .weightRequired) }
        if atDepot != nil { try container.encode(atDepot, forKey: .atDepot) }
        if skipConfirm != nil { try container.encode(skipConfirm, forKey: .skipConfirm) }
    }
}

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 DepotDropOff DTOs

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

<DepotDropOff xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
  <SealNumber>String</SealNumber>
</DepotDropOff>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DepotDropOffResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">false</WasSuccessful>
  <AtDepot>false</AtDepot>
  <SealData>
    <IsPaused>false</IsPaused>
    <OperatorName>String</OperatorName>
    <OutletName>String</OutletName>
    <PausedAwaitingAuth>false</PausedAwaitingAuth>
    <PrincipalName>String</PrincipalName>
    <SealId>0</SealId>
    <SealNumber>String</SealNumber>
    <UpliftDate>String</UpliftDate>
  </SealData>
  <SkipConfirm>false</SkipConfirm>
  <WeightRequired>false</WeightRequired>
</DepotDropOffResponse>