Pingdom API / function Report_getOutages

Description

Returns outages in a given period 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_GetOutagesRequestgetOutagesRequest (Required)

Object that gives info about time period, check name, page number and number of results per page.

Return value

Report_GetOutagesResponsegetOutagesResponse

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

Example request

				
<soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
	<q1:Report_getOutages xmlns:q1="urn:methods">
		<APIKey xsi:type="xsd:string">abcdefgh0123456789abcdefgh</APIKey>
		<sessionId xsi:type="xsd:string">451de06cb0cfdb9811f50caf8d6565cb</sessionId>
		<getOutagesRequest href="#id1" />
	</q1:Report_getOutages>
	<q2:Report_GetOutagesRequest id="id1" xsi:type="q2:Report_GetOutagesRequest" xmlns:q2="urn:PingdomAPI">
		<from xsi:type="xsd:dateTime">2006-10-01T00:00:00+02:00</from>
		<to xsi:type="xsd:dateTime">2006-11-01T00:00:00+01:00</to>
		<checkName xsi:type="xsd:string">Test check</checkName>
		<pageNumber xsi:type="xsd:int">1</pageNumber>
		<resultsPerPage xsi:type="xsd:int">10</resultsPerPage>
	</q2:Report_GetOutagesRequest>
</soap:Body>

Example response

				
<SOAP-ENV:Body>
	<ns1:getOutagesResponse>
		<return xsi:type="ns2:Report_GetOutagesResponse">
			<status xsi:type="xsd:int">0</status>
			<outagesArray SOAP-ENC:arrayType="ns2:Report_OutageEntry[3]" xsi:type="ns2:OutagesArray">
				<item xsi:type="ns2:Report_OutageEntry">
					<from xsi:type="xsd:dateTime">2006-10-09T07:52:26-05:00</from>
					<to xsi:type="xsd:dateTime">2006-10-09T07:54:01-05:00</to>
				</item>
				<item xsi:type="ns2:Report_OutageEntry">
					<from xsi:type="xsd:dateTime">2006-10-09T07:58:27-05:00</from>
					<to xsi:type="xsd:dateTime">2006-10-09T08:00:12-05:00</to>
				</item>
				<item xsi:type="ns2:Report_OutageEntry">
					<from xsi:type="xsd:dateTime">2006-10-11T07:26:23-05:00</from>
					<to xsi:type="xsd:dateTime">2006-10-11T07:32:02-05:00</to>
				</item>
			</outagesArray>
		</return>
	</ns1:getOutagesResponse>
</SOAP-ENV:Body>