Cochrane+ App API

<back to all web services

CreateDebrief

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

public class dtos
{

    public static class CreateDebrief extends ApiServiceRequest
    {
        public Integer meetingId = null;
        
        public Integer getMeetingId() { return meetingId; }
        public CreateDebrief setMeetingId(Integer value) { this.meetingId = value; return this; }
    }

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

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

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double longitude = null;
        
        public String getApiKey() { return apiKey; }
        public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
        public Double getLatitude() { return latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
    }

    public static class CreateDebriefResponse extends ApiServiceResponse
    {
        public DebriefData debrief = null;
        
        public DebriefData getDebrief() { return debrief; }
        public CreateDebriefResponse setDebrief(DebriefData value) { this.debrief = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        public String description = null;
        public String heading = null;
        public Boolean wasSuccessful = null;
        public Object modelState = null;
        
        public String getDescription() { return description; }
        public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
        public String getHeading() { return heading; }
        public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public Object getModelState() { return modelState; }
        public ApiServiceResponse setModelState(Object value) { this.modelState = value; return this; }
    }

    public static class DebriefData
    {
        public Boolean hasAiPermissions = null;
        public Integer id = null;
        public MeetingData meeting = null;
        public String dateCreated = null;
        public String lastUpdated = null;
        public Boolean completed = null;
        public Boolean hasAudio = null;
        public String companyName = null;
        public String meetingTime = null;
        public String address = null;
        public String feedback = null;
        public String research = null;
        public String nextSteps = null;
        public String opportunities = null;
        public String personnel = null;
        public String group = null;
        public String industry = null;
        public ArrayList<NewContactData> newContacts = null;
        public ArrayList<DebriefRatingCommentDetail> ratingCommentDetails = null;
        public Boolean hasComments = null;
        
        public Boolean isHasAiPermissions() { return hasAiPermissions; }
        public DebriefData setHasAiPermissions(Boolean value) { this.hasAiPermissions = value; return this; }
        public Integer getId() { return id; }
        public DebriefData setId(Integer value) { this.id = value; return this; }
        public MeetingData getMeeting() { return meeting; }
        public DebriefData setMeeting(MeetingData value) { this.meeting = value; return this; }
        public String getDateCreated() { return dateCreated; }
        public DebriefData setDateCreated(String value) { this.dateCreated = value; return this; }
        public String getLastUpdated() { return lastUpdated; }
        public DebriefData setLastUpdated(String value) { this.lastUpdated = value; return this; }
        public Boolean isCompleted() { return completed; }
        public DebriefData setCompleted(Boolean value) { this.completed = value; return this; }
        public Boolean isHasAudio() { return hasAudio; }
        public DebriefData setHasAudio(Boolean value) { this.hasAudio = value; return this; }
        public String getCompanyName() { return companyName; }
        public DebriefData setCompanyName(String value) { this.companyName = value; return this; }
        public String getMeetingTime() { return meetingTime; }
        public DebriefData setMeetingTime(String value) { this.meetingTime = value; return this; }
        public String getAddress() { return address; }
        public DebriefData setAddress(String value) { this.address = value; return this; }
        public String getFeedback() { return feedback; }
        public DebriefData setFeedback(String value) { this.feedback = value; return this; }
        public String getResearch() { return research; }
        public DebriefData setResearch(String value) { this.research = value; return this; }
        public String getNextSteps() { return nextSteps; }
        public DebriefData setNextSteps(String value) { this.nextSteps = value; return this; }
        public String getOpportunities() { return opportunities; }
        public DebriefData setOpportunities(String value) { this.opportunities = value; return this; }
        public String getPersonnel() { return personnel; }
        public DebriefData setPersonnel(String value) { this.personnel = value; return this; }
        public String getGroup() { return group; }
        public DebriefData setGroup(String value) { this.group = value; return this; }
        public String getIndustry() { return industry; }
        public DebriefData setIndustry(String value) { this.industry = value; return this; }
        public ArrayList<NewContactData> getNewContacts() { return newContacts; }
        public DebriefData setNewContacts(ArrayList<NewContactData> value) { this.newContacts = value; return this; }
        public ArrayList<DebriefRatingCommentDetail> getRatingCommentDetails() { return ratingCommentDetails; }
        public DebriefData setRatingCommentDetails(ArrayList<DebriefRatingCommentDetail> value) { this.ratingCommentDetails = value; return this; }
        public Boolean isHasComments() { return hasComments; }
        public DebriefData setHasComments(Boolean value) { this.hasComments = value; return this; }
    }

    public static class MeetingData
    {
        public Integer meetingId = null;
        public String startTime = null;
        public String arrivalTime = null;
        public String leftTime = null;
        public String duration = null;
        public Boolean showTimeFields = null;
        public String arrivalStatus = null;
        public String email = null;
        public Boolean hasEmail = null;
        public String contactName = null;
        public Double latitude = null;
        public Double longitude = null;
        public String location = null;
        public String address = null;
        public String subject = null;
        public String description = null;
        public String endTime = null;
        public String company = null;
        public String contactNumber = null;
        public Boolean hasContactNumber = null;
        public Boolean hasLocation = null;
        public String setBy = null;
        public String virtualOrInPerson = null;
        
