Cochrane+ App API

<back to all web services

OnTheMoveDetailRequest

Requires Authentication
The following routes are available for this service:
GET/template-approval/detail
"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 OnTheMoveMeetingListItem {
    /** @param {{id?:number,company?:string,subject?:string,startDate?:string,arrivedDate?:string,leftDate?:string,duration?:string,latitude?:number,longitude?:number,contactName?:string,virtualOrInPerson?:string,meetingSetBy?:string,zoomUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    company;
    /** @type {string} */
    subject;
    /** @type {string} */
    startDate;
    /** @type {string} */
    arrivedDate;
    /** @type {string} */
    leftDate;
    /** @type {string} */
    duration;
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
    /** @type {string} */
    contactName;
    /** @type {string} */
    virtualOrInPerson;
    /** @type {string} */
    meetingSetBy;
    /** @type {string} */
    zoomUrl;
}
export class JourneyPoints {
    /** @param {{latitude?:number,longitude?:number,time?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
    /** @type {string} */
    time;
}
export class OnTheMoveDetailResponse extends ApiServiceResponse {
    /** @param {{systemUserName?:string,meetings?:OnTheMoveMeetingListItem[],points?:JourneyPoints[],description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    systemUserName;
    /** @type {OnTheMoveMeetingListItem[]} */
    meetings;
    /** @type {JourneyPoints[]} */
    points;
}
export class OnTheMoveDetailRequest extends ApiServiceRequest {
    /** @param {{id?:number,date?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    date;
}

JavaScript OnTheMoveDetailRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /template-approval/detail HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"systemUserName":"String","meetings":[{}],"points":[{}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}