Cochrane+ App API

<back to all web services

GetDebriefReviewRequest

Requires Authentication
The following routes are available for this service:
GET/debriefreview/{Id}

export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    public description: string;
    public heading: string;
    public wasSuccessful: boolean;
    public modelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class NewContactDetail
{
    public name: string;
    public jobTitle: string;
    public companyName: string;
    public emailAddress: string;
    public contactNumber: string;

    public constructor(init?: Partial<NewContactDetail>) { (Object as any).assign(this, init); }
}

export class DebriefRatingCommentDetail
{
    public managerId: number;
    public name: string;
    public title: string;
    public reviewedDate: string;
    public rating: number;
    public comments: string;

    public constructor(init?: Partial<DebriefRatingCommentDetail>) { (Object as any).assign(this, init); }
}

export class DebriefReviewData
{
    public id: number;
    public name: string;
    public companyName: string;
    public meetingId: number;
    public linkedToMeeting: string;
    public meetingTime: string;
    public address: string;
    public research: string;
    public nextSteps: string;
    public feedback: string;
    public newOpportunities: string;
    public personnelInfo: string;
    public groupStructure: string;
    public industry: string;
    public meetingLatitude: number;
    public meetingLongitude: number;
    public recordingLength: string;
    public recordingTooShort: string;
    public majoritySilent: string;
    public volumeTooLow: string;
    public actionsToTake: string;
    public meetingSummary: string;
    public polarity: string;
    public sentiment: string;
    public notesForManagement: string;
    public notesForSalesPerson: string;
    public overallScore: string;
    public personalAppeal: string;
    public vocabulary: string;
    public equipment: string;
    public structure: string;
    public coherence: string;
    public sectorKnowledge: string;
    public clarityOfTechnicalInput: string;
    public caseStudyRelevance: string;
    public storytelling: string;
    public summation: string;
    public dynamicDiscussion: string;
    public listening: string;
    public newContacts: NewContactDetail[];
    public reportUrl: string;
    public ratingCommentDetails: DebriefRatingCommentDetail[];

    public constructor(init?: Partial<DebriefReviewData>) { (Object as any).assign(this, init); }
}

export class GetDebriefReviewResponse extends ApiServiceResponse
{
    public data: DebriefReviewData;

    public constructor(init?: Partial<GetDebriefReviewResponse>) { super(init); (Object as any).assign(this, init); }
}

export class GetDebriefReviewRequest extends ApiServiceRequest
{
    public id: number;

    public constructor(init?: Partial<GetDebriefReviewRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetDebriefReviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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: {}
}