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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OnTheMoveListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <ListItems>
    <OnTheMoveListItem>
      <ClockedInTime>String</ClockedInTime>
      <Coordinate>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </Coordinate>
      <Id>0</Id>
      <LastKnownLocation>String</LastKnownLocation>
      <LastSeen>String</LastSeen>
      <Name>String</Name>
    </OnTheMoveListItem>
  </ListItems>
</OnTheMoveListResponse>