Cochrane+ App API

<back to all web services

OnTheMoveHeatMapRequest

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

public class dtos
{

    public static class OnTheMoveHeatMapRequest extends ApiServiceRequest
    {
        public Integer id = null;
        public Date startDate = null;
        public Date endDate = null;
        
        public Integer getId() { return id; }
        public OnTheMoveHeatMapRequest setId(Integer value) { this.id = value; return this; }
        public Date getStartDate() { return startDate; }
        public OnTheMoveHeatMapRequest setStartDate(Date value) { this.startDate = value; return this; }
        public Date getEndDate() { return endDate; }
        public OnTheMoveHeatMapRequest setEndDate(Date value) { this.endDate = value; return this; }
    }

    public static class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        /**
        * The API Key required for authentication
        */
        @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        public String apiKey = null;

        /**
        * Latitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Latitude of the user making this request")
        public Double latitude = null;

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double longitude = null;
        
        public String getApiKey() { return apiKey; }
        public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
        public Double getLatitude() { return latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
    }

    public static class OnTheMoveHeatMapResponse extends ApiServiceResponse
    {
        public ArrayList<Coordinate> points = null;
        
        public ArrayList<Coordinate> getPoints() { return points; }
        public OnTheMoveHeatMapResponse setPoints(ArrayList<Coordinate> value) { this.points = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        public String description = null;
        public String heading = null;
        public Boolean wasSuccessful = null;
        public Object modelState = null;
        
        public String getDescription() { return description; }
        public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
        public String getHeading() { return heading; }
        public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public Object getModelState() { return modelState; }
        public ApiServiceResponse setModelState(Object value) { this.modelState = value; return this; }
    }

    public static class Coordinate
    {
        public Double latitude = null;
        public Double longitude = null;
        
        public Double getLatitude() { return latitude; }
        public Coordinate setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public Coordinate setLongitude(Double value) { this.longitude = value; return this; }
    }

}

Java OnTheMoveHeatMapRequest 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/detail HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"points":[{"latitude":0,"longitude":0}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}