Skip to main content
Loading...

API docs by

Get Ibx Notification

Request

This API retrieves the details of a user's IBX notification by its identification (ID) number.

Path
idstringrequired

Ibx Notification Id of the record need to load.

Headers
Authorizationstring, >= 1required

Specify the Access token with prefix 'Bearer '.

Payload
// No request payload

Responses

Bodyapplication/json
idstringrequired

Notification Identification.

Example:"5-122719992195"
typestring(ibx-notification-type)required

Notification Type

Enum:"IBX_MAINTENANCE""IBX_INCIDENT""IBX_ADVISORY""IBX_SMARTVIEW"
Example:"IBX_ADVISORY"
startTimestampstring, (date-time)required

Event/Notification start date.

Example:"2018-01-28T03:46:36.720Z"
endTimestampstring, (date-time)

Event/Notification start date

Example:"2018-01-29T03:46:36.720Z"
ibxsArray of stringsrequired

List of IBX

Example:
[
  "SG1",
  "CH2"
]
statusstring(notification-status)required

Event/Notification Status.

Enum:"EXTENDED""RESCHEDULED""CANCELLED""COMPLETED""IN_PROGRESS""RESOLVED""UPDATED""NEW""OTHER"
Example:"RESOLVED"
summarystring

Summary information about the event / notification.

Example:"Fire Alarm - IBX was Evacuated"
emailsArray of objects(NotificationEmail)

Event/Notification Email Content

Response
{
  "id": "5-122719992195",
  "type": "IBX_ADVISORY",
  "startTimestamp": "2018-01-28T03:46:36.720Z",
  "endTimestamp": "2018-01-29T03:46:36.720Z",
  "ibxs": [
    "SG1",
    "CH2"
  ],
  "status": "RESOLVED",
  "summary": "Fire Alarm - IBX was Evacuated",
  "emails": [
    { … }
  ]
}
Was this page helpful?