Antel Merchandiser App API

<back to all web services

UpliftRequestCompleted

The following routes are available for this service:
POST/antel/upliftrequestcompleted
UpliftRequestCompleted Parameters:
NameParameterData TypeRequiredDescription
ReturnItUpliftRequestIdbodyintNo
CompletedDatebodyDateTimeNo
SubmissionDocumentUrlbodystringYes
UpliftNumberbodystringYes
TotalUnitsbodydoubleNo
TotalWeightbodydoubleNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusYes

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 /antel/upliftrequestcompleted HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ReturnItUpliftRequestId":0,"CompletedDate":"0001-01-01T00:00:00.0000000","SubmissionDocumentUrl":"String","UpliftNumber":"String","TotalUnits":0,"TotalWeight":0,"ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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