Cochrane+ App API

<back to all web services

MessageComment

Requires Authentication
The following routes are available for this service:
POST/notificationcentre/comment
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
    # @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    api_key: Optional[str] = None
    """
    The API Key required for authentication
    """


    # @ApiMember(DataType="double", Description="Latitude of the user making this request")
    latitude: float = 0.0
    """
    Latitude of the user making this request
    """


    # @ApiMember(DataType="double", Description="Longitude of the user making this request")
    longitude: float = 0.0
    """
    Longitude of the user making this request
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
    description: Optional[str] = None
    heading: Optional[str] = None
    was_successful: bool = False
    model_state: Optional[Object] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationMessageAttachment:
    is_image: bool = False
    is_pdf: bool = False
    is_word: bool = False
    is_excel: bool = False
    file_name: Optional[str] = None
    thumbnail_url: Optional[str] = None
    file_url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationMessageData:
    title: Optional[str] = None
    content: Optional[str] = None
    sent_by: Optional[str] = None
    system_user_message_id: int = 0
    date_sent: Optional[str] = None
    comment: Optional[str] = None
    has_comment: bool = False
    comment_date: Optional[str] = None
    has_attachments: bool = False
    attachment_list: Optional[List[NotificationMessageAttachment]] = None
    has_read: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetNotificationMessageResponse(ApiServiceResponse):
    messages: Optional[List[NotificationMessageData]] = None
    unread_count: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MessageComment(ApiServiceRequest):
    # @ApiMember(IsRequired=true)
    system_user_message_id: int = 0

    # @ApiMember(IsRequired=true)
    comment: Optional[str] = None

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

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

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