To get the monitor status, send a POST request to /devices/status
after logging in. This will return a list of all monitors, or, if a monitor ID is specified in <ObjDevice>
, then the status for that monitor is returned, along with the most recent status. This is useful to determine if any monitors failed the last test.
Request URL
Request Body
XML
<Status>
<TxnHeader>
<Request>
<Login>_LOGIN_</Login>
<SessionID>_SESSION_</SessionID>
<ObjCust>_CUSTOMER_ID_</ObjCust>
<ObjDevice>_MONITOR_ID_</ObjDevice>
</Request>
</TxnHeader>
<Source>REST_Client</Source>
</Status>
Response Body
XML
<Response>
<Status>0</Status>
<Message>No errors.</Message>
<SessionID>a1077ff0b1a40a62</SessionID>
<ObjDevice></ObjDevice>
<ObjCust>24567</ObjCust>
<Custid>C24567</Custid>
<Company>WidgetWorld</Company>
<CurrPlan></CurrPlan>
<CurrInterval></CurrInterval>
<AvailablePlans>WTP5-1.5x:1:1</AvailablePlans>
<DeviceStatuses>
<Device>
<ObjDevice>38525</ObjDevice>
<Descrip>Revenue_Home_Page</Descrip>
<ObjLocation>10</ObjLocation>
<Location>Fort Lauderdale, Florida</Location>
<Monitor>y</Monitor>
<LastStatus></LastStatus>
<DtLastStatus></DtLastStatus>
<DtLastError></DtLastError>
</Device>
</DeviceStatuses>
</Response>
The relevant XML tags are described below.
ObjDevice
The monitor ID.
Descrip
The monitor name.
ObjLocation
AlertSite location ID.
Location
AlertSite location name.
Monitor
y
if the monitor is enabled, n
if it is disabled.
LastStatus
Last status of the monitor.
DtLastStatus
Date and time the monitor was checked last time.
DtLastError
Date and time the last error was recorded.
AvailablePlans
List of available plans indicated as <PlanName>:<num_used>:<num_available>.
See Also
Add Monitor
Edit Monitor
List Monitors
Get Monitor
Delete Monitor
AlertSite XML API