CreateDeviceGroup

Create a new device group and optionally add devices to the group.

Request Parameters

Parameter Type Description
AccountName
required		 string The Verizon billing account that the device group will belong to. An account name is usually numeric, and must include any leading zeros.
GroupName
required		 string The name for the new device group. This name must be unique within the specified account.
GroupDescription
required		 string A description for the device group.
DevicesToAdd
optional		 DeviceIdentifier Zero or more devices to add to the device group. 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 16 digits)
  • MDN
  • MEID (hexadecimal)
  • MSISDN
Identifier
required for DevicesToAdd		 string The value of the device identifier.

Response Parameters

An empty response indicates that the device group was created 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:CreateDeviceGroup>
      <v2:Input>
        <nph:AccountName>Account Name</nph:AccountName>
        <nph:GroupName>demo</nph:GroupName>
        <nph:GroupDescription>This group will be used to demonstrate device group functions.</nph:GroupDescription>
      </v2:Input>
    </v2:CreateDeviceGroup>
  </soapenv:Body>
 </soapenv:Envelope>

Example SOAP Response

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

Request Schema Diagram

Response Schema Diagram