Cochrane+ App API

<back to all web services

UpdateDebrief

Requires Authentication
The following routes are available for this service:
POST/debrief/update
UpdateDebrief Parameters:
NameParameterData TypeRequiredDescription
DebriefIdbodyintNo
SubmissionCompletebodyboolNo
MeetingIdbodyintNo
CompanyNamebodystringNo
MeetingTimebodystringNo
AddressbodystringNo
FeedbackbodystringNo
ResearchbodystringNo
NextStepsbodystringNo
OpportunitiesbodystringNo
PersonnelbodystringNo
GroupbodystringNo
IndustrybodystringNo
NewContactsbodyList<NewContactData>No
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
NewContactData Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
JobTitleformstringNo
CompanyNameformstringNo
EmailAddressformstringNo
ContactNumberformstringNo
UpdateDebriefResponse Parameters:
NameParameterData TypeRequiredDescription
DebriefformDebriefDataNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
DebriefData Parameters:
NameParameterData TypeRequiredDescription
HasAiPermissionsformboolNo
IdformintNo
MeetingformMeetingDataNo
DateCreatedformstringNo
LastUpdatedformstringNo
CompletedformboolNo
HasAudioformboolNo
CompanyNameformstringNo
MeetingTimeformstringNo
AddressformstringNo
FeedbackformstringNo
ResearchformstringNo
NextStepsformstringNo
OpportunitiesformstringNo
PersonnelformstringNo
GroupformstringNo
IndustryformstringNo
NewContactsformList<NewContactData>No
RatingCommentDetailsformList<DebriefRatingCommentDetail>No
HasCommentsformboolNo
MeetingData Parameters:
NameParameterData TypeRequiredDescription
MeetingIdformintNo
StartTimeformstringNo
ArrivalTimeformstringNo
LeftTimeformstringNo
DurationformstringNo
ShowTimeFieldsformboolNo
ArrivalStatusformstringNo
EmailformstringNo
HasEmailformboolNo
ContactNameformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
LocationformstringNo
AddressformstringNo
SubjectformstringNo
DescriptionformstringNo
EndTimeformstringNo
CompanyformstringNo
ContactNumberformstringNo
HasContactNumberformboolNo
HasLocationformboolNo
SetByformstringNo
VirtualOrInPersonformstringNo
DebriefRatingCommentDetail Parameters:
NameParameterData TypeRequiredDescription
ManagerIdformintNo
NameformstringNo
TitleformstringNo
ReviewedDateformstringNo
RatingformintNo
CommentsformstringNo

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.

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: {}
}