Cochrane+ App API

<back to all web services

DebriefReviewListRequest

Requires Authentication
The following routes are available for this service:
POST/debriefreview/list
DebriefReviewListRequest Parameters:
NameParameterData TypeRequiredDescription
AllbodyboolNo
DateCapturedbodyDateFilterNo
ReadStatusbodyDebriefReadStatusTypeNo
ApiSkipTakePagedTableRequest Parameters:
NameParameterData TypeRequiredDescription
RequestNumberformintNo
SearchQueryformstringNo
OrderKeyformstringNo
OrderAscendingformboolNo
ApiSkipTakePagedServiceRequest Parameters:
NameParameterData TypeRequiredDescription
SkipformintNo
TakeformintNo
DateFilter Parameters:
NameParameterData TypeRequiredDescription
FilterTypeformDateFilterTypeNo
DatesformList<DateTime>No
DateFilterType Enum:
NameValue
All0
Before1
After2
Range3
DebriefReadStatusType Enum:
NameValue
All0
Unread1
Read2
DebriefReviewListResponse Parameters:
NameParameterData TypeRequiredDescription
ReadStatusesformList<EnumOption>No
SkipTakePagedTableListResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ListItemsformIEnumerable<T>No
ApiSkipTakePagedTableResponse Parameters:
NameParameterData TypeRequiredDescription
RequestNumberformintNo
SkipTakePagedServiceResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
SkipformintNo
TakeformintNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
DebriefReviewListItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
SubmittedByformstringNo
CompanyNameformstringNo
MeetingSubjectformstringNo
DateSubmittedformstringNo
OverallScoreformstringNo
GeneralManagerIdformintNo
GeneralManagerReviewedformboolNo
GeneralManagerRatingformintNo
SeniorManagerIdformintNo
SeniorManagerReviewedformboolNo
SeniorManagerRatingformintNo
DivisionalManagerIdformintNo
DivisionalManagerReviewedformboolNo
DivisionalManagerRatingformintNo
DepartmentManagerIdformintNo
DepartmentManagerReviewedformboolNo
DepartmentManagerRatingformintNo
ManagerIdformintNo
ManagerReviewedformboolNo
ManagerRatingformintNo
CampaignManagerIdformintNo
CampaignManagerReviewedformboolNo
CampaignManagerRatingformintNo
PortfolioManagerIdformintNo
PortfolioManagerReviewedformboolNo
PortfolioManagerRatingformintNo
AgeformdecimalNo
AgeColourformstringNo
MarkedAsReadformboolNo
EnumOption Parameters:
NameParameterData TypeRequiredDescription
ValueformintNo
LabelformstringNo

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