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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OnTheMoveListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <ListItems>
    <OnTheMoveListItem>
      <ClockedInTime>String</ClockedInTime>
      <Coordinate>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </Coordinate>
      <Id>0</Id>
      <LastKnownLocation>String</LastKnownLocation>
      <LastSeen>String</LastSeen>
      <Name>String</Name>
    </OnTheMoveListItem>
  </ListItems>
</OnTheMoveListResponse>