General - Get notifications

API Url

Used for loading the notification header section, with master information. For the notification body (the message itself), there's another API.

GET

http://localhost:16010/ProMarkREST/rest/General/notifications

Permissions: user

Query parameters

Field	Type	Description
status`optional`	String	Filter on notification status (R=Read, U=Unread). Allowed values:`"R""U"`

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
notifications	Object[]	Collection of notifications.
created	Datetime	Date and time when the notification was sent.
id	Number	Unique identifier of the notification.
publisher	String	The notification publisher.
read	Boolean	Notification status (true=Read, false=Unread).
subject	String	The notification subject.
type	Number	Type of notification (1=Alert, 2=Info, 3=Message, 4=Request approved, 5=Request rejected, 6=Warning, 7=Error). Size range: `1-7`
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "notifications": [
            {
               "id": 123456789,
               "publisher": "APPROVAL",
               "type": 3,
               "subject": "Approved transactions",
               "created": 2016-11-07T16:20:00.000",
               "read": false
            }
         ]
      },
      "errorCode": 0,
      "errorMessage": ""
   }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.