Last Updated: 1/22/2020 12:11:05 AM
Get notifications of given customers.
Request
HTTP Request
GET /SMPI/{version}/service/wfbss/api/notifications
Parameters
Name |
Type |
Description |
Validation |
|---|---|---|---|
|
Optional Parameters |
|||
cids |
string |
A list of customer IDs separated by comma. |
At least one customer ID must be specified, and no more than 10. |
page |
integer |
Page number |
1 to max. If not set, default is 1. |
limit |
integer |
Number of records per page |
1 to 100. If not set, default is 25. |
begin_time |
integer |
Query notifications updated after the given time. |
Unix timestamp (seconds since 1970-01-01 00:00:00 UTC) |
HTTP Request Example
Get notifications of all your customers (page 1 and 25 records per page):
GET /SMPI/{version}/service/wfbss/api/notifications
Get notifications of all your customers (page 2 and 50 records per page):
GET /SMPI/{version}/service/wfbss/api/notifications?page=2&limit=50
Get notifications of specific customers (page 1 and 25 records per page):
GET /SMPI/{version}/service/wfbss/api/notifications?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3
Get notifications created after specific time (page 1 and 25 records per page):
GET /SMPI/{version}/service/wfbss/api/notifications?begin_time=1370315252
Request Body
Do not supply a request body with this method.
Response
Response
If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
"customers": [
{
"notifications": [
],
"id": "640FE47F-5118-4D79-8221-A35D0DE2EE2C"
},
{
"notifications": [
{
"type": 901,
"event_time": "1369640193",
"status_light": 2
}
],
"id": "549390C2-61B3-417E-B1F0-8955A63C08F3"
}
],
"paging": {
"total": 2,
"limit": 25,
"page": 1
}
}
Name |
Type |
Description |
Length |
|---|---|---|---|
paging.total |
integer |
The total number of notifications |
|
paging.limit |
integer |
The number of notifications per page |
1 to 100 |
paging.page |
integer |
page number |
1 to max |
customers[].id |
string |
Customer ID |
GUID |
customers[].notifications[].type |
integer |
Notification type |
OPP_RED_ALERT = 100, OPP_YELLOW_ALERT = 101, VIRUS_UNSUCCESSFUL = 200, VIRUS_INCIDENTS = 201, VIRUS_REALTIME_DISABLED = 202, PYWARE_UNSUCCESSFUL = 300, SPYWARE_INCIDENTS = 301, WTP_INCIDENTS = 400, BHVMON_INCIDENTS = 500, NETVRS_INCIDENTS = 600, CLDSCN_CONNECT = 700, UPDATE_DEPLOYMENT_WARN = 800 (Note: deployment rate less then 90%), UPDATE_DEPLOYMENT_CRIT = 801 (Note: deployment rate less than 70%), LICENSE_EXPIRE_WARN = 900, LICENSE_EXPIRED = 901, LICENSE_SEATCOUNT_WARN = 902 (Note: seat usage greater than 80%), LICENSE_SEATCOUNT_CRIT = 903 (Note: seat usage greater than 100%), URLFILTER_INCIDENTS = 1000, DEVCTL_INCIDENTS=1100 |
customers[].notifications[].event_time |
integer |
Notification time |
Unix timestamp |
customers[].notifications[].status_light |
integer |
Status icon |
0 = Green, 1 = Yellow, 2 = Red |
customers[].eid |
string |
For internal use |
GUID |