Cochrane+ App API

<back to all web services

StartJourney

Requires Authentication
The following routes are available for this service:
POST/journey/start
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class StartJourney extends ApiServiceRequest
    {
        public String title = null;
        public UUID crmMeetingId = null;
        public String meetingCompany = null;
        public String meetingContact = null;
        public String meetingSubject = null;
        
        public String getTitle() { return title; }
        public StartJourney setTitle(String value) { this.title = value; return this; }
        public UUID getCrmMeetingId() { return crmMeetingId; }
        public StartJourney setCrmMeetingId(UUID value) { this.crmMeetingId = value; return this; }
        public String getMeetingCompany() { return meetingCompany; }
        public StartJourney setMeetingCompany(String value) { this.meetingCompany = value; return this; }
        public String getMeetingContact() { return meetingContact; }
        public StartJourney setMeetingContact(String value) { this.meetingContact = value; return this; }
        public String getMeetingSubject() { return meetingSubject; }
        public StartJourney setMeetingSubject(String value) { this.meetingSubject = value; return this; }
    }

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

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

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double longitude = null;
        
        public String getApiKey() { return apiKey; }
        public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
        public Double getLatitude() { return latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
    }

    public static class StartJourneyResponse extends ApiServiceResponse
    {
        public Integer journeyId = null;
        
        public Integer getJourneyId() { return journeyId; }
        public StartJourneyResponse setJourneyId(Integer value) { this.journeyId = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        public String description = null;
        public String heading = null;
        public Boolean wasSuccessful = null;
        public Object modelState = null;
        
        public String getDescription() { return description; }
        public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
        public String getHeading() { return heading; }
        public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public Object getModelState() { return modelState; }
        public ApiServiceResponse setModelState(Object value) { this.modelState = value; return this; }
    }

}

Java StartJourney DTOs

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: {}
}