Antel API

FinishOrderAssignment

The following routes are available for this service:
POST	/stock/order/assignment/finish

**FinishOrderAssignment** Parameters:
Name	Parameter	Data Type	Required	Description
OrderId	body	int	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

**FinishOrderAssignmentResponse** Parameters:
Name	Parameter	Data Type	Required
OrderId	form	int	No
EstimatedSeals	form	int	No
OperationSummary	form	StockOperationSummary	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

**StockOperationSummary** Parameters:
Name	Parameter	Data Type	Required
ScannedSeals	form	List<StockOperationSealItem>	No
MissingSeals	form	List<StockOperationSealItem>	No
UnknownUpliftSeals	form	List<StockOperationSealItem>	No
PausedSeals	form	List<StockOperationSealItem>	No
WeightDifferenceSeals	form	List<StockOperationSealItem>	No
HasScannedSeals	form	bool	No
HasMissingSeals	form	bool	No
HasWeightDifferenceSeals	form	bool	No
HasUnknownUpliftSeals	form	bool	No
HasPausedSeals	form	bool	No
HasException	form	bool	No
TotalSealsCount	form	int	No
TotalSealsWeight	form	double	No

**StockOperationSealItem** Parameters:
Name	Parameter	Data Type	Required
UpliftNumber	form	string	No
SealNumber	form	string	No
PrincipalName	form	string	No
CurrentWeight	form	double	No
WeightDifference	form	double	No
OperatorName	form	string	No
OutletName	form	string	No
UpliftDate	form	string	No
PausedAwaitingAuth	form	bool	No
UpliftPdfLink	form	string	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 /stock/order/assignment/finish HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	orderId: 0,
	apiKey: String,
	latitude: 0,
	longitude: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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
		}
	}
}