Cochrane+ App API

StartJourney

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


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 StartJourneyResponse extends ApiServiceResponse
{
    public journeyId: number;

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

export class StartJourney extends ApiServiceRequest
{
    public title: string;
    public crmMeetingId: string;
    public meetingCompany: string;
    public meetingContact: string;
    public meetingSubject: string;

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

TypeScript StartJourney 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 /journey/start HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StartJourney 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>
  <CrmMeetingId>00000000-0000-0000-0000-000000000000</CrmMeetingId>
  <MeetingCompany>String</MeetingCompany>
  <MeetingContact>String</MeetingContact>
  <MeetingSubject>String</MeetingSubject>
  <Title>String</Title>
</StartJourney>

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

<StartJourneyResponse 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>
  <JourneyId>0</JourneyId>
</StartJourneyResponse>