extension/dashboard/announcement/get

This returns the list of announcements available for the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "name", "date_added"

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "page": 0,
  "sort": "string",
  "order": "string",
  "limit": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

total

integer

optional

The total number of results available if there is no error.

announcements

array [object {8}]

optional

The list of announcements available if there is no error.

announcement_id

integer

required

The announcement ID.

user_id

integer

required

The user ID.

user

string

required

The username of the user.

title

string

required

The title.

short_description

string

required

The short description.

description

string

required

The description.

popup

boolean

required

Indicates whether this opens a popup.

date_added

string

required

The date time the announcement was created.

Example

{
  "error": [
    "string"
  ],
  "total": 0,
  "announcements": [
    {
      "announcement_id": 0,
      "user_id": 0,
      "user": "string",
      "title": "string",
      "short_description": "string",
      "description": "string",
      "popup": true,
      "date_added": "string"
    }
  ]
}