Cochrane+ App API

<back to all web services

OnTheMoveListRequest

Requires Authentication
The following routes are available for this service:
GET/template-approval/list
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 Coordinate() = 
        member val Latitude:Double = new Double() with get,set
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type OnTheMoveListItem() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val ClockedInTime:String = null with get,set
        member val LastSeen:String = null with get,set
        member val LastKnownLocation:String = null with get,set
        member val Coordinate:Coordinate = null with get,set

    [<AllowNullLiteral>]
    type OnTheMoveListResponse() = 
        inherit ApiServiceResponse()
        member val ListItems:ResizeArray<OnTheMoveListItem> = new ResizeArray<OnTheMoveListItem>() 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 OnTheMoveListRequest() = 
        inherit ApiServiceRequest()

F# OnTheMoveListRequest 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 /template-approval/list HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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":{}}