        public Integer getMeetingId() { return meetingId; }
        public MeetingData setMeetingId(Integer value) { this.meetingId = value; return this; }
        public String getStartTime() { return startTime; }
        public MeetingData setStartTime(String value) { this.startTime = value; return this; }
        public String getArrivalTime() { return arrivalTime; }
        public MeetingData setArrivalTime(String value) { this.arrivalTime = value; return this; }
        public String getLeftTime() { return leftTime; }
        public MeetingData setLeftTime(String value) { this.leftTime = value; return this; }
        public String getDuration() { return duration; }
        public MeetingData setDuration(String value) { this.duration = value; return this; }
        public Boolean isShowTimeFields() { return showTimeFields; }
        public MeetingData setShowTimeFields(Boolean value) { this.showTimeFields = value; return this; }
        public String getArrivalStatus() { return arrivalStatus; }
        public MeetingData setArrivalStatus(String value) { this.arrivalStatus = value; return this; }
        public String getEmail() { return email; }
        public MeetingData setEmail(String value) { this.email = value; return this; }
        public Boolean isHasEmail() { return hasEmail; }
        public MeetingData setHasEmail(Boolean value) { this.hasEmail = value; return this; }
        public String getContactName() { return contactName; }
        public MeetingData setContactName(String value) { this.contactName = value; return this; }
        public Double getLatitude() { return latitude; }
        public MeetingData setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public MeetingData setLongitude(Double value) { this.longitude = value; return this; }
        public String getLocation() { return location; }
        public MeetingData setLocation(String value) { this.location = value; return this; }
        public String getAddress() { return address; }
        public MeetingData setAddress(String value) { this.address = value; return this; }
        public String getSubject() { return subject; }
        public MeetingData setSubject(String value) { this.subject = value; return this; }
        public String getDescription() { return description; }
        public MeetingData setDescription(String value) { this.description = value; return this; }
        public String getEndTime() { return endTime; }
        public MeetingData setEndTime(String value) { this.endTime = value; return this; }
        public String getCompany() { return company; }
        public MeetingData setCompany(String value) { this.company = value; return this; }
        public String getContactNumber() { return contactNumber; }
        public MeetingData setContactNumber(String value) { this.contactNumber = value; return this; }
        public Boolean isHasContactNumber() { return hasContactNumber; }
        public MeetingData setHasContactNumber(Boolean value) { this.hasContactNumber = value; return this; }
        public Boolean isHasLocation() { return hasLocation; }
        public MeetingData setHasLocation(Boolean value) { this.hasLocation = value; return this; }
        public String getSetBy() { return setBy; }
        public MeetingData setSetBy(String value) { this.setBy = value; return this; }
        public String getVirtualOrInPerson() { return virtualOrInPerson; }
        public MeetingData setVirtualOrInPerson(String value) { this.virtualOrInPerson = value; return this; }
    }

    public static class NewContactData
    {
        public String name = null;
        public String jobTitle = null;
        public String companyName = null;
        public String emailAddress = null;
        public String contactNumber = null;
        
        public String getName() { return name; }
        public NewContactData setName(String value) { this.name = value; return this; }
        public String getJobTitle() { return jobTitle; }
        public NewContactData setJobTitle(String value) { this.jobTitle = value; return this; }
        public String getCompanyName() { return companyName; }
        public NewContactData setCompanyName(String value) { this.companyName = value; return this; }
        public String getEmailAddress() { return emailAddress; }
        public NewContactData setEmailAddress(String value) { this.emailAddress = value; return this; }
        public String getContactNumber() { return contactNumber; }
        public NewContactData setContactNumber(String value) { this.contactNumber = value; return this; }
    }

    public static class DebriefRatingCommentDetail
    {
        public Integer managerId = null;
        public String name = null;
        public String title = null;
        public String reviewedDate = null;
        public Integer rating = null;
        public String comments = null;
        
        public Integer getManagerId() { return managerId; }
        public DebriefRatingCommentDetail setManagerId(Integer value) { this.managerId = value; return this; }
        public String getName() { return name; }
        public DebriefRatingCommentDetail setName(String value) { this.name = value; return this; }
        public String getTitle() { return title; }
        public DebriefRatingCommentDetail setTitle(String value) { this.title = value; return this; }
        public String getReviewedDate() { return reviewedDate; }
        public DebriefRatingCommentDetail setReviewedDate(String value) { this.reviewedDate = value; return this; }
        public Integer getRating() { return rating; }
        public DebriefRatingCommentDetail setRating(Integer value) { this.rating = value; return this; }
        public String getComments() { return comments; }
        public DebriefRatingCommentDetail setComments(String value) { this.comments = value; return this; }
    }

}

Java CreateDebrief 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.

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

{"meetingId":0,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}