Notices

Returns a list of the notices that the user has access to

get/notices

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/notices
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: default)

Query parameters

include-actionedboolean
Example:true
type-liststring

Response

The list of notices

Idstring
Typestring
Descriptionstring
Ordernumber
Actionedboolean
ActionMandatoryboolean
ActionTextstring
LinkTextstring
LinkURLstring
Contentstring
ExtraDatastring[]

Extra data is an array of String based on a comma delimited list.

Example response

[
  {
    "Id": "b735e733-6bcc-12b9-5514-f6c608df8ec7",
    "Type": "ADVERTISING-BANNER",
    "Description": "Advertising banner",
    "Order": 15,
    "Actioned": true,
    "ActionMandatory": true,
    "LinkURL": "http://downloads.supercorp.com.au/superMate_App_Homescreen/OutageNotification_4_4_0.html",
    "ExtraData": [
      "Outage Notification 4.4.1",
      "VERSION=4.1.2",
      "VERSION=4.1.3"
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.