Cochrane+ App API

<back to all web services

GetDebrief

Requires Authentication
The following routes are available for this service:
GET/debrief/{Id}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ServiceModel
Imports WebService.ServiceModel.Base
Imports CommonService.Api.Models.Base

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
    End Namespace

    Namespace WebService.ServiceModel

        Public Partial Class DebriefData
            Public Sub New()
                NewContacts = New List(Of NewContactData)
                RatingCommentDetails = New List(Of DebriefRatingCommentDetail)
            End Sub

            Public Overridable Property HasAiPermissions As Boolean
            Public Overridable Property Id As Integer
            Public Overridable Property Meeting As MeetingData
            Public Overridable Property DateCreated As String
            Public Overridable Property LastUpdated As String
            Public Overridable Property Completed As Boolean
            Public Overridable Property HasAudio As Boolean
            Public Overridable Property CompanyName As String
            Public Overridable Property MeetingTime As String
            Public Overridable Property Address As String
            Public Overridable Property Feedback As String
            Public Overridable Property Research As String
            Public Overridable Property NextSteps As String
            Public Overridable Property Opportunities As String
            Public Overridable Property Personnel As String
            Public Overridable Property Group As String
            Public Overridable Property Industry As String
            Public Overridable Property NewContacts As List(Of NewContactData)
            Public Overridable Property RatingCommentDetails As List(Of DebriefRatingCommentDetail)
            Public Overridable Property HasComments As Boolean
        End Class

        Public Partial Class DebriefRatingCommentDetail
            Public Overridable Property ManagerId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Title As String
            Public Overridable Property ReviewedDate As String
            Public Overridable Property Rating As Integer
            Public Overridable Property Comments As String
        End Class

        Public Partial Class GetDebrief
            Inherits ApiServiceRequest
            Public Overridable Property Id As Integer
        End Class

        Public Partial Class GetDebriefResponse
            Inherits ApiServiceResponse
            Public Sub New()
                Debriefs = New List(Of DebriefData)
            End Sub

            Public Overridable Property Debriefs As List(Of DebriefData)
        End Class

        Public Partial Class MeetingData
            Public Overridable Property MeetingId As Integer
            Public Overridable Property StartTime As String
            Public Overridable Property ArrivalTime As String
            Public Overridable Property LeftTime As String
            Public Overridable Property Duration As String
            Public Overridable Property ShowTimeFields As Boolean
            Public Overridable Property ArrivalStatus As String
            Public Overridable Property Email As String
            Public Overridable Property HasEmail As Boolean
            Public Overridable Property ContactName As String
            Public Overridable Property Latitude As Double
            Public Overridable Property Longitude As Double
            Public Overridable Property Location As String
            Public Overridable Property Address As String
            Public Overridable Property Subject As String
            Public Overridable Property Description As String
            Public Overridable Property EndTime As String
            Public Overridable Property Company As String
            Public Overridable Property ContactNumber As String
            Public Overridable Property HasContactNumber As Boolean
            Public Overridable Property HasLocation As Boolean
            Public Overridable Property SetBy As String
            Public Overridable Property VirtualOrInPerson As String
        End Class

        Public Partial Class NewContactData
            Public Overridable Property Name As String
            Public Overridable Property JobTitle As String
            Public Overridable Property CompanyName As String
            Public Overridable Property EmailAddress As String
            Public Overridable Property ContactNumber As String
        End Class
    End Namespace

    Namespace WebService.ServiceModel.Base

        Public Partial Class ApiServiceRequest
            Implements IServiceRequest
            Implements IHasApiKey
            Implements IHasDeviceInfo
            '''<Summary>
            '''The API Key required for authentication
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''Latitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Latitude of the user making this request")>
            Public Overridable Property Latitude As Double

            '''<Summary>
            '''Longitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Longitude of the user making this request")>
            Public Overridable Property Longitude As Double
        End Class
    End Namespace
End Namespace

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

GET /debrief/{Id} HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"debriefs":[{}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}