Cochrane+ App API

<back to all web services

DebriefReviewListRequest

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

public class dtos
{

    public static class DebriefReviewListRequest extends ApiSkipTakePagedTableRequest
    {
        public Boolean all = null;
        public DateFilter dateCaptured = null;
        public DebriefReadStatusType readStatus = null;
        
        public Boolean isAll() { return all; }
        public DebriefReviewListRequest setAll(Boolean value) { this.all = value; return this; }
        public DateFilter getDateCaptured() { return dateCaptured; }
        public DebriefReviewListRequest setDateCaptured(DateFilter value) { this.dateCaptured = value; return this; }
        public DebriefReadStatusType getReadStatus() { return readStatus; }
        public DebriefReviewListRequest setReadStatus(DebriefReadStatusType value) { this.readStatus = value; return this; }
    }

    public static class ApiSkipTakePagedTableRequest extends ApiSkipTakePagedServiceRequest implements IOrderKey
    {
        public Integer requestNumber = null;
        public String searchQuery = null;
        public String orderKey = null;
        public Boolean orderAscending = null;
        
        public Integer getRequestNumber() { return requestNumber; }
        public ApiSkipTakePagedTableRequest setRequestNumber(Integer value) { this.requestNumber = value; return this; }
        public String getSearchQuery() { return searchQuery; }
        public ApiSkipTakePagedTableRequest setSearchQuery(String value) { this.searchQuery = value; return this; }
        public String getOrderKey() { return orderKey; }
        public ApiSkipTakePagedTableRequest setOrderKey(String value) { this.orderKey = value; return this; }
        public Boolean isOrderAscending() { return orderAscending; }
        public ApiSkipTakePagedTableRequest setOrderAscending(Boolean value) { this.orderAscending = value; return this; }
    }

    public static class ApiSkipTakePagedServiceRequest implements ISkipTakePagedServiceRequest
    {
        public Integer skip = null;
        public Integer take = null;
        
        public Integer getSkip() { return skip; }
        public ApiSkipTakePagedServiceRequest setSkip(Integer value) { this.skip = value; return this; }
        public Integer getTake() { return take; }
        public ApiSkipTakePagedServiceRequest setTake(Integer value) { this.take = value; return this; }
    }

    public static class DateFilter
    {
        public DateFilterType filterType = null;
        public ArrayList<Date> dates = null;
        
        public DateFilterType getFilterType() { return filterType; }
        public DateFilter setFilterType(DateFilterType value) { this.filterType = value; return this; }
        public ArrayList<Date> getDates() { return dates; }
        public DateFilter setDates(ArrayList<Date> value) { this.dates = value; return this; }
    }

    public static enum DateFilterType
    {
        @SerializedName("0") All(0),
        @SerializedName("1") Before(1),
        @SerializedName("2") After(2),
        @SerializedName("3") Range(3);

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

    public static enum DebriefReadStatusType
    {
        @SerializedName("0") All(0),
        @SerializedName("1") Unread(1),
        @SerializedName("2") Read(2);

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

    public static class DebriefReviewListResponse extends SkipTakePagedTableListResponse<DebriefReviewListItem>
    {
        public ArrayList<EnumOption> readStatuses = null;
        
        public ArrayList<EnumOption> getReadStatuses() { return readStatuses; }
        public DebriefReviewListResponse setReadStatuses(ArrayList<EnumOption> value) { this.readStatuses = value; return this; }
    }

    public static class SkipTakePagedTableListResponse<T> extends ApiSkipTakePagedTableResponse
    {
        public ArrayList<T> listItems = null;
        
        public ArrayList<T> getListItems() { return listItems; }
        public SkipTakePagedTableListResponse<T> setListItems(ArrayList<T> value) { this.listItems = value; return this; }
    }

    public static class ApiSkipTakePagedTableResponse extends SkipTakePagedServiceResponse
    {
        public Integer requestNumber = null;
        
        public Integer getRequestNumber() { return requestNumber; }
        public ApiSkipTakePagedTableResponse setRequestNumber(Integer value) { this.requestNumber = value; return this; }
    }

