| POST | /uplift/finalise |
|---|
export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
/** @description The API Key required for authentication */
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public apiKey: string;
/** @description Latitude of the user making this request */
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
public latitude: number;
/** @description Longitude of the user making this request */
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
public longitude: number;
public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}
export class ApiServiceResponse implements IServiceResponse
{
/** @description Information about the response. */
// @ApiMember(Description="Information about the response.", IsRequired=true)
public description: string;
/** @description Heading or summary of the response. */
// @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
public heading: string;
/** @description 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 wasSuccessful: boolean;
public responseStatus: ResponseStatus;
public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}
export class UpliftProductData
{
public upliftProductId: number;
public upliftId: number;
public productId: number;
public unitPrice: number;
public name: string;
public category: string;
public unitBarcode: string;
public unitSize: string;
public unitWeight: number;
public code: string;
public upliftImages: Object[];
public quantity: number;
public value: number;
public priceOverMax: boolean;
public quantityOverMax: boolean;
public quantityOverRequirement: boolean;
public serialNumber: string;
public batchCode: string;
public stockStatusId: number;
public lotNumber: string;
public expiryDate: string;
public manufactureDate: string;
public constructor(init?: Partial<UpliftProductData>) { (Object as any).assign(this, init); }
}
export class UpliftSealData
{
public unbagged: boolean;
public sealNumber: string;
public antelSealNumber: string;
public products: UpliftProductData[];
public totalPrice: number;
public totalQuantity: number;
public netWeight: number;
public grossWeight: number;
public billableSeal: boolean;
public invalidAntelSealNumber: boolean;
public constructor(init?: Partial<UpliftSealData>) { (Object as any).assign(this, init); }
}
export class UpliftClaimData
{
public upliftClaimId: number;
public claimUnits: number;
public claimNumber: string;
public claimValue: number;
public claimDocumentImages: Object[];
public returnOrderNumber: string;
public lineCount: number;
public constructor(init?: Partial<UpliftClaimData>) { (Object as any).assign(this, init); }
}
export class SaveUpliftResponse extends ApiServiceResponse
{
public upliftId: number;
public upliftAuthRequestId: string;
public seals: UpliftSealData[];
public unbaggedItems: UpliftSealData;
public claims: UpliftClaimData[];
public deleteFromDevice: boolean;
public imageIds: string[];
public invalidAntelSeal: boolean;
public constructor(init?: Partial<SaveUpliftResponse>) { super(init); (Object as any).assign(this, init); }
}
export class FinaliseUplift extends ApiServiceRequest
{
public upliftId: number;
public incompleteUpliftId: string;
public constructor(init?: Partial<FinaliseUplift>) { super(init); (Object as any).assign(this, init); }
}
TypeScript FinaliseUplift DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
upliftId: 0,
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}