Cochrane+ App API

<back to all web services

DebriefReviewListRequest

Requires Authentication
The following routes are available for this service:
POST/debriefreview/list
"use strict";
export class ApiSkipTakePagedServiceRequest {
    /** @param {{skip?:number,take?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    skip;
    /** @type {number} */
    take;
}
export class ApiSkipTakePagedTableRequest extends ApiSkipTakePagedServiceRequest {
    /** @param {{requestNumber?:number,searchQuery?:string,orderKey?:string,orderAscending?:boolean,skip?:number,take?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    requestNumber;
    /** @type {string} */
    searchQuery;
    /** @type {string} */
    orderKey;
    /** @type {boolean} */
    orderAscending;
}
export class DebriefReviewListItem {
    /** @param {{id?:number,submittedBy?:string,companyName?:string,meetingSubject?:string,dateSubmitted?:string,overallScore?:string,generalManagerId?:number,generalManagerReviewed?:boolean,generalManagerRating?:number,seniorManagerId?:number,seniorManagerReviewed?:boolean,seniorManagerRating?:number,divisionalManagerId?:number,divisionalManagerReviewed?:boolean,divisionalManagerRating?:number,departmentManagerId?:number,departmentManagerReviewed?:boolean,departmentManagerRating?:number,managerId?:number,managerReviewed?:boolean,managerRating?:number,campaignManagerId?:number,campaignManagerReviewed?:boolean,campaignManagerRating?:number,portfolioManagerId?:number,portfolioManagerReviewed?:boolean,portfolioManagerRating?:number,age?:number,ageColour?:string,markedAsRead?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    submittedBy;
    /** @type {string} */
    companyName;
    /** @type {string} */
    meetingSubject;
    /** @type {string} */
    dateSubmitted;
    /** @type {string} */
    overallScore;
    /** @type {number} */
    generalManagerId;
    /** @type {boolean} */
    generalManagerReviewed;
    /** @type {number} */
    generalManagerRating;
    /** @type {number} */
    seniorManagerId;
    /** @type {boolean} */
    seniorManagerReviewed;
    /** @type {number} */
    seniorManagerRating;
    /** @type {number} */
    divisionalManagerId;
    /** @type {boolean} */
    divisionalManagerReviewed;
    /** @type {number} */
    divisionalManagerRating;
    /** @type {number} */
    departmentManagerId;
    /** @type {boolean} */
    departmentManagerReviewed;
    /** @type {number} */
    departmentManagerRating;
    /** @type {number} */
    managerId;
    /** @type {boolean} */
    managerReviewed;
    /** @type {number} */
    managerRating;
    /** @type {number} */
    campaignManagerId;
    /** @type {boolean} */
    campaignManagerReviewed;
    /** @type {number} */
    campaignManagerRating;
    /** @type {number} */
    portfolioManagerId;
    /** @type {boolean} */
    portfolioManagerReviewed;
    /** @type {number} */
    portfolioManagerRating;
    /** @type {number} */
    age;
    /** @type {string} */
    ageColour;
    /** @type {boolean} */
    markedAsRead;
}
export class EnumOption {
    /** @param {{value?:number,label?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    value;
    /** @type {string} */
    label;
}
export class DebriefReviewListResponse extends SkipTakePagedTableListResponse {
    /** @param {{readStatuses?:EnumOption[],listItems?:T[],requestNumber?:number,total?:number,skip?:number,take?:number,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {EnumOption[]} */
    readStatuses;
}
/** @typedef {number} */
export var DateFilterType;
(function (DateFilterType) {
    DateFilterType[DateFilterType["All"] = 0] = "All"
    DateFilterType[DateFilterType["Before"] = 1] = "Before"
    DateFilterType[DateFilterType["After"] = 2] = "After"
    DateFilterType[DateFilterType["Range"] = 3] = "Range"
})(DateFilterType || (DateFilterType = {}));
export class DateFilter {
    /** @param {{filterType?:DateFilterType,dates?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DateFilterType} */
    filterType;
    /** @type {string[]} */
    dates;
}
/** @typedef {number} */
export var DebriefReadStatusType;
(function (DebriefReadStatusType) {
    DebriefReadStatusType[DebriefReadStatusType["All"] = 0] = "All"
    DebriefReadStatusType[DebriefReadStatusType["Unread"] = 1] = "Unread"
    DebriefReadStatusType[DebriefReadStatusType["Read"] = 2] = "Read"
})(DebriefReadStatusType || (DebriefReadStatusType = {}));
export class DebriefReviewListRequest extends ApiSkipTakePagedTableRequest {
    /** @param {{all?:boolean,dateCaptured?:DateFilter,readStatus?:DebriefReadStatusType,requestNumber?:number,searchQuery?:string,orderKey?:string,orderAscending?:boolean,skip?:number,take?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {boolean} */
    all;
    /** @type {DateFilter} */
    dateCaptured;
    /** @type {DebriefReadStatusType} */
    readStatus;
}
export class ApiServiceResponse {
    /** @param {{description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    description;
    /** @type {string} */
    heading;
    /** @type {boolean} */
    wasSuccessful;
    /** @type {Object} */
    modelState;
}
export class SkipTakePagedServiceResponse extends ApiServiceResponse {
    /** @param {{total?:number,skip?:number,take?:number,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    total;
    /** @type {number} */
    skip;
    /** @type {number} */
    take;
}
export class ApiSkipTakePagedTableResponse extends SkipTakePagedServiceResponse {
    /** @param {{requestNumber?:number,total?:number,skip?:number,take?:number,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    requestNumber;
}
/** @typedef T {any} */
export class SkipTakePagedTableListResponse extends ApiSkipTakePagedTableResponse {
    /** @param {{listItems?:T[],requestNumber?:number,total?:number,skip?:number,take?:number,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {T[]} */
    listItems;
}

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