| GET | /notificationcentre/ |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SearchTerm | query | string | No | |
| SystemUserMessageId | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Latitude | form | double | No | Latitude of the user making this request |
| Longitude | form | double | No | Longitude of the user making this request |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Messages | form | List<NotificationMessageData> | No | |
| UnreadCount | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Heading | form | string | No | |
| WasSuccessful | form | bool | No | |
| ModelState | form | Object | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Title | form | string | No | |
| Content | form | string | No | |
| SentBy | form | string | No | |
| SystemUserMessageId | form | int | No | |
| DateSent | form | string | No | |
| Comment | form | string | No | |
| HasComment | form | bool | No | |
| CommentDate | form | string | No | |
| HasAttachments | form | bool | No | |
| AttachmentList | form | List<NotificationMessageAttachment> | No | |
| HasRead | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsImage | form | bool | No | |
| IsPdf | form | bool | No | |
| IsWord | form | bool | No | |
| IsExcel | form | bool | No | |
| FileName | form | string | No | |
| ThumbnailUrl | form | string | No | |
| FileUrl | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"messages":[{}],"unreadCount":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}