General - Update notifications

API Url

Used for updating status of notifications.

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

Permissions: user

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    notificationsObject[]

Collection of notifications.

      createdDatetime

Date and time when the notification was sent (not updatable).

      idNumber

Unique identifier of the notification (not updatable).

      publisherString

The notification publisher (not updatable).

      readBoolean

Notification status (true=Read, false=Unread).

      subjectString

The notification subject (not updatable).

      typeNumber

Type of notification (1=Alert, 2=Info, 3=Message, 4=Request approved, 5=Request rejected, 6=Warning, 7=Error). Not updatable.

Size range: 1-7

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  errorCodeNumber

Error code.

  errorMessageString

Error description.