Cochrane+ App API

<back to all web services

TemplateApprovalReview

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

public class dtos
{

    public static class TemplateApprovalReview extends ApiServiceRequest
    {
        public Integer templateApprovalId = null;
        public TemplateApprovalStatus approvalStatus = null;
        
        public Integer getTemplateApprovalId() { return templateApprovalId; }
        public TemplateApprovalReview setTemplateApprovalId(Integer value) { this.templateApprovalId = value; return this; }
        public TemplateApprovalStatus getApprovalStatus() { return approvalStatus; }
        public TemplateApprovalReview setApprovalStatus(TemplateApprovalStatus value) { this.approvalStatus = 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 enum TemplateApprovalStatus
    {
        @SerializedName("0") AwaitingApproval(0),
        @SerializedName("1") Rejected(1),
        @SerializedName("2") Approved(2);

        private final int value;
        TemplateApprovalStatus(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    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 TemplateApprovalReview 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.

POST /template-approval/list HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	templateApprovalId: 0,
	approvalStatus: 0,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}