| POST | /uplift/conclude |
|---|
"use strict";
export class ApiServiceRequest {
/** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API Key required for authentication */
apiKey;
/**
* @type {number}
* @description Latitude of the user making this request */
latitude;
/**
* @type {number}
* @description Longitude of the user making this request */
longitude;
}
export class ApiServiceResponse {
/** @param {{description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Information about the response. */
description;
/**
* @type {string}
* @description Heading or summary of the response. */
heading;
/**
* @type {boolean}
* @description Did the intended operation for this response complete successfully? */
wasSuccessful;
/** @type {ResponseStatus} */
responseStatus;
}
export class UpliftProductData {
/** @param {{upliftProductId?:number,upliftId?:number,productId?:number,unitPrice?:number,name?:string,category?:string,unitBarcode?:string,unitSize?:string,unitWeight?:number,code?:string,upliftImages?:Object[],quantity?:number,value?:number,priceOverMax?:boolean,quantityOverMax?:boolean,quantityOverRequirement?:boolean,serialNumber?:string,batchCode?:string,stockStatusId?:number,lotNumber?:string,expiryDate?:string,manufactureDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
upliftProductId;
/** @type {number} */
upliftId;
/** @type {number} */
productId;
/** @type {number} */
unitPrice;
/** @type {string} */
name;
/** @type {string} */
category;
/** @type {string} */
unitBarcode;
/** @type {string} */
unitSize;
/** @type {number} */
unitWeight;
/** @type {string} */
code;
/** @type {Object[]} */
upliftImages;
/** @type {number} */
quantity;
/** @type {number} */
value;
/** @type {boolean} */
priceOverMax;
/** @type {boolean} */
quantityOverMax;
/** @type {boolean} */
quantityOverRequirement;
/** @type {string} */
serialNumber;
/** @type {string} */
batchCode;
/** @type {number} */
stockStatusId;
/** @type {string} */
lotNumber;
/** @type {string} */
expiryDate;
/** @type {string} */
manufactureDate;
}
export class UpliftSealData {
/** @param {{unbagged?:boolean,sealNumber?:string,antelSealNumber?:string,products?:UpliftProductData[],totalPrice?:number,totalQuantity?:number,netWeight?:number,grossWeight?:number,billableSeal?:boolean,invalidAntelSealNumber?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
unbagged;
/** @type {string} */
sealNumber;
/** @type {string} */
antelSealNumber;
/** @type {UpliftProductData[]} */
products;
/** @type {number} */
totalPrice;
/** @type {number} */
totalQuantity;
/** @type {number} */
netWeight;
/** @type {number} */
grossWeight;
/** @type {boolean} */
billableSeal;
/** @type {boolean} */
invalidAntelSealNumber;
}
export class UpliftClaimData {
/** @param {{upliftClaimId?:number,claimUnits?:number,claimNumber?:string,claimValue?:number,claimDocumentImages?:Object[],returnOrderNumber?:string,lineCount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
upliftClaimId;
/** @type {number} */
claimUnits;
/** @type {string} */
claimNumber;
/** @type {number} */
claimValue;
/** @type {Object[]} */
claimDocumentImages;
/** @type {string} */
returnOrderNumber;
/** @type {number} */
lineCount;
}
export class SaveUpliftResponse extends ApiServiceResponse {
/** @param {{upliftId?:number,upliftAuthRequestId?:string,seals?:UpliftSealData[],unbaggedItems?:UpliftSealData,claims?:UpliftClaimData[],deleteFromDevice?:boolean,imageIds?:string[],invalidAntelSeal?:boolean,description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
upliftId;
/** @type {string} */
upliftAuthRequestId;
/** @type {UpliftSealData[]} */
seals;
/** @type {UpliftSealData} */
unbaggedItems;
/** @type {UpliftClaimData[]} */
claims;
/** @type {boolean} */
deleteFromDevice;
/** @type {string[]} */
imageIds;
/** @type {boolean} */
invalidAntelSeal;
}
export class ConcludeUplift extends ApiServiceRequest {
/** @param {{upliftSchedulePrincipleId?:number,incompleteUpliftId?:string,comments?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
upliftSchedulePrincipleId;
/** @type {string} */
incompleteUpliftId;
/** @type {string} */
comments;
}
JavaScript ConcludeUplift DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /uplift/conclude HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ConcludeUplift 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>
<Comments>String</Comments>
<IncompleteUpliftId>00000000-0000-0000-0000-000000000000</IncompleteUpliftId>
<UpliftSchedulePrincipleId>0</UpliftSchedulePrincipleId>
</ConcludeUplift>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SaveUpliftResponse 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>
<Claims>
<UpliftClaimData>
<ClaimDocumentImages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
</ClaimDocumentImages>
<ClaimNumber>String</ClaimNumber>
<ClaimUnits>0</ClaimUnits>
<ClaimValue>0</ClaimValue>
<LineCount>0</LineCount>
<ReturnOrderNumber>String</ReturnOrderNumber>
<UpliftClaimId>0</UpliftClaimId>
</UpliftClaimData>
</Claims>
<DeleteFromDevice>false</DeleteFromDevice>
<ImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImageIds>
<Seals>
<UpliftSealData>
<AntelSealNumber>String</AntelSealNumber>
<BillableSeal>false</BillableSeal>
<GrossWeight>0</GrossWeight>
<InvalidAntelSealNumber>false</InvalidAntelSealNumber>
<NetWeight>0</NetWeight>
<Products>
<UpliftProductData>
<BatchCode>String</BatchCode>
<Category>String</Category>
<Code>String</Code>
<ExpiryDate>String</ExpiryDate>
<LotNumber>String</LotNumber>
<ManufactureDate>String</ManufactureDate>
<Name>String</Name>
<PriceOverMax>false</PriceOverMax>
<ProductId>0</ProductId>
<Quantity>0</Quantity>
<QuantityOverMax>false</QuantityOverMax>
<QuantityOverRequirement>false</QuantityOverRequirement>
<SerialNumber>String</SerialNumber>
<StockStatusId>0</StockStatusId>
<UnitBarcode>String</UnitBarcode>
<UnitPrice>0</UnitPrice>
<UnitSize>String</UnitSize>
<UnitWeight>0</UnitWeight>
<UpliftId>0</UpliftId>
<UpliftImages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:anyType />
</UpliftImages>
<UpliftProductId>0</UpliftProductId>
<Value>0</Value>
</UpliftProductData>
</Products>
<SealNumber>String</SealNumber>
<TotalPrice>0</TotalPrice>
<TotalQuantity>0</TotalQuantity>
<Unbagged>false</Unbagged>
</UpliftSealData>
</Seals>
<UnbaggedItems>
<AntelSealNumber>String</AntelSealNumber>
<BillableSeal>false</BillableSeal>
<GrossWeight>0</GrossWeight>
<InvalidAntelSealNumber>false</InvalidAntelSealNumber>
<NetWeight>0</NetWeight>
<Products>
<UpliftProductData>
<BatchCode>String</BatchCode>
<Category>String</Category>
<Code>String</Code>
<ExpiryDate>String</ExpiryDate>
<LotNumber>String</LotNumber>
<ManufactureDate>String</ManufactureDate>
<Name>String</Name>
<PriceOverMax>false</PriceOverMax>
<ProductId>0</ProductId>
<Quantity>0</Quantity>
<QuantityOverMax>false</QuantityOverMax>
<QuantityOverRequirement>false</QuantityOverRequirement>
<SerialNumber>String</SerialNumber>
<StockStatusId>0</StockStatusId>
<UnitBarcode>String</UnitBarcode>
<UnitPrice>0</UnitPrice>
<UnitSize>String</UnitSize>
<UnitWeight>0</UnitWeight>
<UpliftId>0</UpliftId>
<UpliftImages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:anyType />
</UpliftImages>
<UpliftProductId>0</UpliftProductId>
<Value>0</Value>
</UpliftProductData>
</Products>
<SealNumber>String</SealNumber>
<TotalPrice>0</TotalPrice>
<TotalQuantity>0</TotalQuantity>
<Unbagged>false</Unbagged>
</UnbaggedItems>
<UpliftAuthRequestId>00000000-0000-0000-0000-000000000000</UpliftAuthRequestId>
<UpliftId>0</UpliftId>
</SaveUpliftResponse>