Cochrane+ App API

<back to all web services

GetDebriefReviewRequest

Requires Authentication
The following routes are available for this service:
GET/debriefreview/{Id}
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo, JsonSerializable
{
    public function __construct(
        /** @description The API Key required for authentication */
        // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        /** @var string */
        public string $apiKey='',

        /** @description Latitude of the user making this request */
        // @ApiMember(DataType="double", Description="Latitude of the user making this request")
        /** @var float */
        public float $latitude=0.0,

        /** @description Longitude of the user making this request */
        // @ApiMember(DataType="double", Description="Longitude of the user making this request")
        /** @var float */
        public float $longitude=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['apiKey'])) $this->apiKey = $o['apiKey'];
        if (isset($o['latitude'])) $this->latitude = $o['latitude'];
        if (isset($o['longitude'])) $this->longitude = $o['longitude'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->apiKey)) $o['apiKey'] = $this->apiKey;
        if (isset($this->latitude)) $o['latitude'] = $this->latitude;
        if (isset($this->longitude)) $o['longitude'] = $this->longitude;
        return empty($o) ? new class(){} : $o;
    }
}

class ApiServiceResponse implements IServiceResponse, JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $description=null,
        /** @var string|null */
        public ?string $heading=null,
        /** @var bool|null */
        public ?bool $wasSuccessful=null,
        /** @var Object|null */
        public ?Object $modelState=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['heading'])) $this->heading = $o['heading'];
        if (isset($o['wasSuccessful'])) $this->wasSuccessful = $o['wasSuccessful'];
        if (isset($o['modelState'])) $this->modelState = JsonConverters::from('Object', $o['modelState']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->heading)) $o['heading'] = $this->heading;
        if (isset($this->wasSuccessful)) $o['wasSuccessful'] = $this->wasSuccessful;
        if (isset($this->modelState)) $o['modelState'] = JsonConverters::to('Object', $this->modelState);
        return empty($o) ? new class(){} : $o;
    }
}

class NewContactDetail implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $name=null,
        /** @var string|null */
        public ?string $jobTitle=null,
        /** @var string|null */
        public ?string $companyName=null,
        /** @var string|null */
        public ?string $emailAddress=null,
        /** @var string|null */
        public ?string $contactNumber=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['jobTitle'])) $this->jobTitle = $o['jobTitle'];
        if (isset($o['companyName'])) $this->companyName = $o['companyName'];
        if (isset($o['emailAddress'])) $this->emailAddress = $o['emailAddress'];
        if (isset($o['contactNumber'])) $this->contactNumber = $o['contactNumber'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->jobTitle)) $o['jobTitle'] = $this->jobTitle;
        if (isset($this->companyName)) $o['companyName'] = $this->companyName;
        if (isset($this->emailAddress)) $o['emailAddress'] = $this->emailAddress;
        if (isset($this->contactNumber)) $o['contactNumber'] = $this->contactNumber;
        return empty($o) ? new class(){} : $o;
    }
}

class DebriefRatingCommentDetail implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $managerId=0,
        /** @var string|null */
        public ?string $name=null,
        /** @var string|null */
        public ?string $title=null,
        /** @var string|null */
        public ?string $reviewedDate=null,
        /** @var int */
        public int $rating=0,
        /** @var string|null */
        public ?string $comments=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['managerId'])) $this->managerId = $o['managerId'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['reviewedDate'])) $this->reviewedDate = $o['reviewedDate'];
        if (isset($o['rating'])) $this->rating = $o['rating'];
        if (isset($o['comments'])) $this->comments = $o['comments'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->managerId)) $o['managerId'] = $this->managerId;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->reviewedDate)) $o['reviewedDate'] = $this->reviewedDate;
        if (isset($this->rating)) $o['rating'] = $this->rating;
        if (isset($this->comments)) $o['comments'] = $this->comments;
        return empty($o) ? new class(){} : $o;
    }
}

