Skip to main content

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
MethodGET
URL or Endpoint/api/organizations/organizationId/user-notifications
HeadersAuthorization
ParametersorganizationId, api-version
BodyNot Applicable

The description of the parameters is as follows:

Parameter NameMandatoryTypeDescription
organizationIdYesstringUnique Id of the organization.
api-versionNostringThe 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 NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)The id of the user notification.
titlestringThe title of the user notification.
userNotificationTypeIdintegerThe Id of the user notification type.
activeboolIndicates whether the user is active.
resultInfostringReturns extra information about the result.
statusCodeinteger($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