Cochrane+ App API

<back to all web services

OnTheMoveListRequest

Requires Authentication
The following routes are available for this service:
GET/template-approval/list
import java.math.*
import java.util.*
import net.servicestack.client.*


open class OnTheMoveListRequest : ApiServiceRequest()
{
}

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 OnTheMoveListResponse : ApiServiceResponse()
{
    var listItems:ArrayList<OnTheMoveListItem> = ArrayList<OnTheMoveListItem>()
}

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

open class OnTheMoveListItem
{
    var id:Int? = null
    var name:String? = null
    var clockedInTime:String? = null
    var lastSeen:String? = null
    var lastKnownLocation:String? = null
    var coordinate:Coordinate? = null
}

open class Coordinate
{
    var latitude:Double? = null
    var longitude:Double? = null
}

Kotlin OnTheMoveListRequest DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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: {}
}