Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Notification Events

A notification event is a construct that can be used to group similar notifications.
The GET /notifications API allows for searching for notification results based on notificationEventId. This way, you can filter the set of notifications returned.

GET /notificationEvents/{organizationId}

Description

Retrieve all notification events for an organization.

Return type

collection of notificationEvents

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the notificationEvents.

Example Response

{
   "message":"OK",
   "page":{
      "pageSize":3,
      "start":1,
      "data":[
         {
            "createdName":"Delaney Lange",
            "accountId":0,
            "status":"A",
            "resourceBundleId":0,
            "organizationId":8800387991360,
            "id":444206992589103,
            "createdId":444206992589584,
            "lastModifiedId":444206992589584,
            "lastModifiedDate":1460441126621,
            "createdDate":1460441126621,
            "lastModifiedName":"Delaney Lange"
         },
         {
            "createdName":"Regan Lowe",
            "accountId":0,
            "status":"A",
            "resourceBundleId":0,
            "organizationId":8800387991360,
            "id":444206992589100,
            "name":"Fall Release",
            "createdId":444206992589584,
            "lastModifiedId":444206992589584,
            "lastModifiedDate":1460031059161,
            "createdDate":1460031059161,
            "lastModifiedName":"Regan Lowe"
         },
         {
            "createdName":"Arnold Palmer",
            "accountId":0,
            "status":"A",
            "resourceBundleId":0,
            "organizationId":8800387991360,
            "id":444206992589075,
            "name":"Office Closure",
            "createdId":444206992589546,
            "lastModifiedId":444206992589546,
            "lastModifiedDate":1456707102055,
            "createdDate":1456707102055,
            "lastModifiedName":"Arnold Palmer"
         }
      ],
      "totalCount":3,
      "totalPageCount":1,
      "currentPageNo":1
   }
}

GET /notificationEvents/{organizationId}/{notificationEventId}

Description

Retrieve a specific notification event.

Return type

notificationEvent instance

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization in which to find the notificationEvent.
notificationEventId	long	y	The ID of the notificationEvent.

Example Response

{
  "message": "OK",
  "result": {
    "createdName": "Ron Evans",
    "accountId": 0,
    "status": "A",
    "resourceBundleId": 0,
    "organizationId": 8800387991360,
    "id": 444206992589075,
    "name": "Hurricane Warning",
    "createdId": 444206992589546,
    "lastModifiedId": 444206992589546,
    "lastModifiedDate": 1456707102055,
    "createdDate": 1456707102055,
    "lastModifiedName": "Ron Evans"
  }
}

POST /notificationEvents/{organizationId}

Description

Create a new notificationEvent within an organization.

Return type

notificationEvent instance

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the notificationEvents.
notificationEvent	NotificationEventWrapper	y	The JSON object describing the new notificationEvent.

Example Request

The only required field in this POST is “name” for the Notification Event.

{
  "name": "Flood Warning"
}