Cochrane+ App API

<back to all web services

DebriefReviewListRequest

Requires Authentication
The following routes are available for this service:
POST/debriefreview/list

export class ApiSkipTakePagedServiceRequest implements ISkipTakePagedServiceRequest
{
    public skip: number;
    public take: number;

    public constructor(init?: Partial<ApiSkipTakePagedServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiSkipTakePagedTableRequest extends ApiSkipTakePagedServiceRequest implements IOrderKey
{
    public requestNumber: number;
    public searchQuery: string;
    public orderKey: string;
    public orderAscending: boolean;

    public constructor(init?: Partial<ApiSkipTakePagedTableRequest>) { super(init); (Object as any).assign(this, init); }
}

export class DebriefReviewListItem
{
    public id: number;
    public submittedBy: string;
    public companyName: string;
    public meetingSubject: string;
    public dateSubmitted: string;
    public overallScore: string;
    public generalManagerId: number;
    public generalManagerReviewed: boolean;
    public generalManagerRating: number;
    public seniorManagerId: number;
    public seniorManagerReviewed: boolean;
    public seniorManagerRating: number;
    public divisionalManagerId: number;
    public divisionalManagerReviewed: boolean;
    public divisionalManagerRating: number;
    public departmentManagerId: number;
    public departmentManagerReviewed: boolean;
    public departmentManagerRating: number;
    public managerId: number;
    public managerReviewed: boolean;
    public managerRating: number;
    public campaignManagerId: number;
    public campaignManagerReviewed: boolean;
    public campaignManagerRating: number;
    public portfolioManagerId: number;
    public portfolioManagerReviewed: boolean;
    public portfolioManagerRating: number;
    public age: number;
    public ageColour: string;
    public markedAsRead: boolean;

    public constructor(init?: Partial<DebriefReviewListItem>) { (Object as any).assign(this, init); }
}

export class EnumOption
{
    public value: number;
    public label: string;

    public constructor(init?: Partial<EnumOption>) { (Object as any).assign(this, init); }
}

export class DebriefReviewListResponse extends SkipTakePagedTableListResponse<DebriefReviewListItem>
{
    public readStatuses: EnumOption[];

    public constructor(init?: Partial<DebriefReviewListResponse>) { super(init); (Object as any).assign(this, init); }
}

export enum DateFilterType
{
    All = 0,
    Before = 1,
    After = 2,
    Range = 3,
}

export class DateFilter
{
    public filterType: DateFilterType;
    public dates: string[];

    public constructor(init?: Partial<DateFilter>) { (Object as any).assign(this, init); }
}

export enum DebriefReadStatusType
{
    All = 0,
    Unread = 1,
    Read = 2,
}

export class DebriefReviewListRequest extends ApiSkipTakePagedTableRequest
{
    public all: boolean;
    public dateCaptured: DateFilter;
    public readStatus: DebriefReadStatusType;

    public constructor(init?: Partial<DebriefReviewListRequest>) { super(init); (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    public description: string;
    public heading: string;
    public wasSuccessful: boolean;
    public modelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class SkipTakePagedServiceResponse extends ApiServiceResponse implements ISkipTakePagedServiceResponse, ISkipTakePagedServiceRequest
{
    public total: number;
    public skip: number;
    public take: number;

    public constructor(init?: Partial<SkipTakePagedServiceResponse>) { super(init); (Object as any).assign(this, init); }
}

export class ApiSkipTakePagedTableResponse extends SkipTakePagedServiceResponse
{
    public requestNumber: number;

    public constructor(init?: Partial<ApiSkipTakePagedTableResponse>) { super(init); (Object as any).assign(this, init); }
}

export class SkipTakePagedTableListResponse<T> extends ApiSkipTakePagedTableResponse
{
    public listItems: T[];

    public constructor(init?: Partial<SkipTakePagedTableListResponse<T>>) { super(init); (Object as any).assign(this, init); }
}

TypeScript DebriefReviewListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
Content-Length: length

{Unable to show example output for type 'DebriefReviewListResponse' using the custom 'csv' filter}Cannot dynamically create an instance of type 'WebService.ServiceModel.DebriefReviewListResponse'. Reason: No parameterless constructor defined.