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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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: text/jsv
Content-Length: length

{
	journeyId: 0,
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}