Antel API

<back to all web services

FinaliseUplift

Requires Authentication
The following routes are available for this service:
POST/uplift/finalise
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 UpliftProductData() = 
        member val UpliftProductId:Int32 = new Int32() with get,set
        member val UpliftId:Int32 = new Int32() with get,set
        member val ProductId:Int32 = new Int32() with get,set
        member val UnitPrice:Decimal = new Decimal() with get,set
        member val Name:String = null with get,set
        member val Category:String = null with get,set
        member val UnitBarcode:String = null with get,set
        member val UnitSize:String = null with get,set
        member val UnitWeight:Decimal = new Decimal() with get,set
        member val Code:String = null with get,set
        member val UpliftImages:ResizeArray<Object> = new ResizeArray<Object>() with get,set
        member val Quantity:Double = new Double() with get,set
        member val Value:Decimal = new Decimal() with get,set
        member val PriceOverMax:Boolean = new Boolean() with get,set
        member val QuantityOverMax:Boolean = new Boolean() with get,set
        member val QuantityOverRequirement:Boolean = new Boolean() with get,set
        member val SerialNumber:String = null with get,set
        member val BatchCode:String = null with get,set
        member val StockStatusId:Int32 = new Int32() with get,set
        member val LotNumber:String = null with get,set
        member val ExpiryDate:String = null with get,set
        member val ManufactureDate:String = null with get,set

    [<AllowNullLiteral>]
    type UpliftSealData() = 
        member val Unbagged:Boolean = new Boolean() with get,set
        member val SealNumber:String = null with get,set
        member val AntelSealNumber:String = null with get,set
        member val Products:ResizeArray<UpliftProductData> = new ResizeArray<UpliftProductData>() with get,set
        member val TotalPrice:Double = new Double() with get,set
        member val TotalQuantity:Double = new Double() with get,set
        member val NetWeight:Double = new Double() with get,set
        member val GrossWeight:Double = new Double() with get,set
        member val BillableSeal:Boolean = new Boolean() with get,set
        member val InvalidAntelSealNumber:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type UpliftClaimData() = 
        member val UpliftClaimId:Int32 = new Int32() with get,set
        member val ClaimUnits:Int32 = new Int32() with get,set
        member val ClaimNumber:String = null with get,set
        member val ClaimValue:Decimal = new Decimal() with get,set
        member val ClaimDocumentImages:ResizeArray<Object> = new ResizeArray<Object>() with get,set
        member val ReturnOrderNumber:String = null with get,set
        member val LineCount:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type SaveUpliftResponse() = 
        inherit ApiServiceResponse()
        member val UpliftId:Int32 = new Int32() with get,set
        member val UpliftAuthRequestId:Guid = new Guid() with get,set
        member val Seals:ResizeArray<UpliftSealData> = new ResizeArray<UpliftSealData>() with get,set
        member val UnbaggedItems:UpliftSealData = null with get,set
        member val Claims:ResizeArray<UpliftClaimData> = new ResizeArray<UpliftClaimData>() with get,set
        member val DeleteFromDevice:Boolean = new Boolean() with get,set
        member val ImageIds:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val InvalidAntelSeal:Boolean = new Boolean() 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 FinaliseUplift() = 
        inherit ApiServiceRequest()
        member val UpliftId:Int32 = new Int32() with get,set
        member val IncompleteUpliftId:Guid = new Guid() with get,set

F# FinaliseUplift 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 /uplift/finalise HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

{"upliftId":0,"seals":[{"unbagged":false,"sealNumber":"String","antelSealNumber":"String","products":[{"upliftProductId":0,"upliftId":0,"productId":0,"unitPrice":0,"name":"String","category":"String","unitBarcode":"String","unitSize":"String","unitWeight":0,"code":"String","upliftImages":[{}],"quantity":0,"value":0,"priceOverMax":false,"quantityOverMax":false,"quantityOverRequirement":false,"serialNumber":"String","batchCode":"String","stockStatusId":0,"lotNumber":"String","expiryDate":"String","manufactureDate":"String"}],"totalPrice":0,"totalQuantity":0,"netWeight":0,"grossWeight":0,"billableSeal":false,"invalidAntelSealNumber":false}],"unbaggedItems":{"unbagged":false,"sealNumber":"String","antelSealNumber":"String","products":[{"upliftProductId":0,"upliftId":0,"productId":0,"unitPrice":0,"name":"String","category":"String","unitBarcode":"String","unitSize":"String","unitWeight":0,"code":"String","upliftImages":[{}],"quantity":0,"value":0,"priceOverMax":false,"quantityOverMax":false,"quantityOverRequirement":false,"serialNumber":"String","batchCode":"String","stockStatusId":0,"lotNumber":"String","expiryDate":"String","manufactureDate":"String"}],"totalPrice":0,"totalQuantity":0,"netWeight":0,"grossWeight":0,"billableSeal":false,"invalidAntelSealNumber":false},"claims":[{"upliftClaimId":0,"claimUnits":0,"claimNumber":"String","claimValue":0,"claimDocumentImages":[{}],"returnOrderNumber":"String","lineCount":0}],"deleteFromDevice":false,"imageIds":["String"],"invalidAntelSeal":false,"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"}}}