Announcements

Announcements Documentation

Announcement [LIST]

Announcement [LIST]

Request

Endpoint

GET /api/v2/announcements
Content-Type: application/vnd.api+json

Body

Parameters

Filters

language_code

Type string

Description filter by language code (downcased and underscored version of the language code)

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "38ca3fed-f7a5-4017-905b-83deb89be024",
      "type": "announcements",
      "attributes": {
        "body": null,
        "created_at": "2022-01-12T17:18:50Z",
        "display_method": "modal",
        "image_url": null,
        "style": null,
        "title": "Matsoft",
        "updated_at": "2022-01-12T17:18:50Z",
        "updated_in_db_at": "2022-01-12T17:18:50Z"
      },
      "relationships": {
        "actions": {
          "data": [

          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Announcement]

Description An array of Announcements Objects

Announcement [GET]

Announcement [GET]

Request

Endpoint

GET /api/v2/announcements/81bb4c1d-8abc-4331-8be9-bf99fe33e13b
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "81bb4c1d-8abc-4331-8be9-bf99fe33e13b",
    "type": "announcements",
    "attributes": {
      "body": null,
      "created_at": "2022-01-12T17:18:50Z",
      "display_method": "modal",
      "image_url": null,
      "style": null,
      "title": "Zathin",
      "updated_at": "2022-01-12T17:18:50Z",
      "updated_in_db_at": "2022-01-12T17:18:50Z"
    },
    "relationships": {
      "actions": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

body

Type string

Description The body text of the announcement

created_at

Type date

Description The timestamp of when this resource was created

display_method

Type string

Description How the announcement should be presented to the user (One of banner, or modal)

image_url

Type URL string

Description The url of an image to display to the user

style

Type string

Description The color scheme to present the announcement (One of default, warning, info, danger, success)

title

Type string

Description The title of the announcement

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

actions.data

Type [AnnouncementAction]

Description An array of Actions the user can take to acknowledge the announcement