Cochrane+ App API

<back to all web services

GetNotificationMessage

Requires Authentication
The following routes are available for this service:
GET/notificationcentre/
GetNotificationMessage Parameters:
NameParameterData TypeRequiredDescription
SearchTermquerystringNo
SystemUserMessageIdqueryintNo
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 .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.

GET /notificationcentre/ HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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