Cochrane+ App API

EndJourney

The following routes are available for this service:
POST	/journey/end

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ServiceModel
Imports WebService.ServiceModel.Base
Imports CommonService.Api.Models.Base

Namespace Global

    Namespace CommonService.Api.Models.Base

        Public Partial Class ApiServiceResponse
            Implements IServiceResponse
            Public Overridable Property Description As String
            Public Overridable Property Heading As String
            Public Overridable Property WasSuccessful As Boolean
            Public Overridable Property ModelState As Object
        End Class
    End Namespace

    Namespace WebService.ServiceModel

        Public Partial Class EndJourney
            Inherits ApiServiceRequest
            Public Overridable Property JourneyId As Integer
        End Class

        Public Partial Class EndJourneyResponse
            Inherits ApiServiceResponse
            Public Overridable Property Journey As JourneyData
        End Class

        Public Partial Class JourneyData
            Public Sub New()
                JourneyNotes = New List(Of JourneyNoteData)
            End Sub

            Public Overridable Property JourneyId As Integer
            Public Overridable Property Title As String
            Public Overridable Property StartTime As String
            Public Overridable Property EndTime As String
            Public Overridable Property Distance As Double
            Public Overridable Property DistanceFormatted As String
            Public Overridable Property RoutePolyline As String
            Public Overridable Property StartPoint As JourneyPointData
            Public Overridable Property EndPoint As JourneyPointData
            Public Overridable Property MeetingData As MeetingData
            Public Overridable Property JourneyNotes As List(Of JourneyNoteData)
        End Class

        Public Partial Class JourneyNoteData
            Public Overridable Property Note As String
            Public Overridable Property [Date] As String
        End Class

        Public Partial Class JourneyPointData
            Public Overridable Property Latitude As Double
            Public Overridable Property Longitude As Double
            Public Overridable Property Address As String
        End Class

        Public Partial Class MeetingData
            Public Overridable Property MeetingId As Integer
            Public Overridable Property StartTime As String
            Public Overridable Property ArrivalTime As String
            Public Overridable Property LeftTime As String
            Public Overridable Property Duration As String
            Public Overridable Property ShowTimeFields As Boolean
            Public Overridable Property ArrivalStatus As String
            Public Overridable Property Email As String
            Public Overridable Property HasEmail As Boolean
            Public Overridable Property ContactName As String
            Public Overridable Property Latitude As Double
            Public Overridable Property Longitude As Double
            Public Overridable Property Location As String
            Public Overridable Property Address As String
            Public Overridable Property Subject As String
            Public Overridable Property Description As String
            Public Overridable Property EndTime As String
            Public Overridable Property Company As String
            Public Overridable Property ContactNumber As String
            Public Overridable Property HasContactNumber As Boolean
            Public Overridable Property HasLocation As Boolean
            Public Overridable Property SetBy As String
            Public Overridable Property VirtualOrInPerson As String
        End Class
    End Namespace

    Namespace WebService.ServiceModel.Base

        Public Partial Class ApiServiceRequest
            Implements IServiceRequest
            Implements IHasApiKey
            Implements IHasDeviceInfo
            '''<Summary>
            '''The API Key required for authentication
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''Latitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Latitude of the user making this request")>
            Public Overridable Property Latitude As Double

            '''<Summary>
            '''Longitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Longitude of the user making this request")>
            Public Overridable Property Longitude As Double
        End Class
    End Namespace
End Namespace

VB.NET EndJourney DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /journey/end HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"journeyId":0,"apiKey":"String","latitude":0,"longitude":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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