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

Notification Categories

Notification categories are grouping constructs used for notification templates.

GET /notificationCategories/{organizationId}

Description

Retrieve all notificationCategories for an organization.

Return type

collection of notificationCategories

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the notificationCategories.
launchPolicyId	long	y	The page number of notificationCategories to return.

Example Response

{
  "message": "OK",
  "page": {
    "pageSize": 10,
    "start": 0,
    "data": [
      {
        "createdName": "Ezra Talle",
        "accountId": 3928472910,
        "status": "A",
        "resourceBundleId": 0,
        "organizationId": 8800387991360,
        "id": 470595271655542,
        "name": "Natural Disasters",
        "createdId": 444206992589678,
        "lastModifiedId": 444206992589678,
        "lastModifiedDate": 1504021781015,
        "createdDate": 1504021781015,
        "lastModifiedName": "Ezra Talle"
      },
      {
        "createdName": "Lucy Reese",
        "accountId": 8800387990738,
        "status": "A",
        "resourceBundleId": 8800387991734,
        "organizationId": 8800387991360,
        "id": 444206992588858,
        "name": "Hospital Events",
        "createdId": 444206992589476,
        "lastModifiedId": 444206992589476,
        "lastModifiedDate": 1437836690792,
        "createdDate": 1437836690792,
        "lastModifiedName": "Lucy Reese"
      }
    ],
    "totalCount": 2,
    "totalPageCount": 1,
    "currentPageNo": 1
  }
}

GET /notificationCategories/{organizationId}/{categoryId}

Description

Retrieve a specific notificationCategory within an organization.

Return type

notificationCategory instance

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the notificationCategories.
categoryId	long	y	The ID of this notificationCategory to return.

Example Response

{
  "message": "OK",
  "page": {
    "pageSize": 10,
    "start": 0,
    "data": [
      {
        "createdName": "Leslie Knope",
        "accountId": 8800387990738,
        "status": "A",
        "resourceBundleId": 8800387991734,
        "organizationId": 8800387991360,
        "id": 444206992588858,
        "name": "Emergency Notifications",
        "createdId": 444206992589476,
        "lastModifiedId": 444206992589476,
        "lastModifiedDate": 1437836690792,
        "createdDate": 1437836690792,
        "lastModifiedName": "Lesley Knope"
      }
    ],
    "totalCount": 1,
    "totalPageCount": 1,
    "currentPageNo": 1
  }
}

POST /notificationCategories/{organizationId}

Description

Create a new notificationCategory.

Return type

notificationCategory instance

Parameters

Name	Data Type	Required?	Description
credentials	string	y	Basic Authorization header.
organizationId	long	y	The ID of the organization containing the notificationCategories.
category	CategoryWrapper	y	The notificationCateogry object to create.

Example Request

‘Name’ is the only required field to Post a notificationCategory.

{
  "name": "Natural Disasters"
}

Example Response

{
  "message": "OK"
}