CCC API v8.12.0.0

<back to all web services

GetNotificationAlerts

The following routes are available for this service:
GET/api/notificationsList my notification alerts
GetNotificationAlertsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
NotificationAlertsformList<NotificationAlert>No
NotificationAlert Parameters:
NameParameterData TypeRequiredDescription
EnabledbodyBooleanNo
NotificationbodyNotificationNo
Notification Parameters:
NameParameterData TypeRequiredDescription
NotificationGuidbodyGuidNo
EnabledbodyBooleanNo
NamebodyStringNo
DescriptionbodyStringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/notifications HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  },
  "notificationAlerts": [
    {
      "enabled": false,
      "notification": {
        "notificationGuid": "00000000000000000000000000000000",
        "enabled": false,
        "name": "String",
        "description": "String"
      }
    }
  ]
}