Cochrane+ App API

<back to all web services

ReadAllMessages

Requires Authentication
The following routes are available for this service:
POST/notificationcentre/readall
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
GetNotificationMessageResponse Parameters:
NameParameterData TypeRequiredDescription
MessagesformList<NotificationMessageData>No
UnreadCountformintNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
NotificationMessageData Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
ContentformstringNo
SentByformstringNo
SystemUserMessageIdformintNo
DateSentformstringNo
CommentformstringNo
HasCommentformboolNo
CommentDateformstringNo
HasAttachmentsformboolNo
AttachmentListformList<NotificationMessageAttachment>No
HasReadformboolNo
NotificationMessageAttachment Parameters:
NameParameterData TypeRequiredDescription
IsImageformboolNo
IsPdfformboolNo
IsWordformboolNo
IsExcelformboolNo
FileNameformstringNo
ThumbnailUrlformstringNo
FileUrlformstringNo

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

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