Cochrane+ App API

<back to all web services

GetJourneyMeetings

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

JavaScript GetJourneyMeetings DTOs

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

HTTP + XML

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

POST /xml/reply/GetJourneyMeetings HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetJourneyMeetings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
</GetJourneyMeetings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetJourneyMeetingsResponse 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>
  <Meetings>
    <JourneyMeetingData>
      <CrmMeetingId>String</CrmMeetingId>
      <MeetingCompany>String</MeetingCompany>
      <MeetingContact>String</MeetingContact>
      <MeetingSubject>String</MeetingSubject>
      <StartTime>String</StartTime>
    </JourneyMeetingData>
  </Meetings>
</GetJourneyMeetingsResponse>