Cochrane+ App API

<back to all web services

UpdateDebrief

Requires Authentication
The following routes are available for this service:
POST/debrief/update
import java.math.*
import java.util.*
import net.servicestack.client.*


open class UpdateDebrief : ApiServiceRequest()
{
    var debriefId:Int? = null
    var submissionComplete:Boolean? = null
    var meetingId:Int? = null
    var companyName:String? = null
    var meetingTime:String? = null
    var address:String? = null
    var feedback:String? = null
    var research:String? = null
    var nextSteps:String? = null
    var opportunities:String? = null
    var personnel:String? = null
    var group:String? = null
    var industry:String? = null
    var newContacts:ArrayList<NewContactData> = ArrayList<NewContactData>()
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var apiKey:String? = null

    /**
    * Latitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Latitude of the user making this request")
    var latitude:Double? = null

    /**
    * Longitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Longitude of the user making this request")
    var longitude:Double? = null
}

open class NewContactData
{
    var name:String? = null
    var jobTitle:String? = null
    var companyName:String? = null
    var emailAddress:String? = null
    var contactNumber:String? = null
}

open class UpdateDebriefResponse : ApiServiceResponse()
{
    var debrief:DebriefData? = null
}

open class ApiServiceResponse : IServiceResponse
{
    var description:String? = null
    var heading:String? = null
    var wasSuccessful:Boolean? = null
    var modelState:Object? = null
}

open class DebriefData
{
    var hasAiPermissions:Boolean? = null
    var id:Int? = null
    var meeting:MeetingData? = null
    var dateCreated:String? = null
    var lastUpdated:String? = null
    var completed:Boolean? = null
    var hasAudio:Boolean? = null
    var companyName:String? = null
    var meetingTime:String? = null
    var address:String? = null
    var feedback:String? = null
    var research:String? = null
    var nextSteps:String? = null
    var opportunities:String? = null
    var personnel:String? = null
    var group:String? = null
    var industry:String? = null
    var newContacts:ArrayList<NewContactData> = ArrayList<NewContactData>()
    var ratingCommentDetails:ArrayList<DebriefRatingCommentDetail> = ArrayList<DebriefRatingCommentDetail>()
    var hasComments:Boolean? = null
}

open class MeetingData
{
    var meetingId:Int? = null
    var startTime:String? = null
    var arrivalTime:String? = null
    var leftTime:String? = null
    var duration:String? = null
    var showTimeFields:Boolean? = null
    var arrivalStatus:String? = null
    var email:String? = null
    var hasEmail:Boolean? = null
    var contactName:String? = null
    var latitude:Double? = null
    var longitude:Double? = null
    var location:String? = null
    var address:String? = null
    var subject:String? = null
    var description:String? = null
    var endTime:String? = null
    var company:String? = null
    var contactNumber:String? = null
    var hasContactNumber:Boolean? = null
    var hasLocation:Boolean? = null
    var setBy:String? = null
    var virtualOrInPerson:String? = null
}

open class DebriefRatingCommentDetail
{
    var managerId:Int? = null
    var name:String? = null
    var title:String? = null
    var reviewedDate:String? = null
    var rating:Int? = null
    var comments:String? = null
}

Kotlin UpdateDebrief 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.

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