Antel API

<back to all web services

AddSealToOrder

Requires Authentication
The following routes are available for this service:
POST/stock/order/addSeal
AddSealToOrder Parameters:
NameParameterData TypeRequiredDescription
OrderIdbodyintNo
SealNumberbodystringNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
AddSealToOrderResponse Parameters:
NameParameterData TypeRequiredDescription
SealDataformAntelSealDataNo
InOrderformboolNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo
AntelSealData Parameters:
NameParameterData TypeRequiredDescription
SealNumberformstringNo
PrincipalNameformstringNo
SealIdformlongNo
OperatorNameformstringNo
OutletNameformstringNo
UpliftDateformstringNo
SealExistsformboolNo
IsPausedformboolNo
PausedAwaitingAuthformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /stock/order/addSeal HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"orderId":0,"sealNumber":"String","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"sealData":{"sealNumber":"String","principalName":"String","sealId":0,"operatorName":"String","outletName":"String","upliftDate":"String","sealExists":false,"isPaused":false,"pausedAwaitingAuth":false},"inOrder":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"}}}