    public static class SkipTakePagedServiceResponse extends ApiServiceResponse implements ISkipTakePagedServiceResponse, ISkipTakePagedServiceRequest
    {
        public Integer total = null;
        public Integer skip = null;
        public Integer take = null;
        
        public Integer getTotal() { return total; }
        public SkipTakePagedServiceResponse setTotal(Integer value) { this.total = value; return this; }
        public Integer getSkip() { return skip; }
        public SkipTakePagedServiceResponse setSkip(Integer value) { this.skip = value; return this; }
        public Integer getTake() { return take; }
        public SkipTakePagedServiceResponse setTake(Integer value) { this.take = 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 DebriefReviewListItem
    {
        public Integer id = null;
        public String submittedBy = null;
        public String companyName = null;
        public String meetingSubject = null;
        public String dateSubmitted = null;
        public String overallScore = null;
        public Integer generalManagerId = null;
        public Boolean generalManagerReviewed = null;
        public Integer generalManagerRating = null;
        public Integer seniorManagerId = null;
        public Boolean seniorManagerReviewed = null;
        public Integer seniorManagerRating = null;
        public Integer divisionalManagerId = null;
        public Boolean divisionalManagerReviewed = null;
        public Integer divisionalManagerRating = null;
        public Integer departmentManagerId = null;
        public Boolean departmentManagerReviewed = null;
        public Integer departmentManagerRating = null;
        public Integer managerId = null;
        public Boolean managerReviewed = null;
        public Integer managerRating = null;
        public Integer campaignManagerId = null;
        public Boolean campaignManagerReviewed = null;
        public Integer campaignManagerRating = null;
        public Integer portfolioManagerId = null;
        public Boolean portfolioManagerReviewed = null;
        public Integer portfolioManagerRating = null;
        public BigDecimal age = null;
        public String ageColour = null;
        public Boolean markedAsRead = null;
        
        public Integer getId() { return id; }
        public DebriefReviewListItem setId(Integer value) { this.id = value; return this; }
        public String getSubmittedBy() { return submittedBy; }
        public DebriefReviewListItem setSubmittedBy(String value) { this.submittedBy = value; return this; }
        public String getCompanyName() { return companyName; }
        public DebriefReviewListItem setCompanyName(String value) { this.companyName = value; return this; }
        public String getMeetingSubject() { return meetingSubject; }
        public DebriefReviewListItem setMeetingSubject(String value) { this.meetingSubject = value; return this; }
        public String getDateSubmitted() { return dateSubmitted; }
        public DebriefReviewListItem setDateSubmitted(String value) { this.dateSubmitted = value; return this; }
        public String getOverallScore() { return overallScore; }
        public DebriefReviewListItem setOverallScore(String value) { this.overallScore = value; return this; }
        public Integer getGeneralManagerId() { return generalManagerId; }
        public DebriefReviewListItem setGeneralManagerId(Integer value) { this.generalManagerId = value; return this; }
        public Boolean isGeneralManagerReviewed() { return generalManagerReviewed; }
        public DebriefReviewListItem setGeneralManagerReviewed(Boolean value) { this.generalManagerReviewed = value; return this; }
        public Integer getGeneralManagerRating() { return generalManagerRating; }
        public DebriefReviewListItem setGeneralManagerRating(Integer value) { this.generalManagerRating = value; return this; }
        public Integer getSeniorManagerId() { return seniorManagerId; }
        public DebriefReviewListItem setSeniorManagerId(Integer value) { this.seniorManagerId = value; return this; }
        public Boolean isSeniorManagerReviewed() { return seniorManagerReviewed; }
        public DebriefReviewListItem setSeniorManagerReviewed(Boolean value) { this.seniorManagerReviewed = value; return this; }
        public Integer getSeniorManagerRating() { return seniorManagerRating; }
        public DebriefReviewListItem setSeniorManagerRating(Integer value) { this.seniorManagerRating = value; return this; }
        public Integer getDivisionalManagerId() { return divisionalManagerId; }
        public DebriefReviewListItem setDivisionalManagerId(Integer value) { this.divisionalManagerId = value; return this; }
        public Boolean isDivisionalManagerReviewed() { return divisionalManagerReviewed; }
        public DebriefReviewListItem setDivisionalManagerReviewed(Boolean value) { this.divisionalManagerReviewed = value; return this; }
        public Integer getDivisionalManagerRating() { return divisionalManagerRating; }
        public DebriefReviewListItem setDivisionalManagerRating(Integer value) { this.divisionalManagerRating = value; return this; }
        public Integer getDepartmentManagerId() { return departmentManagerId; }
        public DebriefReviewListItem setDepartmentManagerId(Integer value) { this.departmentManagerId = value; return this; }
        public Boolean isDepartmentManagerReviewed() { return departmentManagerReviewed; }
        public DebriefReviewListItem setDepartmentManagerReviewed(Boolean value) { this.departmentManagerReviewed = value; return this; }
        public Integer getDepartmentManagerRating() { return departmentManagerRating; }
        public DebriefReviewListItem setDepartmentManagerRating(Integer value) { this.departmentManagerRating = value; return this; }
        public Integer getManagerId() { return managerId; }
        public DebriefReviewListItem setManagerId(Integer value) { this.managerId = value; return this; }
        public Boolean isManagerReviewed() { return managerReviewed; }
        public DebriefReviewListItem setManagerReviewed(Boolean value) { this.managerReviewed = value; return this; }
        public Integer getManagerRating() { return managerRating; }
        public DebriefReviewListItem setManagerRating(Integer value) { this.managerRating = value; return this; }
        public Integer getCampaignManagerId() { return campaignManagerId; }
        public DebriefReviewListItem setCampaignManagerId(Integer value) { this.campaignManagerId = value; return this; }
        public Boolean isCampaignManagerReviewed() { return campaignManagerReviewed; }
        public DebriefReviewListItem setCampaignManagerReviewed(Boolean value) { this.campaignManagerReviewed = value; return this; }
        public Integer getCampaignManagerRating() { return campaignManagerRating; }
        public DebriefReviewListItem setCampaignManagerRating(Integer value) { this.campaignManagerRating = value; return this; }
        public Integer getPortfolioManagerId() { return portfolioManagerId; }
        public DebriefReviewListItem setPortfolioManagerId(Integer value) { this.portfolioManagerId = value; return this; }
        public Boolean isPortfolioManagerReviewed() { return portfolioManagerReviewed; }
        public DebriefReviewListItem setPortfolioManagerReviewed(Boolean value) { this.portfolioManagerReviewed = value; return this; }
        public Integer getPortfolioManagerRating() { return portfolioManagerRating; }
        public DebriefReviewListItem setPortfolioManagerRating(Integer value) { this.portfolioManagerRating = value; return this; }
        public BigDecimal getAge() { return age; }
        public DebriefReviewListItem setAge(BigDecimal value) { this.age = value; return this; }
        public String getAgeColour() { return ageColour; }
        public DebriefReviewListItem setAgeColour(String value) { this.ageColour = value; return this; }
        public Boolean isMarkedAsRead() { return markedAsRead; }
        public DebriefReviewListItem setMarkedAsRead(Boolean value) { this.markedAsRead = value; return this; }
    }

    public static class EnumOption
    {
        public Integer value = null;
        public String label = null;
        
        public Integer getValue() { return value; }
        public EnumOption setValue(Integer value) { this.value = value; return this; }
        public String getLabel() { return label; }
        public EnumOption setLabel(String value) { this.label = value; return this; }
    }

}

Java DebriefReviewListRequest 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.

POST /debriefreview/list HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"all":false,"dateCaptured":{"filterType":0,"dates":["0001-01-01T00:00:00.0000000"]},"readStatus":0,"requestNumber":0,"searchQuery":"String","orderKey":"String","orderAscending":false,"skip":0,"take":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"readStatuses":[{"value":0,"label":"All"},{"value":1,"label":"Unread"},{"value":2,"label":"Read"}],"requestNumber":0,"total":0,"skip":0,"take":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}