GetDeviceGroupInformation

Returns information about a device group, including the name, description, and list of devices in the group.

Request Parameters

Parameter Type Description
AccountName
required		 string The name of the Verizon billing account for which you want the device group information. An account name is usually numeric, and must include any leading zeros.
GroupName
required		 string The name of a device group.
LargestDeviceIdSeen
optional		 long

(Output buffering parameter) Only return information about devices that have an ID greater than this value. Each successful response will include a LargestDeviceIdSeen value.

  • For the first request, leave this element empty to retrieve the devices with the smallest IDs.
  • Check the IsComplete value in the response.
  • If it's "true" then you have received the complete list of devices.
  • If IsComplete is "false," send another request, putting the returned value of LargestDeviceIdSeen into this field. Continue sending requests with the latest LargestDeviceIdSeen value until IsComplete is "true." This ensures that all devices are retrieved exactly once, with no gaps or overlaps in devices returned by multiple calls to the API.

Response Parameters

Parameter Type Description
GroupName string The name of the device group.
GroupDescription string The description of the device group.
Devices DeviceIdentifierCollection The list of devices that belong to the device group.
DeviceIdentifiers DeviceIdentifier One or more identifiers for the device.
Kind string The type of the device identifier. Valid types of identifiers are:
  • ESN (decimal)
  • ICCID (up to 20 digits)
  • IMEI (up to 15 digits)
  • MDN
  • MEID (hexadecimal)
  • MIN
  • MSISDN
Identifier string The value of the device identifier.
IsComplete boolean Indicates whether all devices in the group have been returned. If IsComplete is false, call this API again and put the LargestDeviceIdSeen value in the request, which will return the next set of devices with sequentially larger device IDs.
LargestDeviceIdSeen long The largest device ID included in the response.

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:GetDeviceGroupInformation>
      <v2:Input>
        <nph:AccountName>account_name</nph:AccountName>
        <nph:GroupName>Environmental Devices</nph:GroupName>
      </v2:Input>
    </v2:GetDeviceGroupInformation>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <GetDeviceGroupInformationResponse 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:GroupName>Environmental Devices</a:GroupName>
        <a:GroupDescription>Greenhouse Monitors</a:GroupDescription>
        <a:Devices xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
          <a:DeviceIdentifierCollection>
            <a:DeviceIdentifiers>
              <a:DeviceIdentifier>
                <a:Kind>ESN</a:Kind>
                <a:Identifier>09102885873</a:Identifier>
              </a:DeviceIdentifier>
            </a:DeviceIdentifiers>
          </a:DeviceIdentifierCollection>
          <a:DeviceIdentifierCollection>
            <a:DeviceIdentifiers>
              <a:DeviceIdentifier>
                <a:Kind>ESN</a:Kind>
                <a:Identifier>09611822299</a:Identifier>
              </a:DeviceIdentifier>
            </a:DeviceIdentifiers>
          </a:DeviceIdentifierCollection>
        </a:Devices>
        <a:IsComplete>true</a:IsComplete>
        <a:LargestDeviceIdSeeen>2071923664</a:LargestDeviceIdSeeen>
      </Output>
    </GetDeviceGroupInformationResponse>
  </soapenv:Body>
</soapenv:Envelope>

Request Schema Diagram

Response Schema Diagram