Pingdom API / function Report_getNotifications

Description

Returns notifications for desired contacts and check names for current user.

Arguments

stringAPIKey (Required)

API key. You will find your API key in the 'Pingdom API' section of Pingdom Panel.

stringsessionId (Required)

Session ID obtained by calling Auth_login function.

Report_GetNotificationsRequestgetNotificationsRequest (Required)

Object that gives info about check names, contacts, time period, report status values, report via values, page number and results per page for notifications analysis.

Return value

Report_GetNotificationsResponsegetNotificationsResponse

Response object of Report_getNotifications function. It contains field for status of the performed operation, and field for list of notification objects.

Example request

				
<soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
	<q1:Report_getNotifications xmlns:q1="urn:methods">
	<APIKey xsi:type="xsd:string">abcdefgh0123456789abcdefgh</APIKey>
	<sessionId xsi:type="xsd:string">393e41bdac0b6bc41b719bc16220b370</sessionId>
	<getNotificationsRequest href="#id1" />
	</q1:Report_getNotifications>
	<q2:Report_GetNotificationsRequest id="id1" xsi:type="q2:Report_GetNotificationsRequest" xmlns:q2="urn:PingdomAPI">
		<checkNames href="#id2" />
		<contacts href="#id3" />
		<from xsi:type="xsd:dateTime">2006-03-15T00:00:00+01:00</from>
		<to xsi:type="xsd:dateTime">2007-03-15T00:00:00+01:00</to>
		<status href="#id4" />
		<via href="#id5" />
		<pageNumber xsi:type="xsd:int">1</pageNumber>
		<resultsPerPage xsi:type="xsd:int">35</resultsPerPage>
	</q2:Report_GetNotificationsRequest>
	<soapenc:Array id="id2" soapenc:arrayType="xsd:string[0]" />
	<soapenc:Array id="id3" soapenc:arrayType="xsd:string[0]" />
	<soapenc:Array id="id4" xmlns:q3="urn:PingdomAPI" soapenc:arrayType="q3:Report_NotificationStatusItem[4]">
		<Item xsi:type="q3:Report_NotificationStatusItem">DELIVERED</Item>
		<Item xsi:type="q3:Report_NotificationStatusItem">ERROR</Item>
		<Item xsi:type="q3:Report_NotificationStatusItem">SENT</Item>
		<Item xsi:type="q3:Report_NotificationStatusItem">NOT_DELIVERED</Item>
	</soapenc:Array>
	<soapenc:Array id="id5" xmlns:q4="urn:PingdomAPI" soapenc:arrayType="q4:Report_NotificationViaItem[2]">
		<Item xsi:type="q4:Report_NotificationViaItem">EMAIL</Item>
		<Item xsi:type="q4:Report_NotificationViaItem">SMS</Item>
	</soapenc:Array>
</soap:Body>

Example response

				
<SOAP-ENV:Body>
	<ns1:Report_getNotificationsResponse>
	<return xsi:type="ns2:Report_GetNotificationsResponse">
	<status xsi:type="xsd:int">0</status>
	<getNotificationsResponseArray SOAP-ENC:arrayType="ns2:Report_GetNotificationsResponseItem[35]" xsi:type="ns2:Report_GetNotificationsResponseArray">
	<item xsi:type="ns2:Report_GetNotificationsResponseItem">
		<notificationTime xsi:type="xsd:dateTime">2007-02-26T07:50:54-06:00</notificationTime>
		<check xsi:type="xsd:string">Check www.pingdom.com</check>
		<contact xsi:type="xsd:string">Michael Jordan</contact>
		<sentTo xsi:type="xsd:string">381-1234567</sentTo>
		<messageType xsi:type="xsd:string">SMS</messageType>
		<messageStatus xsi:type="xsd:string">ERROR</messageStatus>
		<cause xsi:type="xsd:string">UP</cause>
		<message xsi:type="xsd:string">UP alert: Check www.pingdom.com (www.pingdom.com) is UP again at 11/29/2006 10:34:01AM. /Pingdom</message>
		<charged xsi:type="xsd:boolean">false</charged>
	</item>
	<item xsi:type="ns2:Report_GetNotificationsResponseItem">
		<notificationTime xsi:type="xsd:dateTime">2007-02-26T07:50:54-06:00</notificationTime>
		<check xsi:type="xsd:string">Check www.pingdom.com</check>
		<contact xsi:type="xsd:string">Michael Jordan</contact>
		<sentTo xsi:type="xsd:string">381-1234567</sentTo>
		<messageType xsi:type="xsd:string">SMS</messageType>
		<messageStatus xsi:type="xsd:string">ERROR</messageStatus>
		<cause xsi:type="xsd:string">UP</cause>
		<message xsi:type="xsd:string">UP alert: Check www.pingdom.com (www.pingdom.com) is UP again at 11/29/2006 10:34:01AM. /Pingdom</message>
		<charged xsi:type="xsd:boolean">false</charged>
	</item>
	<item xsi:type="ns2:Report_GetNotificationsResponseItem">
		<notificationTime xsi:type="xsd:dateTime">2007-02-26T07:50:54-06:00</notificationTime>
		<check xsi:type="xsd:string">Check www.pingdom.com</check>
		<contact xsi:type="xsd:string">Michael Jordan</contact>
		<sentTo xsi:type="xsd:string">381-1234567</sentTo>
		<messageType xsi:type="xsd:string">SMS</messageType><messageStatus xsi:type="xsd:string">ERROR</messageStatus>
		<cause xsi:type="xsd:string">UP</cause>
		<message xsi:type="xsd:string">UP alert: Check www.pingdom.com (www.pingdom.com) is UP again at 11/29/2006 10:34:01AM. /Pingdom</message>
		<charged xsi:type="xsd:boolean">false</charged>
	</item>
	<item xsi:type="ns2:Report_GetNotificationsResponseItem">
		<notificationTime xsi:type="xsd:dateTime">2007-02-26T07:50:54-06:00</notificationTime>
		<check xsi:type="xsd:string">Check www.pingdom.com</check>
		<contact xsi:type="xsd:string">Michael Jordan</contact>
		<sentTo xsi:type="xsd:string">381-1234567</sentTo>
		<messageType xsi:type="xsd:string">SMS</messageType>
		<messageStatus xsi:type="xsd:string">ERROR</messageStatus>
		<cause xsi:type="xsd:string">DOWN</cause>
		<message xsi:type="xsd:string">DOWN alert: www.pingdom.com (www.pingdom.com) is DOWN at 11/29/2006 10:26:09AM. /Pingdom</message>
		<charged xsi:type="xsd:boolean">true</charged>
	</item>
	<item xsi:type="ns2:Report_GetNotificationsResponseItem">
		<notificationTime xsi:type="xsd:dateTime">2007-02-26T07:47:46-06:00</notificationTime>
		<check xsi:type="xsd:string">Check www.pingdom.com</check>
		<contact xsi:type="xsd:string">Michael Jordan</contact>
		<sentTo xsi:type="xsd:string">381-1234567</sentTo>
		<messageType xsi:type="xsd:string">SMS</messageType>
		<messageStatus xsi:type="xsd:string">ERROR</messageStatus>
		<cause xsi:type="xsd:string">DOWN</cause>
		<message xsi:type="xsd:string">DOWN alert: www.pingdom.com (www.pingdom.com) is DOWN at 11/29/2006 10:26:09AM. /Pingdom</message>
		<charged xsi:type="xsd:boolean">false</charged>
	</item>
</soap:Body>