Antel API

<back to all web services

FinishSubmitCompletedUplifts

Requires Authentication
The following routes are available for this service:
POST/sync/finishsubmit
FinishSubmitCompletedUplifts Parameters:
NameParameterData TypeRequiredDescription
SuccessbodyintNo
FailedbodyList<UpliftSubmissionResult>No
RemainingbodyintNo
ExtrabodystringNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
UpliftSubmissionResult Parameters:
NameParameterData TypeRequiredDescription
WasSuccessfulformboolNo
DescriptionformstringNo
StepformstringNo
UpliftIdformlongNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo

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

{"success":0,"failed":[{"wasSuccessful":false,"description":"String","step":"String","upliftId":0}],"remaining":0,"extra":"String","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}