| POST | /location/background |
|---|
"use strict";
export class ApiServiceResponse {
/** @param {{description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
description;
/** @type {string} */
heading;
/** @type {boolean} */
wasSuccessful;
/** @type {Object} */
modelState;
}
export class CoordsData {
/** @param {{speed?:number,longitude?:number,latitude?:number,accuracy?:number,altitude?:number,heading?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
speed;
/** @type {number} */
longitude;
/** @type {number} */
latitude;
/** @type {number} */
accuracy;
/** @type {number} */
altitude;
/** @type {number} */
heading;
}
export class ExtrasData {
/** @param {{systemUserId?:number,deviceId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
systemUserId;
/** @type {string} */
deviceId;
}
export class ActivityData {
/** @param {{type?:string,confidence?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
type;
/** @type {number} */
confidence;
}
export class BatteryData {
/** @param {{level?:number,is_charging?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
level;
/** @type {boolean} */
is_charging;
}
export class LocationData {
/** @param {{coords?:CoordsData,extras?:ExtrasData,is_moving?:boolean,odometer?:number,uuid?:string,activity?:ActivityData,battery?:BatteryData,timestamp?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CoordsData} */
coords;
/** @type {ExtrasData} */
extras;
/** @type {boolean} */
is_moving;
/** @type {number} */
odometer;
/** @type {string} */
uuid;
/** @type {ActivityData} */
activity;
/** @type {BatteryData} */
battery;
/** @type {string} */
timestamp;
}
export class BackgroundLocationReceived {
/** @param {{apiKey?:string,location?:LocationData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
apiKey;
/** @type {LocationData} */
location;
}
JavaScript BackgroundLocationReceived DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>