Cochrane+ App API

<back to all web services

UpdateDebrief

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 MeetingData:
    meeting_id: int = 0
    start_time: Optional[str] = None
    arrival_time: Optional[str] = None
    left_time: Optional[str] = None
    duration: Optional[str] = None
    show_time_fields: bool = False
    arrival_status: Optional[str] = None
    email: Optional[str] = None
    has_email: bool = False
    contact_name: Optional[str] = None
    latitude: float = 0.0
    longitude: float = 0.0
    location: Optional[str] = None
    address: Optional[str] = None
    subject: Optional[str] = None
    description: Optional[str] = None
    end_time: Optional[str] = None
    company: Optional[str] = None
    contact_number: Optional[str] = None
    has_contact_number: bool = False
    has_location: bool = False
    set_by: Optional[str] = None
    virtual_or_in_person: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewContactData:
    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 DebriefData:
    has_ai_permissions: bool = False
    id: int = 0
    meeting: Optional[MeetingData] = None
    date_created: Optional[str] = None
    last_updated: Optional[str] = None
    completed: bool = False
    has_audio: bool = False
    company_name: Optional[str] = None
    meeting_time: Optional[str] = None
    address: Optional[str] = None
    feedback: Optional[str] = None
    research: Optional[str] = None
    next_steps: Optional[str] = None
    opportunities: Optional[str] = None
    personnel: Optional[str] = None
    group: Optional[str] = None
    industry: Optional[str] = None
    new_contacts: Optional[List[NewContactData]] = None
    rating_comment_details: Optional[List[DebriefRatingCommentDetail]] = None
    has_comments: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateDebriefResponse(ApiServiceResponse):
    debrief: Optional[DebriefData] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateDebrief(ApiServiceRequest):
    debrief_id: int = 0
    submission_complete: bool = False
    meeting_id: int = 0
    company_name: Optional[str] = None
    meeting_time: Optional[str] = None
    address: Optional[str] = None
    feedback: Optional[str] = None
    research: Optional[str] = None
    next_steps: Optional[str] = None
    opportunities: Optional[str] = None
    personnel: Optional[str] = None
    group: Optional[str] = None
    industry: Optional[str] = None
    new_contacts: Optional[List[NewContactData]] = None

Python UpdateDebrief DTOs

POST /debrief/update HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	debriefId: 0,
	submissionComplete: False,
	meetingId: 0,
	companyName: String,
	meetingTime: String,
	address: String,
	feedback: String,
	research: String,
	nextSteps: String,
	opportunities: String,
	personnel: String,
	group: String,
	industry: String,
	newContacts: 
	[
		{
			name: String,
			jobTitle: String,
			companyName: String,
			emailAddress: String,
			contactNumber: String
		}
	],
	apiKey: String,
	latitude: 0,
	longitude: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}