Get Dashboard Notifications

Description

    This feed can be used to return dashboard notifications from the Administration Console Dashboard.

Pre-requisites

  • In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Account | Dashboard | Read permission.

URI

To use this endpoint you send a POST request to:

  • /api/account/get-dashboard-notifications

Request Headers

The following request headers must be included in your request:

Field Description
Authorization Please see the Authorization guide for more information on building the Authorization header.
x-mc-req-id

A randomly generated GUID, for example,

8578FCFC-A305-4D9A-99CB-F4D5ECEFE297
x-mc-app-id The Application ID provided with your Registered API Application.
x-mc-date

The current date and time in the following format, for example,

Tue, 24 Nov 2015 12:50:11 UTC

Request Body

{
"data": []
}

Response

{
"fail": [],
"meta": {
"status": 200
},
"data": [
{
"notifications": {
"displayMessage": "String",
"customerCode": "String",
"noticeType": "String",
"title": "String",
"visibleFrom": "Date String",
"warningLevel": "String",
"enabled": "Boolean",
"id": "String",
"clusterCode": "String"
}
}
]
}
meta object
Field Type Description
status Number The function level status of the request.
meta
Field Type Description
status Number The function level status of the request.
data
Field Type Description
notifications Array Array of notifications, as seen on the Administration Console Dashboard
notifications
Field Type Description
id String The Mimecast SecureID of the event
customerCode String The customer code associated with the alert. In most cases, this field will be empty.
clusterCode String The cluster code associated with the alert. In most cases, this field will be empty.
displayMessage String The detailed info for a notification
noticeType String The type of notification, which will be "PRODUCT_NEWS" or "SERVICE_NOTIFICATION"
warningLevel String The notificaion status level, which will be "GOOD" or "INFO"
visibleFrom Date String The posted date of the notification
title String Title of the notification
enabled Boolean State of the notification visibility

Sample Code

Sample code is provided to demonstrate how to use the API and is not representative of a production application. To use the sample code; complete the required variables as described, populate the desired values in the request body, and execute in your favorite IDE.  Please see the Global Base URL's page to find the correct base URL to use for your account.

POST {base_url}/api/account/get-dashboard-notifications
Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}
x-mc-date: {dateTime}
x-mc-req-id: {unique id}
x-mc-app-id: {applicationId}
Content-Type: application/json
Accept: application/json
{
"data":[]
}