| POST | /location/background |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | body | string | No | |
| location | body | LocationData | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| speed | form | double | No | |
| longitude | form | double | No | |
| latitude | form | double | No | |
| accuracy | form | double | No | |
| altitude | form | double | No | |
| heading | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| systemUserId | form | int | No | |
| deviceId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| type | form | string | No | |
| confidence | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| level | form | double | No | |
| is_charging | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"apiKey":"String","location":{"coords":{"speed":0,"longitude":0,"latitude":0,"accuracy":0,"altitude":0,"heading":0},"extras":{"systemUserId":0,"deviceId":"00000000-0000-0000-0000-000000000000"},"is_moving":false,"odometer":0,"uuid":"String","activity":{"type":"String","confidence":0},"battery":{"level":0,"is_charging":false},"timestamp":"0001-01-01T00:00:00.0000000"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}