Cochrane+ App API

<back to all web services

StartJourney

Requires Authentication
The following routes are available for this service:
POST/journey/start
StartJourney Parameters:
NameParameterData TypeRequiredDescription
TitlebodystringNo
CrmMeetingIdbodyGuidNo
MeetingCompanybodystringNo
MeetingContactbodystringNo
MeetingSubjectbodystringNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
StartJourneyResponse Parameters:
NameParameterData TypeRequiredDescription
JourneyIdformintNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo

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>