Antel API

<back to all web services

SealDetailsRequest

Requires Authentication
The following routes are available for this service:
POST/stock/seal/details
SealDetailsRequest Parameters:
NameParameterData TypeRequiredDescription
SealIdbodyintNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
SealDetailsResponse Parameters:
NameParameterData TypeRequiredDescription
PrincipalNameformstringNo
UpliftNumberformstringNo
OperatorNameformstringNo
OutletNameformstringNo
UpliftDateformstringNo
SealNumberformstringNo
CurrentWeightformstringNo
TargetWeightformstringNo
HasWeightIssueformboolNo
BucketNameformstringNo
ClaimNumbersformList<string>No
JoinedClaimNumbersformstringNo
SealImagesformList<FileDataItem>No
OrderHistoryformList<SealOrderHistoryItem>No
MovementHistoryformList<SealMovementHistoryItem>No
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo
FileDataItem Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
FileUrlformstringNo
ThumbnailUrlformstringNo
FileIdformGuidNo
ThumbnailIdformGuidNo
LinkIdformintNo
CreatedDateformDateTimeNo
SealOrderHistoryItem Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformstringNo
OrderIdformintNo
OrderNumberformstringNo
OrderRequestingOperatorformstringNo
SealMovementHistoryItem Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EventDateTimeformstringNo
ActionUserNameformstringNo
ScannedDepotNameformstringNo
AssignedBucketNameformstringNo
AssignedOrderNumberformstringNo
AssignedOperatorNameformstringNo
OrderDriverNameformstringNo
OrderDriverCompanyNameformstringNo
OrderDriverLicensePlateformstringNo
TargetWeightformdoubleNo
CurrentWeightformdoubleNo
HadWeightIssueformboolNo
HadUnknownUpliftformboolNo
WasPausedformboolNo
PausedWasAwaitingAuthformboolNo

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/seal/details HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	principalName: String,
	upliftNumber: String,
	operatorName: String,
	outletName: String,
	upliftDate: String,
	sealNumber: String,
	currentWeight: String,
	targetWeight: String,
	hasWeightIssue: False,
	bucketName: String,
	claimNumbers: 
	[
		String
	],
	joinedClaimNumbers: String,
	sealImages: 
	[
		{
			fileName: String,
			fileUrl: String,
			thumbnailUrl: String,
			linkId: 0,
			createdDate: 0001-01-01
		}
	],
	orderHistory: 
	[
		{
			createdDate: String,
			orderId: 0,
			orderNumber: String,
			orderRequestingOperator: String
		}
	],
	movementHistory: 
	[
		{
			id: 0,
			eventDateTime: String,
			actionUserName: String,
			scannedDepotName: String,
			assignedBucketName: String,
			assignedOrderNumber: String,
			assignedOperatorName: String,
			orderDriverName: String,
			orderDriverCompanyName: String,
			orderDriverLicensePlate: String,
			targetWeight: 0,
			currentWeight: 0,
			hadWeightIssue: False,
			hadUnknownUplift: False,
			wasPaused: False,
			pausedWasAwaitingAuth: 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
		}
	}
}