Cochrane+ App API

<back to all web services

GetDebriefReviewRequest

Requires Authentication
The following routes are available for this service:
GET/debriefreview/{Id}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
    # @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    api_key: Optional[str] = None
    """
    The API Key required for authentication
    """


    # @ApiMember(DataType="double", Description="Latitude of the user making this request")
    latitude: float = 0.0
    """
    Latitude of the user making this request
    """


    # @ApiMember(DataType="double", Description="Longitude of the user making this request")
    longitude: float = 0.0
    """
    Longitude of the user making this request
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
    description: Optional[str] = None
    heading: Optional[str] = None
    was_successful: bool = False
    model_state: Optional[Object] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewContactDetail:
    name: Optional[str] = None
    job_title: Optional[str] = None
    company_name: Optional[str] = None
    email_address: Optional[str] = None
    contact_number: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DebriefRatingCommentDetail:
    manager_id: int = 0
    name: Optional[str] = None
    title: Optional[str] = None
    reviewed_date: Optional[str] = None
    rating: int = 0
    comments: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DebriefReviewData:
    id: int = 0
    name: Optional[str] = None
    company_name: Optional[str] = None
    meeting_id: int = 0
    linked_to_meeting: Optional[str] = None
    meeting_time: Optional[str] = None
    address: Optional[str] = None
    research: Optional[str] = None
    next_steps: Optional[str] = None
    feedback: Optional[str] = None
    new_opportunities: Optional[str] = None
    personnel_info: Optional[str] = None
    group_structure: Optional[str] = None
    industry: Optional[str] = None
    meeting_latitude: float = 0.0
    meeting_longitude: float = 0.0
    recording_length: Optional[str] = None
    recording_too_short: Optional[str] = None
    majority_silent: Optional[str] = None
    volume_too_low: Optional[str] = None
    actions_to_take: Optional[str] = None
    meeting_summary: Optional[str] = None
    polarity: Optional[str] = None
    sentiment: Optional[str] = None
    notes_for_management: Optional[str] = None
    notes_for_sales_person: Optional[str] = None
    overall_score: Optional[str] = None
    personal_appeal: Optional[str] = None
    vocabulary: Optional[str] = None
    equipment: Optional[str] = None
    structure: Optional[str] = None
    coherence: Optional[str] = None
    sector_knowledge: Optional[str] = None
    clarity_of_technical_input: Optional[str] = None
    case_study_relevance: Optional[str] = None
    storytelling: Optional[str] = None
    summation: Optional[str] = None
    dynamic_discussion: Optional[str] = None
    listening: Optional[str] = None
    new_contacts: Optional[List[NewContactDetail]] = None
    report_url: Optional[str] = None
    rating_comment_details: Optional[List[DebriefRatingCommentDetail]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDebriefReviewResponse(ApiServiceResponse):
    data: Optional[DebriefReviewData] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDebriefReviewRequest(ApiServiceRequest):
    id: int = 0

Python GetDebriefReviewRequest 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 /debriefreview/{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

{"data":{"id":0,"name":"String","companyName":"String","meetingId":0,"linkedToMeeting":"String","meetingTime":"String","address":"String","research":"String","nextSteps":"String","feedback":"String","newOpportunities":"String","personnelInfo":"String","groupStructure":"String","industry":"String","meetingLatitude":0,"meetingLongitude":0,"recordingLength":"String","recordingTooShort":"String","majoritySilent":"String","volumeTooLow":"String","actionsToTake":"String","meetingSummary":"String","polarity":"String","sentiment":"String","notesForManagement":"String","notesForSalesPerson":"String","overallScore":"String","personalAppeal":"String","vocabulary":"String","equipment":"String","structure":"String","coherence":"String","sectorKnowledge":"String","clarityOfTechnicalInput":"String","caseStudyRelevance":"String","storytelling":"String","summation":"String","dynamicDiscussion":"String","listening":"String","newContacts":[{}],"reportUrl":"String","ratingCommentDetails":[{"managerId":0,"name":"String","title":"String","reviewedDate":"String","rating":0,"comments":"String"}]},"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}