class DebriefReviewData implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var string|null */
        public ?string $name=null,
        /** @var string|null */
        public ?string $companyName=null,
        /** @var int */
        public int $meetingId=0,
        /** @var string|null */
        public ?string $linkedToMeeting=null,
        /** @var string|null */
        public ?string $meetingTime=null,
        /** @var string|null */
        public ?string $address=null,
        /** @var string|null */
        public ?string $research=null,
        /** @var string|null */
        public ?string $nextSteps=null,
        /** @var string|null */
        public ?string $feedback=null,
        /** @var string|null */
        public ?string $newOpportunities=null,
        /** @var string|null */
        public ?string $personnelInfo=null,
        /** @var string|null */
        public ?string $groupStructure=null,
        /** @var string|null */
        public ?string $industry=null,
        /** @var float */
        public float $meetingLatitude=0.0,
        /** @var float */
        public float $meetingLongitude=0.0,
        /** @var string|null */
        public ?string $recordingLength=null,
        /** @var string|null */
        public ?string $recordingTooShort=null,
        /** @var string|null */
        public ?string $majoritySilent=null,
        /** @var string|null */
        public ?string $volumeTooLow=null,
        /** @var string|null */
        public ?string $actionsToTake=null,
        /** @var string|null */
        public ?string $meetingSummary=null,
        /** @var string|null */
        public ?string $polarity=null,
        /** @var string|null */
        public ?string $sentiment=null,
        /** @var string|null */
        public ?string $notesForManagement=null,
        /** @var string|null */
        public ?string $notesForSalesPerson=null,
        /** @var string|null */
        public ?string $overallScore=null,
        /** @var string|null */
        public ?string $personalAppeal=null,
        /** @var string|null */
        public ?string $vocabulary=null,
        /** @var string|null */
        public ?string $equipment=null,
        /** @var string|null */
        public ?string $structure=null,
        /** @var string|null */
        public ?string $coherence=null,
        /** @var string|null */
        public ?string $sectorKnowledge=null,
        /** @var string|null */
        public ?string $clarityOfTechnicalInput=null,
        /** @var string|null */
        public ?string $caseStudyRelevance=null,
        /** @var string|null */
        public ?string $storytelling=null,
        /** @var string|null */
        public ?string $summation=null,
        /** @var string|null */
        public ?string $dynamicDiscussion=null,
        /** @var string|null */
        public ?string $listening=null,
        /** @var array<NewContactDetail>|null */
        public ?array $newContacts=null,
        /** @var string|null */
        public ?string $reportUrl=null,
        /** @var array<DebriefRatingCommentDetail>|null */
        public ?array $ratingCommentDetails=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['companyName'])) $this->companyName = $o['companyName'];
        if (isset($o['meetingId'])) $this->meetingId = $o['meetingId'];
        if (isset($o['linkedToMeeting'])) $this->linkedToMeeting = $o['linkedToMeeting'];
        if (isset($o['meetingTime'])) $this->meetingTime = $o['meetingTime'];
        if (isset($o['address'])) $this->address = $o['address'];
        if (isset($o['research'])) $this->research = $o['research'];
        if (isset($o['nextSteps'])) $this->nextSteps = $o['nextSteps'];
        if (isset($o['feedback'])) $this->feedback = $o['feedback'];
        if (isset($o['newOpportunities'])) $this->newOpportunities = $o['newOpportunities'];
        if (isset($o['personnelInfo'])) $this->personnelInfo = $o['personnelInfo'];
        if (isset($o['groupStructure'])) $this->groupStructure = $o['groupStructure'];
        if (isset($o['industry'])) $this->industry = $o['industry'];
        if (isset($o['meetingLatitude'])) $this->meetingLatitude = $o['meetingLatitude'];
        if (isset($o['meetingLongitude'])) $this->meetingLongitude = $o['meetingLongitude'];
        if (isset($o['recordingLength'])) $this->recordingLength = $o['recordingLength'];
        if (isset($o['recordingTooShort'])) $this->recordingTooShort = $o['recordingTooShort'];
        if (isset($o['majoritySilent'])) $this->majoritySilent = $o['majoritySilent'];
        if (isset($o['volumeTooLow'])) $this->volumeTooLow = $o['volumeTooLow'];
        if (isset($o['actionsToTake'])) $this->actionsToTake = $o['actionsToTake'];
        if (isset($o['meetingSummary'])) $this->meetingSummary = $o['meetingSummary'];
        if (isset($o['polarity'])) $this->polarity = $o['polarity'];
        if (isset($o['sentiment'])) $this->sentiment = $o['sentiment'];
        if (isset($o['notesForManagement'])) $this->notesForManagement = $o['notesForManagement'];
        if (isset($o['notesForSalesPerson'])) $this->notesForSalesPerson = $o['notesForSalesPerson'];
        if (isset($o['overallScore'])) $this->overallScore = $o['overallScore'];
        if (isset($o['personalAppeal'])) $this->personalAppeal = $o['personalAppeal'];
        if (isset($o['vocabulary'])) $this->vocabulary = $o['vocabulary'];
        if (isset($o['equipment'])) $this->equipment = $o['equipment'];
        if (isset($o['structure'])) $this->structure = $o['structure'];
        if (isset($o['coherence'])) $this->coherence = $o['coherence'];
        if (isset($o['sectorKnowledge'])) $this->sectorKnowledge = $o['sectorKnowledge'];
        if (isset($o['clarityOfTechnicalInput'])) $this->clarityOfTechnicalInput = $o['clarityOfTechnicalInput'];
        if (isset($o['caseStudyRelevance'])) $this->caseStudyRelevance = $o['caseStudyRelevance'];
        if (isset($o['storytelling'])) $this->storytelling = $o['storytelling'];
        if (isset($o['summation'])) $this->summation = $o['summation'];
        if (isset($o['dynamicDiscussion'])) $this->dynamicDiscussion = $o['dynamicDiscussion'];
        if (isset($o['listening'])) $this->listening = $o['listening'];
        if (isset($o['newContacts'])) $this->newContacts = JsonConverters::fromArray('NewContactDetail', $o['newContacts']);
        if (isset($o['reportUrl'])) $this->reportUrl = $o['reportUrl'];
        if (isset($o['ratingCommentDetails'])) $this->ratingCommentDetails = JsonConverters::fromArray('DebriefRatingCommentDetail', $o['ratingCommentDetails']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->companyName)) $o['companyName'] = $this->companyName;
        if (isset($this->meetingId)) $o['meetingId'] = $this->meetingId;
        if (isset($this->linkedToMeeting)) $o['linkedToMeeting'] = $this->linkedToMeeting;
        if (isset($this->meetingTime)) $o['meetingTime'] = $this->meetingTime;
        if (isset($this->address)) $o['address'] = $this->address;
        if (isset($this->research)) $o['research'] = $this->research;
        if (isset($this->nextSteps)) $o['nextSteps'] = $this->nextSteps;
        if (isset($this->feedback)) $o['feedback'] = $this->feedback;
        if (isset($this->newOpportunities)) $o['newOpportunities'] = $this->newOpportunities;
        if (isset($this->personnelInfo)) $o['personnelInfo'] = $this->personnelInfo;
        if (isset($this->groupStructure)) $o['groupStructure'] = $this->groupStructure;
        if (isset($this->industry)) $o['industry'] = $this->industry;
        if (isset($this->meetingLatitude)) $o['meetingLatitude'] = $this->meetingLatitude;
        if (isset($this->meetingLongitude)) $o['meetingLongitude'] = $this->meetingLongitude;
        if (isset($this->recordingLength)) $o['recordingLength'] = $this->recordingLength;
        if (isset($this->recordingTooShort)) $o['recordingTooShort'] = $this->recordingTooShort;
        if (isset($this->majoritySilent)) $o['majoritySilent'] = $this->majoritySilent;
        if (isset($this->volumeTooLow)) $o['volumeTooLow'] = $this->volumeTooLow;
        if (isset($this->actionsToTake)) $o['actionsToTake'] = $this->actionsToTake;
        if (isset($this->meetingSummary)) $o['meetingSummary'] = $this->meetingSummary;
        if (isset($this->polarity)) $o['polarity'] = $this->polarity;
        if (isset($this->sentiment)) $o['sentiment'] = $this->sentiment;
        if (isset($this->notesForManagement)) $o['notesForManagement'] = $this->notesForManagement;
        if (isset($this->notesForSalesPerson)) $o['notesForSalesPerson'] = $this->notesForSalesPerson;
        if (isset($this->overallScore)) $o['overallScore'] = $this->overallScore;
        if (isset($this->personalAppeal)) $o['personalAppeal'] = $this->personalAppeal;
        if (isset($this->vocabulary)) $o['vocabulary'] = $this->vocabulary;
        if (isset($this->equipment)) $o['equipment'] = $this->equipment;
        if (isset($this->structure)) $o['structure'] = $this->structure;
        if (isset($this->coherence)) $o['coherence'] = $this->coherence;
        if (isset($this->sectorKnowledge)) $o['sectorKnowledge'] = $this->sectorKnowledge;
        if (isset($this->clarityOfTechnicalInput)) $o['clarityOfTechnicalInput'] = $this->clarityOfTechnicalInput;
        if (isset($this->caseStudyRelevance)) $o['caseStudyRelevance'] = $this->caseStudyRelevance;
        if (isset($this->storytelling)) $o['storytelling'] = $this->storytelling;
        if (isset($this->summation)) $o['summation'] = $this->summation;
        if (isset($this->dynamicDiscussion)) $o['dynamicDiscussion'] = $this->dynamicDiscussion;
        if (isset($this->listening)) $o['listening'] = $this->listening;
        if (isset($this->newContacts)) $o['newContacts'] = JsonConverters::toArray('NewContactDetail', $this->newContacts);
        if (isset($this->reportUrl)) $o['reportUrl'] = $this->reportUrl;
        if (isset($this->ratingCommentDetails)) $o['ratingCommentDetails'] = JsonConverters::toArray('DebriefRatingCommentDetail', $this->ratingCommentDetails);
        return empty($o) ? new class(){} : $o;
    }
}

