Antel API

CloseOrderArrival

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

namespace WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        ///<summary>
        ///Information about the response.
        ///</summary>
        [<ApiMember(Description="Information about the response.", IsRequired=true)>]
        member val Description:String = null with get,set

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
        member val Heading:String = null with get,set

        ///<summary>
        ///Did the intended operation for this response complete successfully?
        ///</summary>
        [<ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)>]
        member val WasSuccessful:Boolean = new Boolean() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type StockOperationSealItem() = 
        member val UpliftNumber:String = null with get,set
        member val SealNumber:String = null with get,set
        member val PrincipalName:String = null with get,set
        member val CurrentWeight:Double = new Double() with get,set
        member val WeightDifference:Double = new Double() with get,set
        member val OperatorName:String = null with get,set
        member val OutletName:String = null with get,set
        member val UpliftDate:String = null with get,set
        member val PausedAwaitingAuth:Boolean = new Boolean() with get,set
        member val UpliftPdfLink:String = null with get,set

    [<AllowNullLiteral>]
    type StockOperationSummary() = 
        member val ScannedSeals:ResizeArray<StockOperationSealItem> = new ResizeArray<StockOperationSealItem>() with get,set
        member val MissingSeals:ResizeArray<StockOperationSealItem> = new ResizeArray<StockOperationSealItem>() with get,set
        member val UnknownUpliftSeals:ResizeArray<StockOperationSealItem> = new ResizeArray<StockOperationSealItem>() with get,set
        member val PausedSeals:ResizeArray<StockOperationSealItem> = new ResizeArray<StockOperationSealItem>() with get,set
        member val WeightDifferenceSeals:ResizeArray<StockOperationSealItem> = new ResizeArray<StockOperationSealItem>() with get,set
        member val HasScannedSeals:Boolean = new Boolean() with get,set
        member val HasMissingSeals:Boolean = new Boolean() with get,set
        member val HasWeightDifferenceSeals:Boolean = new Boolean() with get,set
        member val HasUnknownUpliftSeals:Boolean = new Boolean() with get,set
        member val HasPausedSeals:Boolean = new Boolean() with get,set
        member val HasException:Boolean = new Boolean() with get,set
        member val TotalSealsCount:Int32 = new Int32() with get,set
        member val TotalSealsWeight:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type CloseOrderArrivalResponse() = 
        inherit ApiServiceResponse()
        member val OrderNumber:String = null with get,set
        member val RequestingOperatorName:String = null with get,set
        member val OperatorName:String = null with get,set
        member val DestinationDepot:String = null with get,set
        member val DriverName:String = null with get,set
        member val CompanyName:String = null with get,set
        member val LicensePlate:String = null with get,set
        member val OrderId:Int32 = new Int32() with get,set
        member val EstimatedSeals:Int32 = new Int32() with get,set
        member val OperationSummary:StockOperationSummary = null with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
        member val Latitude:Double = new Double() with get,set

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type CloseOrderArrival() = 
        inherit ApiServiceRequest()
        member val OrderNumber:String = null with get,set

F# CloseOrderArrival 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/closeArrival/order HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CloseOrderArrival 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>
  <OrderNumber>String</OrderNumber>
</CloseOrderArrival>

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

<CloseOrderArrivalResponse 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>
  <CompanyName>String</CompanyName>
  <DestinationDepot>String</DestinationDepot>
  <DriverName>String</DriverName>
  <EstimatedSeals>0</EstimatedSeals>
  <LicensePlate>String</LicensePlate>
  <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>
  <OperatorName>String</OperatorName>
  <OrderId>0</OrderId>
  <OrderNumber>String</OrderNumber>
  <RequestingOperatorName>String</RequestingOperatorName>
</CloseOrderArrivalResponse>