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


open class DebriefReviewListRequest : ApiSkipTakePagedTableRequest()
{
    var all:Boolean? = null
    var dateCaptured:DateFilter? = null
    var readStatus:DebriefReadStatusType? = null
}

open class ApiSkipTakePagedTableRequest : ApiSkipTakePagedServiceRequest(), IOrderKey
{
    var requestNumber:Int? = null
    var searchQuery:String? = null
    var orderKey:String? = null
    var orderAscending:Boolean? = null
}

open class ApiSkipTakePagedServiceRequest : ISkipTakePagedServiceRequest
{
    var skip:Int? = null
    var take:Int? = null
}

open class DateFilter
{
    var filterType:DateFilterType? = null
    var dates:ArrayList<Date> = ArrayList<Date>()
}

enum class DateFilterType(val value:Int)
{
    @SerializedName("0") All(0),
    @SerializedName("1") Before(1),
    @SerializedName("2") After(2),
    @SerializedName("3") Range(3),
}

enum class DebriefReadStatusType(val value:Int)
{
    @SerializedName("0") All(0),
    @SerializedName("1") Unread(1),
    @SerializedName("2") Read(2),
}

open class DebriefReviewListResponse : SkipTakePagedTableListResponse<DebriefReviewListItem>()
{
    var readStatuses:ArrayList<EnumOption> = ArrayList<EnumOption>()
}

open class SkipTakePagedTableListResponse<T> : ApiSkipTakePagedTableResponse()
{
    var listItems:ArrayList<T> = ArrayList<T>()
}

open class ApiSkipTakePagedTableResponse : SkipTakePagedServiceResponse()
{
    var requestNumber:Int? = null
}

open class SkipTakePagedServiceResponse : ApiServiceResponse(), ISkipTakePagedServiceResponse, ISkipTakePagedServiceRequest
{
    var total:Int? = null
    var skip:Int? = null
    var take:Int? = null
}

open class ApiServiceResponse : IServiceResponse
{
    var description:String? = null
    var heading:String? = null
    var wasSuccessful:Boolean? = null
    var modelState:Object? = null
}

open class DebriefReviewListItem
{
    var id:Int? = null
    var submittedBy:String? = null
    var companyName:String? = null
    var meetingSubject:String? = null
    var dateSubmitted:String? = null
    var overallScore:String? = null
    var generalManagerId:Int? = null
    var generalManagerReviewed:Boolean? = null
    var generalManagerRating:Int? = null
    var seniorManagerId:Int? = null
    var seniorManagerReviewed:Boolean? = null
    var seniorManagerRating:Int? = null
    var divisionalManagerId:Int? = null
    var divisionalManagerReviewed:Boolean? = null
    var divisionalManagerRating:Int? = null
    var departmentManagerId:Int? = null
    var departmentManagerReviewed:Boolean? = null
    var departmentManagerRating:Int? = null
    var managerId:Int? = null
    var managerReviewed:Boolean? = null
    var managerRating:Int? = null
    var campaignManagerId:Int? = null
    var campaignManagerReviewed:Boolean? = null
    var campaignManagerRating:Int? = null
    var portfolioManagerId:Int? = null
    var portfolioManagerReviewed:Boolean? = null
    var portfolioManagerRating:Int? = null
    var age:BigDecimal? = null
    var ageColour:String? = null
    var markedAsRead:Boolean? = null
}

open class EnumOption
{
    var value:Int? = null
    var label:String? = null
}

Kotlin 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":{}}