Antel API

FinaliseUplift

The following routes are available for this service:
POST	/uplift/finalise

**FinaliseUplift** Parameters:
Name	Parameter	Data Type	Required	Description
UpliftId	body	int	No
IncompleteUpliftId	body	Guid	No

**ApiServiceRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	form	string	Yes	The API Key required for authentication
Latitude	form	double	No	Latitude of the user making this request
Longitude	form	double	No	Longitude of the user making this request

**SaveUpliftResponse** Parameters:
Name	Parameter	Data Type	Required
UpliftId	form	int	No
UpliftAuthRequestId	form	Guid	No
Seals	form	List<UpliftSealData>	No
UnbaggedItems	form	UpliftSealData	No
Claims	form	List<UpliftClaimData>	No
DeleteFromDevice	form	bool	No
ImageIds	form	List<string>	No
InvalidAntelSeal	form	bool	No

**ApiServiceResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	Yes	Information about the response.
Heading	form	string	Yes	Heading or summary of the response.
WasSuccessful	form	boolean	Yes	Did the intended operation for this response complete successfully?
ResponseStatus	form	ResponseStatus	No

**UpliftSealData** Parameters:
Name	Parameter	Data Type	Required
Unbagged	form	bool	No
SealNumber	form	string	No
AntelSealNumber	form	string	No
Products	form	List<UpliftProductData>	No
TotalPrice	form	double	No
TotalQuantity	form	double	No
NetWeight	form	double	No
GrossWeight	form	double	No
BillableSeal	form	bool	No
InvalidAntelSealNumber	form	bool	No

**UpliftProductData** Parameters:
Name	Parameter	Data Type	Required
UpliftProductId	form	int	No
UpliftId	form	int	No
ProductId	form	int	No
UnitPrice	form	decimal	No
Name	form	string	No
Category	form	string	No
UnitBarcode	form	string	No
UnitSize	form	string	No
UnitWeight	form	decimal	No
Code	form	string	No
UpliftImages	form	List<Object>	No
Quantity	form	double	No
Value	form	decimal	No
PriceOverMax	form	bool	No
QuantityOverMax	form	bool	No
QuantityOverRequirement	form	bool	No
SerialNumber	form	string	No
BatchCode	form	string	No
StockStatusId	form	int	No
LotNumber	form	string	No
ExpiryDate	form	string	No
ManufactureDate	form	string	No

**UpliftClaimData** Parameters:
Name	Parameter	Data Type	Required
UpliftClaimId	form	int	No
ClaimUnits	form	int	No
ClaimNumber	form	string	No
ClaimValue	form	decimal	No
ClaimDocumentImages	form	List<Object>	No
ReturnOrderNumber	form	string	No
LineCount	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}