Antel Merchandiser App API

<back to all web services

CancelUpliftRequestAuth

Requires Authentication
The following routes are available for this service:
POST/upliftrequest/auth/cancel
CancelUpliftRequestAuth Parameters:
NameParameterData TypeRequiredDescription
UpliftRequestAuthRequestIdbodyGuidNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
CancelUpliftRequestAuthResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformAuthStatusDataAuthStatusNo
StatusChangedformboolNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusYes
AuthStatusDataAuthStatus Enum:
NameValue
Pending0
Cancelled1
Authorised2

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

HTTP + CSV

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

POST /upliftrequest/auth/cancel HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Status":0,"StatusChanged":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"}}}