Cochrane+ App API

<back to all web services

OnTheMoveListRequest

Requires Authentication
The following routes are available for this service:
GET/template-approval/list
"use strict";
export class ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    apiKey;
    /**
     * @type {number}
     * @description Latitude of the user making this request */
    latitude;
    /**
     * @type {number}
     * @description Longitude of the user making this request */
    longitude;
}
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 Coordinate {
    /** @param {{latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
}
export class OnTheMoveListItem {
    /** @param {{id?:number,name?:string,clockedInTime?:string,lastSeen?:string,lastKnownLocation?:string,coordinate?:Coordinate}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    name;
    /** @type {string} */
    clockedInTime;
    /** @type {string} */
    lastSeen;
    /** @type {string} */
    lastKnownLocation;
    /** @type {Coordinate} */
    coordinate;
}
export class OnTheMoveListResponse extends ApiServiceResponse {
    /** @param {{listItems?:OnTheMoveListItem[],description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {OnTheMoveListItem[]} */
    listItems;
}
export class OnTheMoveListRequest extends ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript OnTheMoveListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

{"listItems":[{"id":0,"name":"String","clockedInTime":"String","lastSeen":"String","lastKnownLocation":"String","coordinate":{"latitude":0,"longitude":0}}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}