Cochrane+ App API

<back to all web services

GetTeamLocation

Requires Authentication
The following routes are available for this service:
GET/team/locations
"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 TeamLocationData {
    /** @param {{lastOnline?:string,longitude?:number,latitude?:number,profileImageUrl?:string,fullname?:string,username?:string,batteryLevel?:number,isManager?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    lastOnline;
    /** @type {number} */
    longitude;
    /** @type {number} */
    latitude;
    /** @type {string} */
    profileImageUrl;
    /** @type {string} */
    fullname;
    /** @type {string} */
    username;
    /** @type {number} */
    batteryLevel;
    /** @type {boolean} */
    isManager;
}
export class GetTeamLocationResponse extends ApiServiceResponse {
    /** @param {{teams?:TeamLocationData[],description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {TeamLocationData[]} */
    teams;
}
export class GetTeamLocation extends ApiServiceRequest {
    /** @param {{teamId?:number,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    teamId;
}

JavaScript GetTeamLocation DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /team/locations HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	teams: 
	[
		{
			
		}
	],
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}