Antel API

<back to all web services

CloseOrderArrival

Requires Authentication
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 .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/closeArrival/order HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

{"orderNumber":"String","requestingOperatorName":"String","operatorName":"String","destinationDepot":"String","driverName":"String","companyName":"String","licensePlate":"String","orderId":0,"estimatedSeals":0,"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"}}}