Antel API

FinishOrderAssignment

The following routes are available for this service:
POST	/stock/order/assignment/finish

import Foundation
import ServiceStack

public class FinishOrderAssignment : ApiServiceRequest
{
    public var orderId:Int

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

    private enum CodingKeys : String, CodingKey {
        case orderId
    }

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

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

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 FinishOrderAssignmentResponse : ApiServiceResponse
{
    public var orderId:Int
    public var estimatedSeals:Int
    public var operationSummary:StockOperationSummary

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

    private enum CodingKeys : String, CodingKey {
        case orderId
        case estimatedSeals
        case operationSummary
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        orderId = try container.decodeIfPresent(Int.self, forKey: .orderId)
        estimatedSeals = try container.decodeIfPresent(Int.self, forKey: .estimatedSeals)
        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 orderId != nil { try container.encode(orderId, forKey: .orderId) }
        if estimatedSeals != nil { try container.encode(estimatedSeals, forKey: .estimatedSeals) }
        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 FinishOrderAssignment DTOs

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

HTTP + XML

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

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

<FinishOrderAssignment 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>
  <OrderId>0</OrderId>
</FinishOrderAssignment>

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

<FinishOrderAssignmentResponse 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>
  <EstimatedSeals>0</EstimatedSeals>
  <OperationSummary>
    <MissingSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </MissingSeals>
    <PausedSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </PausedSeals>
    <ScannedSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </ScannedSeals>
    <UnknownUpliftSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </UnknownUpliftSeals>
    <WeightDifferenceSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </WeightDifferenceSeals>
  </OperationSummary>
  <OrderId>0</OrderId>
</FinishOrderAssignmentResponse>