Knowledge Center > Developer Documentation
ipm7Status :: GetMonitor
GetMonitor returns the status and some minor details about a specific Monitor.
GetMonitor(...); Parameters (c#):
- long id
All ids in ipMonitor are 64-bit integers. The id of a Monitor is defined upon creation and will not change.
- out string name
This parameter will be set to the name of the desired Monitor, if successful.
- out string type
This parameter will be set to the type of the desired Monitor, if successful.
- out rtStatus status
This parameter will be set to the status of the desired Monitor, if successful.
GetMonitor(...); Return (c#):
- bool
GetMonitor will return true if the specified Monitor was found, and all the out parameters were set correctly.
Otherwise, the Monitor was not found in the ipMonitor instance.
SOAP / HTTP Details (Invoke):
POST /soap/status.asmx HTTP/1.1
Host: youripm7addr
Content-Type: text/xml
Content-Length: length
SOAPAction: "http://schemas.ipmonitor.com/ipm70/GetMonitor"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetMonitor xmlns="http://schemas.ipmonitor.com/ipm70/">
<id>long</id>
</GetMonitor>
</soap:Body>
</soap:Envelope>
SOAP / HTTP Details (Return):
HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetMonitorResponse xmlns="http://schemas.ipmonitor.com/ipm70/">
<GetMonitorResult>boolean</GetMonitorResult>
<name>string</name>
<type>string</type>
<status>up or warn or down or lost or suspended or disabled or Maintenance or uninitialized or unknown</status>
</GetMonitorResponse>
</soap:Body>
</soap:Envelope>
< Back

Last Updated: March 30, 2004 | What did you think of this topic?