Cochrane+ App API

<back to all web services

OnTheMoveListRequest

Requires Authentication
The following routes are available for this service:
GET/template-approval/list
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 Coordinate
            Public Overridable Property Latitude As Double
            Public Overridable Property Longitude As Double
        End Class

        Public Partial Class OnTheMoveListItem
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
            Public Overridable Property ClockedInTime As String
            Public Overridable Property LastSeen As String
            Public Overridable Property LastKnownLocation As String
            Public Overridable Property Coordinate As Coordinate
        End Class

        Public Partial Class OnTheMoveListRequest
            Inherits ApiServiceRequest
        End Class

        Public Partial Class OnTheMoveListResponse
            Inherits ApiServiceResponse
            Public Sub New()
                ListItems = New List(Of OnTheMoveListItem)
            End Sub

            Public Overridable Property ListItems As List(Of OnTheMoveListItem)
        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 OnTheMoveListRequest 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.

GET /template-approval/list HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"listItems":[{"id":0,"name":"String","clockedInTime":"String","lastSeen":"String","lastKnownLocation":"String","coordinate":{"latitude":0,"longitude":0}}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}