Cochrane+ App API

<back to all web services

AddJourneyNote

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

public class dtos
{

    public static class AddJourneyNote extends ApiServiceRequest
    {
        public Integer journeyId = null;
        public String note = null;
        
        public Integer getJourneyId() { return journeyId; }
        public AddJourneyNote setJourneyId(Integer value) { this.journeyId = value; return this; }
        public String getNote() { return note; }
        public AddJourneyNote setNote(String value) { this.note = 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 AddJourneyNoteResponse extends ApiServiceResponse
    {
        public JourneyData journey = null;
        
        public JourneyData getJourney() { return journey; }
        public AddJourneyNoteResponse setJourney(JourneyData value) { this.journey = 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; }
    }

    public static class JourneyData
    {
        public Integer journeyId = null;
        public String title = null;
        public String startTime = null;
        public String endTime = null;
        public Double distance = null;
        public String distanceFormatted = null;
        public String routePolyline = null;
        public JourneyPointData startPoint = null;
        public JourneyPointData endPoint = null;
        public MeetingData meetingData = null;
        public ArrayList<JourneyNoteData> journeyNotes = null;
        
        public Integer getJourneyId() { return journeyId; }
        public JourneyData setJourneyId(Integer value) { this.journeyId = value; return this; }
        public String getTitle() { return title; }
        public JourneyData setTitle(String value) { this.title = value; return this; }
        public String getStartTime() { return startTime; }
        public JourneyData setStartTime(String value) { this.startTime = value; return this; }
        public String getEndTime() { return endTime; }
        public JourneyData setEndTime(String value) { this.endTime = value; return this; }
        public Double getDistance() { return distance; }
        public JourneyData setDistance(Double value) { this.distance = value; return this; }
        public String getDistanceFormatted() { return distanceFormatted; }
        public JourneyData setDistanceFormatted(String value) { this.distanceFormatted = value; return this; }
        public String getRoutePolyline() { return routePolyline; }
        public JourneyData setRoutePolyline(String value) { this.routePolyline = value; return this; }
        public JourneyPointData getStartPoint() { return startPoint; }
        public JourneyData setStartPoint(JourneyPointData value) { this.startPoint = value; return this; }
        public JourneyPointData getEndPoint() { return endPoint; }
        public JourneyData setEndPoint(JourneyPointData value) { this.endPoint = value; return this; }
        public MeetingData getMeetingData() { return meetingData; }
        public JourneyData setMeetingData(MeetingData value) { this.meetingData = value; return this; }
        public ArrayList<JourneyNoteData> getJourneyNotes() { return journeyNotes; }
        public JourneyData setJourneyNotes(ArrayList<JourneyNoteData> value) { this.journeyNotes = value; return this; }
    }

    public static class JourneyPointData
    {
        public Double latitude = null;
        public Double longitude = null;
        public String address = null;
        
        public Double getLatitude() { return latitude; }
        public JourneyPointData setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public JourneyPointData setLongitude(Double value) { this.longitude = value; return this; }
        public String getAddress() { return address; }
        public JourneyPointData setAddress(String value) { this.address = value; return this; }
    }

    public static class MeetingData
    {
        public Integer meetingId = null;
        public String startTime = null;
        public String arrivalTime = null;
        public String leftTime = null;
        public String duration = null;
        public Boolean showTimeFields = null;
        public String arrivalStatus = null;
        public String email = null;
        public Boolean hasEmail = null;
        public String contactName = null;
        public Double latitude = null;
        public Double longitude = null;
        public String location = null;
        public String address = null;
        public String subject = null;
        public String description = null;
        public String endTime = null;
        public String company = null;
        public String contactNumber = null;
        public Boolean hasContactNumber = null;
        public Boolean hasLocation = null;
        public String setBy = null;
        public String virtualOrInPerson = null;
        
        public Integer getMeetingId() { return meetingId; }
        public MeetingData setMeetingId(Integer value) { this.meetingId = value; return this; }
        public String getStartTime() { return startTime; }
        public MeetingData setStartTime(String value) { this.startTime = value; return this; }
        public String getArrivalTime() { return arrivalTime; }
        public MeetingData setArrivalTime(String value) { this.arrivalTime = value; return this; }
        public String getLeftTime() { return leftTime; }
        public MeetingData setLeftTime(String value) { this.leftTime = value; return this; }
        public String getDuration() { return duration; }
        public MeetingData setDuration(String value) { this.duration = value; return this; }
        public Boolean isShowTimeFields() { return showTimeFields; }
        public MeetingData setShowTimeFields(Boolean value) { this.showTimeFields = value; return this; }
        public String getArrivalStatus() { return arrivalStatus; }
        public MeetingData setArrivalStatus(String value) { this.arrivalStatus = value; return this; }
        public String getEmail() { return email; }
        public MeetingData setEmail(String value) { this.email = value; return this; }
        public Boolean isHasEmail() { return hasEmail; }
        public MeetingData setHasEmail(Boolean value) { this.hasEmail = value; return this; }
        public String getContactName() { return contactName; }
        public MeetingData setContactName(String value) { this.contactName = value; return this; }
        public Double getLatitude() { return latitude; }
        public MeetingData setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public MeetingData setLongitude(Double value) { this.longitude = value; return this; }
        public String getLocation() { return location; }
        public MeetingData setLocation(String value) { this.location = value; return this; }
        public String getAddress() { return address; }
        public MeetingData setAddress(String value) { this.address = value; return this; }
        public String getSubject() { return subject; }
        public MeetingData setSubject(String value) { this.subject = value; return this; }
        public String getDescription() { return description; }
        public MeetingData setDescription(String value) { this.description = value; return this; }
        public String getEndTime() { return endTime; }
        public MeetingData setEndTime(String value) { this.endTime = value; return this; }
        public String getCompany() { return company; }
        public MeetingData setCompany(String value) { this.company = value; return this; }
        public String getContactNumber() { return contactNumber; }
        public MeetingData setContactNumber(String value) { this.contactNumber = value; return this; }
        public Boolean isHasContactNumber() { return hasContactNumber; }
        public MeetingData setHasContactNumber(Boolean value) { this.hasContactNumber = value; return this; }
        public Boolean isHasLocation() { return hasLocation; }
        public MeetingData setHasLocation(Boolean value) { this.hasLocation = value; return this; }
        public String getSetBy() { return setBy; }
        public MeetingData setSetBy(String value) { this.setBy = value; return this; }
        public String getVirtualOrInPerson() { return virtualOrInPerson; }
        public MeetingData setVirtualOrInPerson(String value) { this.virtualOrInPerson = value; return this; }
    }

    public static class JourneyNoteData
    {
        public String note = null;
        public String date = null;
        
        public String getNote() { return note; }
        public JourneyNoteData setNote(String value) { this.note = value; return this; }
        public String getDate() { return date; }
        public JourneyNoteData setDate(String value) { this.date = value; return this; }
    }

}

Java AddJourneyNote DTOs

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

HTTP + OTHER

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

POST /journey/addnote HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"journeyId":0,"note":"String","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}