The getNotifications Web API Method

Retrieve a list of system messages, their details and meta information. The list of messages includes state messages which cannot be modified and instance messages which can be changed. The list is always ordered by level and date. Note that “Restart” level is the highest level and will appear first in any list.

Version: 1.3

Required Permissions: Full

HTTP method: GET

Supported by Editions: All

Request Parameters:

Parameter	Type	Required	Description
hash	String	No	Hash string that represent the notifications. This hash is generated by the getNotifications API and shows in the response structure. Use this parameter to tell what version of notifications you use, and only if notifications are changed they will be sent.

Expected Response Code: 200 OK. For more information see Response Format.

Response Type: notificationsList

Possible Action Specific Error Codes: This method has no specific error codes.

Example

Usage Example

Request

GET /ZendServer/Api/getNotifications

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
<requestData>
	<apiKeyName><![CDATA[Admin]]></apiKeyName>
	<method>getNotifications</method>
</requestData>
<responseData>
	<notifications>
		<notification>
			<id>3</id>
			<severity><![CDATA[Warning]]></severity>
			<creationTime></creationTime>
			<type>1</type>
			<name>phpRestart</name>
			<repeats>20</repeats>
			<title><![CDATA[Restart required]]</title>
			<description><![CDATA[...]]</description>
			<url><![CDATA[...]]</url>
		</notification>
	</notifications>
	<hash>e203352d5f2b730f169551c3af64a35f</hash>
	<daemonMessages>
		<daemonMessage>
			<msgId>149139</msgId>
			<nodeId>0</nodeId>
			<context>daemon</context>
			<key>jqd</key>
			<severity>error</severity>
			<details><![CDATA[""]]></details>
			<type>offline</type>
		</daemonMessage>
	</daemonMessages>
</responseData>
</zendServerAPIResponse>