Cochrane+ App API

<back to all web services

OnTheMoveListRequest

Requires Authentication
The following routes are available for this service:
GET/template-approval/list
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
OnTheMoveListResponse Parameters:
NameParameterData TypeRequiredDescription
ListItemsformList<OnTheMoveListItem>No
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
OnTheMoveListItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
ClockedInTimeformstringNo
LastSeenformstringNo
LastKnownLocationformstringNo
CoordinateformCoordinateNo
Coordinate Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdoubleNo
LongitudeformdoubleNo

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.

GET /template-approval/list HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"listItems":[{"id":0,"name":"String","clockedInTime":"String","lastSeen":"String","lastKnownLocation":"String","coordinate":{"latitude":0,"longitude":0}}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}