Cochrane+ App API

BackgroundLocationReceived

The following routes are available for this service:
POST	/location/background

**BackgroundLocationReceived** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	body	string	No
location	body	LocationData	No

**LocationData** Parameters:
Name	Parameter	Data Type	Required
coords	form	CoordsData	No
extras	form	ExtrasData	No
is_moving	form	bool	No
odometer	form	double	No
uuid	form	string	No
activity	form	ActivityData	No
battery	form	BatteryData	No
timestamp	form	DateTime	No

**CoordsData** Parameters:
Name	Parameter	Data Type	Required
speed	form	double	No
longitude	form	double	No
latitude	form	double	No
accuracy	form	double	No
altitude	form	double	No
heading	form	double	No

**ExtrasData** Parameters:
Name	Parameter	Data Type	Required	Description
systemUserId	form	int	No
deviceId	form	Guid	No

**ActivityData** Parameters:
Name	Parameter	Data Type	Required	Description
type	form	string	No
confidence	form	int	No

**BatteryData** Parameters:
Name	Parameter	Data Type	Required	Description
level	form	double	No
is_charging	form	bool	No

**ApiServiceResponse** Parameters:
Name	Parameter	Data Type	Required
Description	form	string	No
Heading	form	string	No
WasSuccessful	form	bool	No
ModelState	form	Object	No

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.

POST /location/background HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BackgroundLocationReceived xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey>String</ApiKey>
  <location>
    <activity>
      <confidence>0</confidence>
      <type>String</type>
    </activity>
    <battery>
      <is_charging>false</is_charging>
      <level>0</level>
    </battery>
    <coords>
      <accuracy>0</accuracy>
      <altitude>0</altitude>
      <heading>0</heading>
      <latitude>0</latitude>
      <longitude>0</longitude>
      <speed>0</speed>
    </coords>
    <extras>
      <deviceId>00000000-0000-0000-0000-000000000000</deviceId>
      <systemUserId>0</systemUserId>
    </extras>
    <is_moving>false</is_moving>
    <odometer>0</odometer>
    <timestamp>0001-01-01T00:00:00</timestamp>
    <uuid>String</uuid>
  </location>
</BackgroundLocationReceived>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">
  <Description>String</Description>
  <Heading>String</Heading>
  <ModelState />
  <WasSuccessful>false</WasSuccessful>
</ApiServiceResponse>