Get all messages from the desktop notifications list

Returns list of messages with pagination options

This feature is available only in AA-14FB panel

Query Parameters

limit integer required
Possible values: [10, 20, 30, 50]
Maximum messages on page
page_number integer required
Page of the messages

Responses

application/json

Schema
Example (from schema)
Example

Schema

list_option object
This model describes settings that can be used to represent message list
pagination object
Available pagination options for tables
total_items integer
The total number of items found and reflected across all pages
items_limit integer
Possible values: [10, 25, 50]
Limiting the display of the amount of data for one page
total_pages integer
Possible values: >= 1
The number of pages that hold the requested data
current_page integer
Possible values: >= 1
Current page number
list_items object[]
Desktop message list
message_uid integer
Message unique id
message string
Message body
is_updated boolean
Is message updated status
date int64
Unix Timestamp Date

{
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    }
  },
  "list_items": [
    {
      "message_uid": 1,
      "message": "Hello world",
      "is_updated": false,
      "date": 1540819272
    }
  ]
}

{
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    }
  },
  "list_items": [
    {
      "message_uid": 1,
      "message": "Hello world",
      "is_updated": false,
      "date": 1540819272
    }
  ]
}

Unauthorized request. Log In

application/json

Schema
Example (from schema)
Log In

Schema

error string
Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

Schema
Example (from schema)
Admin Rights Required

Schema

error string
Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Get all messages from the desktop notifications list​

Get all messages from the desktop notifications list