Cochrane+ App API

StartJourney

The following routes are available for this service:
POST	/journey/start

"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 StartJourneyResponse extends ApiServiceResponse {
    /** @param {{journeyId?:number,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    journeyId;
}
export class StartJourney extends ApiServiceRequest {
    /** @param {{title?:string,crmMeetingId?:string,meetingCompany?:string,meetingContact?:string,meetingSubject?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    title;
    /** @type {string} */
    crmMeetingId;
    /** @type {string} */
    meetingCompany;
    /** @type {string} */
    meetingContact;
    /** @type {string} */
    meetingSubject;
}

JavaScript StartJourney 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.

POST /journey/start HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"title":"String","crmMeetingId":"00000000-0000-0000-0000-000000000000","meetingCompany":"String","meetingContact":"String","meetingSubject":"String","apiKey":"String","latitude":0,"longitude":0}

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

{"journeyId":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}