Cochrane+ App API

<back to all web services

MessageComment

Requires Authentication
The following routes are available for this service:
POST/notificationcentre/comment
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;
using CommonService.Api.Models.Base;

namespace CommonService.Api.Models.Base
{
    public partial class ApiServiceResponse
        : IServiceResponse
    {
        public virtual string Description { get; set; }
        public virtual string Heading { get; set; }
        public virtual bool WasSuccessful { get; set; }
        public virtual Object ModelState { get; set; }
    }

}

namespace WebService.ServiceModel
{
    public partial class GetNotificationMessageResponse
        : ApiServiceResponse
    {
        public GetNotificationMessageResponse()
        {
            Messages = new List<NotificationMessageData>{};
        }

        public virtual List<NotificationMessageData> Messages { get; set; }
        public virtual int UnreadCount { get; set; }
    }

    public partial class MessageComment
        : ApiServiceRequest
    {
        [ApiMember(IsRequired=true)]
        public virtual int SystemUserMessageId { get; set; }

        [ApiMember(IsRequired=true)]
        public virtual string Comment { get; set; }
    }

    public partial class NotificationMessageAttachment
    {
        public virtual bool IsImage { get; set; }
        public virtual bool IsPdf { get; set; }
        public virtual bool IsWord { get; set; }
        public virtual bool IsExcel { get; set; }
        public virtual string FileName { get; set; }
        public virtual string ThumbnailUrl { get; set; }
        public virtual string FileUrl { get; set; }
    }

    public partial class NotificationMessageData
    {
        public NotificationMessageData()
        {
            AttachmentList = new List<NotificationMessageAttachment>{};
        }

        public virtual string Title { get; set; }
        public virtual string Content { get; set; }
        public virtual string SentBy { get; set; }
        public virtual int SystemUserMessageId { get; set; }
        public virtual string DateSent { get; set; }
        public virtual string Comment { get; set; }
        public virtual bool HasComment { get; set; }
        public virtual string CommentDate { get; set; }
        public virtual bool HasAttachments { get; set; }
        public virtual List<NotificationMessageAttachment> AttachmentList { get; set; }
        public virtual bool HasRead { get; set; }
    }

}

namespace WebService.ServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Latitude of the user making this request")]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Longitude of the user making this request")]
        public virtual double Longitude { get; set; }
    }

}

C# MessageComment 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 /notificationcentre/comment HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

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