| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<OnTheMoveListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
<ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
<ListItems>
<OnTheMoveListItem>
<ClockedInTime>String</ClockedInTime>
<Coordinate>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Coordinate>
<Id>0</Id>
<LastKnownLocation>String</LastKnownLocation>
<LastSeen>String</LastSeen>
<Name>String</Name>
</OnTheMoveListItem>
</ListItems>
</OnTheMoveListResponse>