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.*


open class AddJourneyNote : ApiServiceRequest()
{
    var journeyId:Int? = null
    var note:String? = null
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var apiKey:String? = null

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

    /**
    * Longitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Longitude of the user making this request")
    var longitude:Double? = null
}

open class AddJourneyNoteResponse : ApiServiceResponse()
{
    var journey:JourneyData? = null
}

open class ApiServiceResponse : IServiceResponse
{
    var description:String? = null
    var heading:String? = null
    var wasSuccessful:Boolean? = null
    var modelState:Object? = null
}

open class JourneyData
{
    var journeyId:Int? = null
    var title:String? = null
    var startTime:String? = null
    var endTime:String? = null
    var distance:Double? = null
    var distanceFormatted:String? = null
    var routePolyline:String? = null
    var startPoint:JourneyPointData? = null
    var endPoint:JourneyPointData? = null
    var meetingData:MeetingData? = null
    var journeyNotes:ArrayList<JourneyNoteData> = ArrayList<JourneyNoteData>()
}

open class JourneyPointData
{
    var latitude:Double? = null
    var longitude:Double? = null
    var address:String? = null
}

open class MeetingData
{
    var meetingId:Int? = null
    var startTime:String? = null
    var arrivalTime:String? = null
    var leftTime:String? = null
    var duration:String? = null
    var showTimeFields:Boolean? = null
    var arrivalStatus:String? = null
    var email:String? = null
    var hasEmail:Boolean? = null
    var contactName:String? = null
    var latitude:Double? = null
    var longitude:Double? = null
    var location:String? = null
    var address:String? = null
    var subject:String? = null
    var description:String? = null
    var endTime:String? = null
    var company:String? = null
    var contactNumber:String? = null
    var hasContactNumber:Boolean? = null
    var hasLocation:Boolean? = null
    var setBy:String? = null
    var virtualOrInPerson:String? = null
}

open class JourneyNoteData
{
    var note:String? = null
    var date:String? = null
}

Kotlin AddJourneyNote DTOs

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.

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

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

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