Cochrane+ App API

<back to all web services

DebriefReviewListRequest

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

Namespace Global

    Namespace CommonService.Api.Models.Base

        Public Partial Class ApiServiceResponse
            Implements IServiceResponse
            Public Overridable Property Description As String
            Public Overridable Property Heading As String
            Public Overridable Property WasSuccessful As Boolean
            Public Overridable Property ModelState As Object
        End Class

        Public Partial Class ApiSkipTakePagedServiceRequest
            Implements ISkipTakePagedServiceRequest
            Public Overridable Property Skip As Integer
            Public Overridable Property Take As Integer
        End Class

        Public Partial Class ApiSkipTakePagedTableRequest
            Inherits ApiSkipTakePagedServiceRequest
            Implements IOrderKey
            Public Overridable Property RequestNumber As Integer
            Public Overridable Property SearchQuery As String
            Public Overridable Property OrderKey As String
            Public Overridable Property OrderAscending As Boolean
        End Class

        Public Partial Class ApiSkipTakePagedTableResponse
            Inherits SkipTakePagedServiceResponse
            Public Overridable Property RequestNumber As Integer
        End Class

        Public Partial Class SkipTakePagedServiceResponse
            Inherits ApiServiceResponse
            Implements ISkipTakePagedServiceResponse
            Implements ISkipTakePagedServiceRequest
            Public Overridable Property Total As Integer
            Public Overridable Property Skip As Integer
            Public Overridable Property Take As Integer
        End Class

        Public Partial Class SkipTakePagedTableListResponse(Of T)
            Inherits ApiSkipTakePagedTableResponse
            Public Overridable Property ListItems As IEnumerable(Of T)
        End Class
    End Namespace

    Namespace CommonService.Api.Models.Shared

        Public Partial Class DateFilter
            Public Sub New()
                Dates = New List(Of Date)
            End Sub

            Public Overridable Property FilterType As DateFilterType
            Public Overridable Property Dates As List(Of Date)
        End Class

        Public Enum DateFilterType
            All = 0
            Before = 1
            After = 2
            Range = 3
        End Enum

        Public Partial Class EnumOption
            Public Overridable Property Value As Integer
            Public Overridable Property Label As String
        End Class
    End Namespace

    Namespace WebService.ServiceModel

        Public Enum DebriefReadStatusType
            All = 0
            Unread = 1
            Read = 2
        End Enum

        Public Partial Class DebriefReviewListItem
            Public Overridable Property Id As Integer
            Public Overridable Property SubmittedBy As String
            Public Overridable Property CompanyName As String
            Public Overridable Property MeetingSubject As String
            Public Overridable Property DateSubmitted As String
            Public Overridable Property OverallScore As String
            Public Overridable Property GeneralManagerId As Integer
            Public Overridable Property GeneralManagerReviewed As Boolean
            Public Overridable Property GeneralManagerRating As Integer
            Public Overridable Property SeniorManagerId As Integer
            Public Overridable Property SeniorManagerReviewed As Boolean
            Public Overridable Property SeniorManagerRating As Integer
            Public Overridable Property DivisionalManagerId As Integer
            Public Overridable Property DivisionalManagerReviewed As Boolean
            Public Overridable Property DivisionalManagerRating As Integer
            Public Overridable Property DepartmentManagerId As Integer
            Public Overridable Property DepartmentManagerReviewed As Boolean
            Public Overridable Property DepartmentManagerRating As Integer
            Public Overridable Property ManagerId As Integer
            Public Overridable Property ManagerReviewed As Boolean
            Public Overridable Property ManagerRating As Integer
            Public Overridable Property CampaignManagerId As Integer
            Public Overridable Property CampaignManagerReviewed As Boolean
            Public Overridable Property CampaignManagerRating As Integer
            Public Overridable Property PortfolioManagerId As Integer
            Public Overridable Property PortfolioManagerReviewed As Boolean
            Public Overridable Property PortfolioManagerRating As Integer
            Public Overridable Property Age As Decimal
            Public Overridable Property AgeColour As String
            Public Overridable Property MarkedAsRead As Boolean
        End Class

        Public Partial Class DebriefReviewListRequest
            Inherits ApiSkipTakePagedTableRequest
            Public Overridable Property All As Boolean
            Public Overridable Property DateCaptured As DateFilter
            Public Overridable Property ReadStatus As DebriefReadStatusType
        End Class

        Public Partial Class DebriefReviewListResponse
            Inherits SkipTakePagedTableListResponse(Of DebriefReviewListItem)
            Public Sub New()
                ReadStatuses = New List(Of EnumOption)
            End Sub

            Public Overridable Property ReadStatuses As List(Of EnumOption)
        End Class
    End Namespace
End Namespace

VB.NET 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.