class GetDebriefReviewResponse extends ApiServiceResponse implements JsonSerializable
{
    /**
     * @param string|null $description
     * @param string|null $heading
     * @param bool|null $wasSuccessful
     * @param Object|null $modelState
     */
    public function __construct(
        ?string $description=null,
        ?string $heading=null,
        ?bool $wasSuccessful=null,
        ?Object $modelState=null,
        /** @var DebriefReviewData|null */
        public ?DebriefReviewData $data=null
    ) {
        parent::__construct($description,$heading,$wasSuccessful,$modelState);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['data'])) $this->data = JsonConverters::from('DebriefReviewData', $o['data']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->data)) $o['data'] = JsonConverters::to('DebriefReviewData', $this->data);
        return empty($o) ? new class(){} : $o;
    }
}

class GetDebriefReviewRequest extends ApiServiceRequest implements JsonSerializable
{
    /**
     * @param string $apiKey
     * @param float $latitude
     * @param float $longitude
     */
    public function __construct(
        string $apiKey='',
        float $latitude=0.0,
        float $longitude=0.0,
        /** @var int */
        public int $id=0
    ) {
        parent::__construct($apiKey,$latitude,$longitude);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['id'])) $this->id = $o['id'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->id)) $o['id'] = $this->id;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetDebriefReviewRequest 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.

GET /debriefreview/{Id} HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":{}}