UpdateDeviceGroup

Lets you make changes to a device group, including changing the name and description, and adding or removing devices.

Request Parameters

Parameter Type Description
AccountName
required
string The name of the account that the device group belongs to.
GroupName
required
string The name of the device group that you want to change.
NewGroupName
optional
string A new name for the device group. The group name will not be changed if this element is null.
NewGroupDescription
optional
string A new description for the device group. The description will not be changed if this element is null.
DevicesToAdd
optional
DeviceIdentifier Zero or more devices to add to the device group. The devices will be removed from their current device groups. All devices must be from the same carrier. You can use GetDeviceList to get a list of all devices in the account.
Kind
required for DevicesToAdd
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)
  • MSISDN
Identifier
required for DevicesToAdd
string The value of the device identifier.
DevicesToRemove
optional
DeviceIdentifier Zero or more devices to remove from the device group. The devices will be added to the Default device group.
Kind
required for DevicesToRemove
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)
  • MSISDN
Identifier
required for DevicesToRemove
string The value of the device identifier.

Response Parameters

An empty response indicates that the device group was modified successfully.

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"
  xmlns:nph1="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
  <soapenv:Header>
    <v2:token>91bd36d3-a063-4600-928b-bb57eeccb9ac</v2:token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:UpdateDeviceGroup>
      <v2:Input>
        <nph:AccountName>Account Name</nph:AccountName>
        <nph:GroupName>PP1</nph:GroupName>
        <nph:NewGroupName>people1</nph:NewGroupName>
        <nph:NewGroupDescription>demo group</nph:NewGroupDescription>
        <nph:DevicesToAdd>
          <nph1:DeviceIdentifier>
            <nph1:Kind>ESN</nph1:Kind>
            <nph1:Identifier>09614910553</nph1:Identifier>
          </nph1:DeviceIdentifier>
        </nph:DevicesToAdd>
        <nph:DevicesToRemove>
          <nph1:DeviceIdentifier>
            <nph1:Kind>ESN</nph1:Kind>
            <nph1:Identifier>09613550194</nph1:Identifier>
          </nph1:DeviceIdentifier>
        </nph:DevicesToRemove>
      </v2:Input>
    </v2:UpdateDeviceGroup>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <UpdateDeviceGroupResponse 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" />
    </UpdateDeviceGroupResponse>
  </s:Body>
</s:Envelope>

Request Schema Diagram

Response Schema Diagram