deviceGroupResponse Type

deviceGroupResponse is returned for all deviceGroup operations except getList and getListRemote.

deviceGroupResponse always contains the following common elements:

  • authToken
  • resultCount
  • statusCode
  • statusMessage
  • summaryOnly

If resultCount is 1 and statusCode is 2000 (successful), the resultSet element is included after resultCount listing the following device group details:

  • deviceGroupName
  • description
  • groupType
  • enabled
  • devices

If resultCount is 0 and statusCode is not 2000 (successful), an error is returned in statusMessage.

Example

SOAP response deviceGroupResponse Type:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:createDeviceGroupResponse xmlns:ns="DeviceGroupService">
         <ns:return xsi:type="ax211:DeviceGroupResponse" xmlns:ax211="http://devicegroup.services.logapp.loglogic.com/xsd" xmlns:ax212="http://services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax212:authToken xsi:nil="true"/>
            <ax212:resultCount>1</ax212:resultCount>
            <ax212:statusCode>2000</ax212:statusCode>
            <ax212:statusMessage>Successful</ax212:statusMessage>
            <ax212:summaryOnly>false</ax212:summaryOnly>
            <ax211:resultSet xsi:type="ax211:DeviceGroupDetail">
               <ax211:description>local_dg1</ax211:description>
               <ax211:deviceGroupName>local_test_dg1</ax211:deviceGroupName>
               <ax211:devices>127.0.0.1/::ffff:10.114.81.42_General</ax211:devices>
               <ax211:devices>127.0.0.1/::ffff:10.114.81.42_logapp</ax211:devices>
               <ax211:enabled>enabled</ax211:enabled>
               <ax211:groupType>local</ax211:groupType>
            </ax211:resultSet>
         </ns:return>
      </ns:createDeviceGroupResponse>
   </soapenv:Body>
</soapenv:Envelope>