Cochrane+ App API

<back to all web services

GetJourney

Requires Authentication
The following routes are available for this service:
GET/journey
GetJourney Parameters:
NameParameterData TypeRequiredDescription
CountqueryintNo
OffsetqueryintNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
GetJourneyResponse Parameters:
NameParameterData TypeRequiredDescription
JourneysformList<JourneyData>No
TotalformintNo
LastPageformboolNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
JourneyData Parameters:
NameParameterData TypeRequiredDescription
JourneyIdformintNo
TitleformstringNo
StartTimeformstringNo
EndTimeformstringNo
DistanceformdoubleNo
DistanceFormattedformstringNo
RoutePolylineformstringNo
StartPointformJourneyPointDataNo
EndPointformJourneyPointDataNo
MeetingDataformMeetingDataNo
JourneyNotesformList<JourneyNoteData>No
JourneyPointData Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdoubleNo
LongitudeformdoubleNo
AddressformstringNo
MeetingData Parameters:
NameParameterData TypeRequiredDescription
MeetingIdformintNo
StartTimeformstringNo
ArrivalTimeformstringNo
LeftTimeformstringNo
DurationformstringNo
ShowTimeFieldsformboolNo
ArrivalStatusformstringNo
EmailformstringNo
HasEmailformboolNo
ContactNameformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
LocationformstringNo
AddressformstringNo
SubjectformstringNo
DescriptionformstringNo
EndTimeformstringNo
CompanyformstringNo
ContactNumberformstringNo
HasContactNumberformboolNo
HasLocationformboolNo
SetByformstringNo
VirtualOrInPersonformstringNo
JourneyNoteData Parameters:
NameParameterData TypeRequiredDescription
NoteformstringNo
DateformstringNo

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

HTTP + CSV

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

GET /journey HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"journeys":[{}],"total":0,"lastPage":false,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}