Cochrane+ App API

<back to all web services

GetJourney

Requires Authentication
The following routes are available for this service:
GET/journey
namespace WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        member val Description:String = null with get,set
        member val Heading:String = null with get,set
        member val WasSuccessful:Boolean = new Boolean() with get,set
        member val ModelState:Object = null with get,set

    [<AllowNullLiteral>]
    type JourneyPointData() = 
        member val Latitude:Double = new Double() with get,set
        member val Longitude:Double = new Double() with get,set
        member val Address:String = null with get,set

    [<AllowNullLiteral>]
    type MeetingData() = 
        member val MeetingId:Int32 = new Int32() with get,set
        member val StartTime:String = null with get,set
        member val ArrivalTime:String = null with get,set
        member val LeftTime:String = null with get,set
        member val Duration:String = null with get,set
        member val ShowTimeFields:Boolean = new Boolean() with get,set
        member val ArrivalStatus:String = null with get,set
        member val Email:String = null with get,set
        member val HasEmail:Boolean = new Boolean() with get,set
        member val ContactName:String = null with get,set
        member val Latitude:Double = new Double() with get,set
        member val Longitude:Double = new Double() with get,set
        member val Location:String = null with get,set
        member val Address:String = null with get,set
        member val Subject:String = null with get,set
        member val Description:String = null with get,set
        member val EndTime:String = null with get,set
        member val Company:String = null with get,set
        member val ContactNumber:String = null with get,set
        member val HasContactNumber:Boolean = new Boolean() with get,set
        member val HasLocation:Boolean = new Boolean() with get,set
        member val SetBy:String = null with get,set
        member val VirtualOrInPerson:String = null with get,set

    [<AllowNullLiteral>]
    type JourneyNoteData() = 
        member val Note:String = null with get,set
        member val Date:String = null with get,set

    [<AllowNullLiteral>]
    type JourneyData() = 
        member val JourneyId:Int32 = new Int32() with get,set
        member val Title:String = null with get,set
        member val StartTime:String = null with get,set
        member val EndTime:String = null with get,set
        member val Distance:Double = new Double() with get,set
        member val DistanceFormatted:String = null with get,set
        member val RoutePolyline:String = null with get,set
        member val StartPoint:JourneyPointData = null with get,set
        member val EndPoint:JourneyPointData = null with get,set
        member val MeetingData:MeetingData = null with get,set
        member val JourneyNotes:ResizeArray<JourneyNoteData> = new ResizeArray<JourneyNoteData>() with get,set

    [<AllowNullLiteral>]
    type GetJourneyResponse() = 
        inherit ApiServiceResponse()
        member val Journeys:ResizeArray<JourneyData> = new ResizeArray<JourneyData>() with get,set
        member val Total:Int32 = new Int32() with get,set
        member val LastPage:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
        member val Latitude:Double = new Double() with get,set

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type GetJourney() = 
        inherit ApiServiceRequest()
        member val Count:Int32 = new Int32() with get,set
        member val Offset:Int32 = new Int32() with get,set

F# GetJourney 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.

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

{"journeys":[{}],"total":0,"lastPage":false,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}