ipm7Status :: GetGroup
 
More Information: Refer to the ipMonitor 7.x Status Soap Interface or the WSDL Service Description.
   
GetGroup returns the status and some minor details about a specific Monitor.
 
GetGroup(...); Parameters (c#):
  • long ID
    All ids in ipMonitor 7.x are 64 bit integers. The ID of a Group is defined upon creation and will not change.
  • out rtGroup info
    This parameter will be set to the status information of the desired Group, if successful.
 
GetGroup(...); Return (c#):
  • bool
    GetGroup will return true if the specified Group was found, and all the out parameters were set correctly. Otherwise, the Group was not found in the ipMonitor 7 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/GetGroup"

<?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>
    <GetGroup xmlns="http://schemas.ipmonitor.com/ipm70/">
      <ID>long</ID>
    </GetGroup>
  </soap:Body>
</soap:Envelope>
SOAP / HTTP Details (Return):
 
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
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>
    <GetGroupResponse xmlns="http://schemas.ipmonitor.com/ipm70/">
      <GetGroupResult>boolean</GetGroupResult>
      <info>
        <ID>long</ID>
        <status>up or warn or down or lost or suspended or disabled or Maintenance or uninitialized or unknown</status>
        <name>string</name>
        <isroot>boolean</isroot>
        <m_total>unsignedInt</m_total>
        <d_total>unsignedInt</d_total>
        <m_lost>unsignedInt</m_lost>
        <d_lost>unsignedInt</d_lost>
        <m_down>unsignedInt</m_down>
        <d_down>unsignedInt</d_down>
        <m_warn>unsignedInt</m_warn>
        <d_warn>unsignedInt</d_warn>
        <m_ok>unsignedInt</m_ok>
        <d_ok>unsignedInt</d_ok>
        <m_offline>unsignedInt</m_offline>
        <d_offline>unsignedInt</d_offline>
      </info>
    </GetGroupResponse>
  </soap:Body>
</soap:Envelope>