Cochrane+ App API

<back to all web services

StartJourney

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

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>