Managing Client Networks › Manage Client Networks with Web Service Methods › How Error Reporting Works

How Error Reporting Works

All interfaces except ShowVersion() return an XmlDocument object. The root node of the document is named after the method; for example, NetworkDefinitionsList or UpdateNetworkDefinition. The following attributes are attached to this root node:

• Status: A True or False string literal that indicates whether the execution was successful. For ReloadCollectors(), a True status does not necessarily mean the operation was successful because internally a reload might report no exception when the monitor is offline or unavailable.
• Message: A string containing the specific error message for a failure. Message will be empty if the operation is successful. The complete details with stack trace appears in the Windows EventLog.

The following examples illustrate the object and attributes:

<NetworkDefinitionsList Status="True" Message="">
  <Network>
  <ClientId>3</ClientId>
  <Description>192.168.0.2</Description>
  <SubnetMask>192.168.0.2/32</SubnetMask>
  <Regions>1<_/Regions>
  </Network>
</NetworkDefinitionsList>

<?xml version="1.0" encoding="utf-8" ?> <ReloadCollectors Status="False" Message="Can't connect to MySQL server on 'localhost' (10061)" />
<?xml version="1.0" encoding="utf-8" ?> <UpdateNetworkDefinition Status="True" Message=""><ClientId>7</ClientId></UpdateNetworkDefinition>
<?xml version="1.0" encoding="utf-8" ?> <InsertNetworkDefinition Status="True" Message=""><ClientId>8</ClientId></InsertNetworkDefinition>