GET List of User Notifications

Overview

---

The following table contains information about the GET method in regards to the managing process, more precisely when you want to make a GET request that returns the list of user notifications.

GET List of User Notifications
Method	GET
URL or Endpoint	/api/organizations/organizationId/user-notifications
Headers	Authorization
Parameters	organizationId, api-version
Body	Not Applicable

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
organizationId	Yes	string	Unique Id of the organization.
api-version	No	string	The correct api version to use.

Request Body

The GET method doesn't contain a request body.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": [
    {
      "id": 0,
      "title": "string",
      "userNotificationTypeId": 0,
      "active": true
    }
  ],
  "resultInfo": "string",
  "statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
id	integer($int32)	The id of the user notification.
title	string	The title of the user notification.
userNotificationTypeId	integer	The Id of the user notification type.
active	bool	Indicates whether the user is active.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed