Cochrane+ App API

<back to all web services

GetActiveJourney

Requires Authentication
The following routes are available for this service:
GET/journey/active
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetActiveJourney extends ApiServiceRequest
    {
        
    }

    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 GetActiveJourneyResponse extends ApiServiceResponse
    {
        public Boolean journeyAvailable = null;
        public String journeyTitle = null;
        public Integer journeyId = null;
        
        public Boolean isJourneyAvailable() { return journeyAvailable; }
        public GetActiveJourneyResponse setJourneyAvailable(Boolean value) { this.journeyAvailable = value; return this; }
        public String getJourneyTitle() { return journeyTitle; }
        public GetActiveJourneyResponse setJourneyTitle(String value) { this.journeyTitle = value; return this; }
        public Integer getJourneyId() { return journeyId; }
        public GetActiveJourneyResponse setJourneyId(Integer value) { this.journeyId = 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; }
    }

}

Java GetActiveJourney DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /journey/active HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"journeyAvailable":false,"journeyTitle":"String","journeyId":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}