GetDeviceGroupList

Returns a list of all device groups belonging to a specified account.

Request Parameters

Parameter Type Description
AccountName
required
string The name of the billing account for which you want to retrieve the list of device groups. An account name is usually numeric, and must include any leading zeros.
PageIndex
optional
integer The page number to return from the response set.
PageSize
optional
integer The number of groups to include in each page of the response.

Response Parameters

Parameter Type Description
DeviceGroupList DeviceGroupInfo List of device groups in the specified account.
GroupName string The name of the device group.
GroupDescription string The description of the device group.
IsDefaultGroup boolean Identifies the default device group.
ExtendedAttributes ExtendedAttributesObj Not used.

Example SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:v2="http://nphase.com/unifiedwebservice/v2"
  xmlns:nph="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.DeviceGroupService">
  <soapenv:Header>
    <v2:token>91bd36d3-a063-4600-928b-bb57eeccb9ac</v2:token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:GetDeviceGroupList>
      <v2:Input>
        <nph:AccountName>Account Name</nph:AccountName>
      </v2:Input>
    </v2:GetDeviceGroupList>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <GetDeviceGroupListResponse xmlns="http://nphase.com/unifiedwebservice/v2">
      <Output xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:a="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.DeviceGroupService">
        <a:DeviceGroupList>
          <a:DeviceGroupInfo>
            <a:groupName>Default: All Trucks</a:groupName>
            <a:groupDescription>Default group used for all truck monitors</a:groupDescription>
            <a:isDefaultGroup>true</a:isDefaultGroup>
          </a:DeviceGroupInfo>
          <a:DeviceGroupInfo>
            <a:groupName>Environmental Devices</a:groupName>
            <a:groupDescription>Greenhouse Monitors</a:groupDescription>
            <a:isDefaultGroup>false</a:isDefaultGroup>
          </a:DeviceGroupInfo>
        </a:DeviceGroupList>
      </Output>
    </GetDeviceGroupListResponse>
  </soapenv:Body>

Request Schema Diagram

Response Schema Diagram