Cochrane+ App API

<back to all web services

MessageComment

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

public class dtos
{

    public static class MessageComment extends ApiServiceRequest
    {
        @ApiMember(IsRequired=true)
        public Integer systemUserMessageId = null;

        @ApiMember(IsRequired=true)
        public String comment = null;
        
        public Integer getSystemUserMessageId() { return systemUserMessageId; }
        public MessageComment setSystemUserMessageId(Integer value) { this.systemUserMessageId = value; return this; }
        public String getComment() { return comment; }
        public MessageComment setComment(String value) { this.comment = 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 GetNotificationMessageResponse extends ApiServiceResponse
    {
        public ArrayList<NotificationMessageData> messages = null;
        public Integer unreadCount = null;
        
        public ArrayList<NotificationMessageData> getMessages() { return messages; }
        public GetNotificationMessageResponse setMessages(ArrayList<NotificationMessageData> value) { this.messages = value; return this; }
        public Integer getUnreadCount() { return unreadCount; }
        public GetNotificationMessageResponse setUnreadCount(Integer value) { this.unreadCount = 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 NotificationMessageData
    {
        public String title = null;
        public String content = null;
        public String sentBy = null;
        public Integer systemUserMessageId = null;
        public String dateSent = null;
        public String comment = null;
        public Boolean hasComment = null;
        public String commentDate = null;
        public Boolean hasAttachments = null;
        public ArrayList<NotificationMessageAttachment> attachmentList = null;
        public Boolean hasRead = null;
        
        public String getTitle() { return title; }
        public NotificationMessageData setTitle(String value) { this.title = value; return this; }
        public String getContent() { return content; }
        public NotificationMessageData setContent(String value) { this.content = value; return this; }
        public String getSentBy() { return sentBy; }
        public NotificationMessageData setSentBy(String value) { this.sentBy = value; return this; }
        public Integer getSystemUserMessageId() { return systemUserMessageId; }
        public NotificationMessageData setSystemUserMessageId(Integer value) { this.systemUserMessageId = value; return this; }
        public String getDateSent() { return dateSent; }
        public NotificationMessageData setDateSent(String value) { this.dateSent = value; return this; }
        public String getComment() { return comment; }
        public NotificationMessageData setComment(String value) { this.comment = value; return this; }
        public Boolean isHasComment() { return hasComment; }
        public NotificationMessageData setHasComment(Boolean value) { this.hasComment = value; return this; }
        public String getCommentDate() { return commentDate; }
        public NotificationMessageData setCommentDate(String value) { this.commentDate = value; return this; }
        public Boolean isHasAttachments() { return hasAttachments; }
        public NotificationMessageData setHasAttachments(Boolean value) { this.hasAttachments = value; return this; }
        public ArrayList<NotificationMessageAttachment> getAttachmentList() { return attachmentList; }
        public NotificationMessageData setAttachmentList(ArrayList<NotificationMessageAttachment> value) { this.attachmentList = value; return this; }
        public Boolean isHasRead() { return hasRead; }
        public NotificationMessageData setHasRead(Boolean value) { this.hasRead = value; return this; }
    }

    public static class NotificationMessageAttachment
    {
        public Boolean isImage = null;
        public Boolean isPdf = null;
        public Boolean isWord = null;
        public Boolean isExcel = null;
        public String fileName = null;
        public String thumbnailUrl = null;
        public String fileUrl = null;
        
        public Boolean getIsImage() { return isImage; }
        public NotificationMessageAttachment setIsImage(Boolean value) { this.isImage = value; return this; }
        public Boolean getIsPdf() { return isPdf; }
        public NotificationMessageAttachment setIsPdf(Boolean value) { this.isPdf = value; return this; }
        public Boolean getIsWord() { return isWord; }
        public NotificationMessageAttachment setIsWord(Boolean value) { this.isWord = value; return this; }
        public Boolean getIsExcel() { return isExcel; }
        public NotificationMessageAttachment setIsExcel(Boolean value) { this.isExcel = value; return this; }
        public String getFileName() { return fileName; }
        public NotificationMessageAttachment setFileName(String value) { this.fileName = value; return this; }
        public String getThumbnailUrl() { return thumbnailUrl; }
        public NotificationMessageAttachment setThumbnailUrl(String value) { this.thumbnailUrl = value; return this; }
        public String getFileUrl() { return fileUrl; }
        public NotificationMessageAttachment setFileUrl(String value) { this.fileUrl = value; return this; }
    }

}

Java MessageComment DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /notificationcentre/comment HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"systemUserMessageId":0,"comment":"String","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"messages":[{}],"unreadCount":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}