Cochrane+ App API

BackgroundLocationReceived

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


export class ApiServiceResponse implements IServiceResponse
{
    public description: string;
    public heading: string;
    public wasSuccessful: boolean;
    public modelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class CoordsData
{
    public speed: number;
    public longitude: number;
    public latitude: number;
    public accuracy: number;
    public altitude: number;
    public heading: number;

    public constructor(init?: Partial<CoordsData>) { (Object as any).assign(this, init); }
}

export class ExtrasData
{
    public systemUserId: number;
    public deviceId: string;

    public constructor(init?: Partial<ExtrasData>) { (Object as any).assign(this, init); }
}

export class ActivityData
{
    public type: string;
    public confidence: number;

    public constructor(init?: Partial<ActivityData>) { (Object as any).assign(this, init); }
}

export class BatteryData
{
    public level: number;
    public is_charging: boolean;

    public constructor(init?: Partial<BatteryData>) { (Object as any).assign(this, init); }
}

export class LocationData
{
    public coords: CoordsData;
    public extras: ExtrasData;
    public is_moving: boolean;
    public odometer: number;
    public uuid: string;
    public activity: ActivityData;
    public battery: BatteryData;
    public timestamp: string;

    public constructor(init?: Partial<LocationData>) { (Object as any).assign(this, init); }
}

export class BackgroundLocationReceived implements IHasApiKey
{
    public apiKey: string;
    public location: LocationData;

    public constructor(init?: Partial<BackgroundLocationReceived>) { (Object as any).assign(this, init); }
}

TypeScript BackgroundLocationReceived DTOs

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>