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


open class StartJourney : ApiServiceRequest()
{
    var title:String? = null
    var crmMeetingId:UUID? = null
    var meetingCompany:String? = null
    var meetingContact:String? = null
    var meetingSubject: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 StartJourneyResponse : ApiServiceResponse()
{
    var journeyId:Int? = null
}

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

Kotlin StartJourney 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/start HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length

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