Cochrane+ App API

<back to all web services

GetJourneyMeetings

Requires Authentication

export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    public description: string;
    public heading: string;
    public wasSuccessful: boolean;
    public modelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class JourneyMeetingData
{
    public crmMeetingId: string;
    public meetingSubject: string;
    public meetingContact: string;
    public meetingCompany: string;
    public startTime: string;

    public constructor(init?: Partial<JourneyMeetingData>) { (Object as any).assign(this, init); }
}

export class GetJourneyMeetingsResponse extends ApiServiceResponse
{
    public meetings: JourneyMeetingData[];

    public constructor(init?: Partial<GetJourneyMeetingsResponse>) { super(init); (Object as any).assign(this, init); }
}

export class GetJourneyMeetings extends ApiServiceRequest
{

    public constructor(init?: Partial<GetJourneyMeetings>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>