Cochrane+ App API

<back to all web services

DebriefReviewListRequest

Requires Authentication
The following routes are available for this service:
POST/debriefreview/list
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using CommonService.Api.Models.Base;
using CommonService.Api.Models.Shared;

namespace CommonService.Api.Models.Base
{
    public partial class ApiServiceResponse
        : IServiceResponse
    {
        public virtual string Description { get; set; }
        public virtual string Heading { get; set; }
        public virtual bool WasSuccessful { get; set; }
        public virtual Object ModelState { get; set; }
    }

    public partial class ApiSkipTakePagedServiceRequest
        : ISkipTakePagedServiceRequest
    {
        public virtual int Skip { get; set; }
        public virtual int Take { get; set; }
    }

    public partial class ApiSkipTakePagedTableRequest
        : ApiSkipTakePagedServiceRequest, IOrderKey
    {
        public virtual int RequestNumber { get; set; }
        public virtual string SearchQuery { get; set; }
        public virtual string OrderKey { get; set; }
        public virtual bool OrderAscending { get; set; }
    }

    public partial class ApiSkipTakePagedTableResponse
        : SkipTakePagedServiceResponse
    {
        public virtual int RequestNumber { get; set; }
    }

    public partial class SkipTakePagedServiceResponse
        : ApiServiceResponse, ISkipTakePagedServiceResponse, ISkipTakePagedServiceRequest
    {
        public virtual int Total { get; set; }
        public virtual int Skip { get; set; }
        public virtual int Take { get; set; }
    }

    public partial class SkipTakePagedTableListResponse<T>
        : ApiSkipTakePagedTableResponse
    {
        public virtual IEnumerable<T> ListItems { get; set; }
    }

}

namespace CommonService.Api.Models.Shared
{
    public partial class DateFilter
    {
        public DateFilter()
        {
            Dates = new List<DateTime>{};
        }

        public virtual DateFilterType FilterType { get; set; }
        public virtual List<DateTime> Dates { get; set; }
    }

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

    public partial class EnumOption
    {
        public virtual int Value { get; set; }
        public virtual string Label { get; set; }
    }

}

namespace WebService.ServiceModel
{
    public enum DebriefReadStatusType
    {
        All = 0,
        Unread = 1,
        Read = 2,
    }

    public partial class DebriefReviewListItem
    {
        public virtual int Id { get; set; }
        public virtual string SubmittedBy { get; set; }
        public virtual string CompanyName { get; set; }
        public virtual string MeetingSubject { get; set; }
        public virtual string DateSubmitted { get; set; }
        public virtual string OverallScore { get; set; }
        public virtual int GeneralManagerId { get; set; }
        public virtual bool GeneralManagerReviewed { get; set; }
        public virtual int GeneralManagerRating { get; set; }
        public virtual int SeniorManagerId { get; set; }
        public virtual bool SeniorManagerReviewed { get; set; }
        public virtual int SeniorManagerRating { get; set; }
        public virtual int DivisionalManagerId { get; set; }
        public virtual bool DivisionalManagerReviewed { get; set; }
        public virtual int DivisionalManagerRating { get; set; }
        public virtual int DepartmentManagerId { get; set; }
        public virtual bool DepartmentManagerReviewed { get; set; }
        public virtual int DepartmentManagerRating { get; set; }
        public virtual int ManagerId { get; set; }
        public virtual bool ManagerReviewed { get; set; }
        public virtual int ManagerRating { get; set; }
        public virtual int CampaignManagerId { get; set; }
        public virtual bool CampaignManagerReviewed { get; set; }
        public virtual int CampaignManagerRating { get; set; }
        public virtual int PortfolioManagerId { get; set; }
        public virtual bool PortfolioManagerReviewed { get; set; }
        public virtual int PortfolioManagerRating { get; set; }
        public virtual decimal Age { get; set; }
        public virtual string AgeColour { get; set; }
        public virtual bool MarkedAsRead { get; set; }
    }

    public partial class DebriefReviewListRequest
        : ApiSkipTakePagedTableRequest
    {
        public virtual bool All { get; set; }
        public virtual DateFilter DateCaptured { get; set; }
        public virtual DebriefReadStatusType ReadStatus { get; set; }
    }

    public partial class DebriefReviewListResponse
        : SkipTakePagedTableListResponse<DebriefReviewListItem>
    {
        public DebriefReviewListResponse()
        {
            ReadStatuses = new List<EnumOption>{};
        }

        public virtual List<EnumOption> ReadStatuses { get; set; }
    }

}

C# DebriefReviewListRequest DTOs

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

HTTP + OTHER

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

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