DeleteDevices

Deletes up to 100 specified devices from the account. You must deactivate service for the devices before you can delete them.

Uses and Requirements

You must use this API method if you have deactivated a 4G device and want to use the SIM in a different device, or want to use the same device with a different SIM. Until you delete the device, the SIM and the device are still paired in the Verizon database and neither one can be reused.

NOTE:All historical records of the device will be deleted when you delete the device. Be sure to retrieve any device history (usage history, connection history) that you might want before you delete the device.

Request Parameters

Parameter Type Description
AccountName
optional
string The Verizon billing account that the device belongs to. An account name is usually numeric, and must include any leading zeros.
DeviceList
required
DeviceIdentifierCollection A list of up to 100 devices that you want to delete, specified by device identifier. You only need to provide one identifier per device.

For each device in DeviceList, use this structure of nested parameters:

<DeviceIdentifierCollection>
  <DeviceIndentifiers>
    <DeviceIdentifier>
      <Kind></Kind>
      <Identifier></Identifier>
    </DeviceIdentifier>
  </DeviceIndentifiers>
</DeviceIdentifierCollection>
Kind
required for DeviceList
string The type of the device identifier. Valid types of identifiers are:
  • ESN (decimal)
  • ICCID (up to 20 digits)
  • IMEI (up to 15 digits)
  • MEID (hexadecimal)
  • EID
Identifier
required for DeviceList
string The value of the device identifier.

Response Parameters

The response shows whether each device in the request was able to be deleted.

Parameter Type Description
Devices DeleteDevices objects For each device in the request, contains a device identifier and a success or failure message.
DeleteDevice Delete Device Response The response for an individual device.
DeviceIdentifier DeviceIdentifier A single identifier for the device.
Kind string The type of the device identifier:
  • ESN (decimal)
  • ICCID (up to 20 digits)
  • IMEI (up to 15 digits)
  • MEID (hexadecimal)
  • EID
Identifier string The value of the device identifier.
Status string "Success" if the device was deleted, or "Failed" if there was a problem.
Message string

Nil if Status=Success. One of these messages if Status=Failed:

  • The device is not in deactivate state.
  • The user does not have access to delete the device.

Example SOAP Request

Delete three devices:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:nph="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.DeviceService"
  xmlns:nph1="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"
  xmlns:v2="http://nphase.com/unifiedwebservice/v2">
  <soapenv:Header>
    <token
      xmlns="http://nphase.com/unifiedwebservice/v2">abbeaf4e-0ed9-474a-ad73-205cf6886daa
    </token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:DeleteDevices>
      <v2:Input>
        <nph:AccountName />
        <nph:DeviceList>
          <nph1:DeviceIdentifierCollection>
            <nph1:DeviceIdentifiers>
              <nph1:DeviceIdentifier>
                <nph1:Kind>esn</nph1:Kind>
                <nph1:Identifier>09005470263</nph1:Identifier>
              </nph1:DeviceIdentifier>
            </nph1:DeviceIdentifiers>
          </nph1:DeviceIdentifierCollection>
          <nph1:DeviceIdentifierCollection>
            <nph1:DeviceIdentifiers>
              <nph1:DeviceIdentifier>
                <nph1:Kind>iccid</nph1:Kind>
                <nph1:Identifier>85000022411113460014</nph1:Identifier>
              </nph1:DeviceIdentifier>
            </nph1:DeviceIdentifiers>
          </nph1:DeviceIdentifierCollection>
          <nph1:DeviceIdentifierCollection>
            <nph1:DeviceIdentifiers>
              <nph1:DeviceIdentifier>
                <nph1:Kind>iccid</nph1:Kind>
                <nph1:Identifier>85000022412313460016</nph1:Identifier>
              </nph1:DeviceIdentifier>
            </nph1:DeviceIdentifiers>
          </nph1:DeviceIdentifierCollection>
        </nph:DeviceList>
      </v2:Input>
    </v2:DeleteDevices>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

Two devices are successfully deleted and one is not.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <DeleteDevicesResponse xmlns="http://nphase.com/unifiedwebservice/v2">
      <Output xmlns:a="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.DeviceService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Devices>
          <a:DeleteDevice>
            <a:DeviceIdentifier xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
              <b:Kind>Esn</b:Kind>
              <b:Identifier>09005470263</b:Identifier>
            </a:DeviceIdentifier>
            <a:Status>Success</a:Status>
            <a:Message i:nil="true"/>
          </a:DeleteDevice>
          <a:DeleteDevice>
            <a:DeviceIdentifier xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
              <b:Kind>Iccid</b:Kind>
              <b:Identifier>85000022411113460014</b:Identifier>
            </a:DeviceIdentifier>
            <a:Status>Success</a:Status>
            <a:Message i:nil="true"/>
          </a:DeleteDevice>
          <a:DeleteDevice>
            <a:DeviceIdentifier xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
              <b:Kind>Iccid</b:Kind>
              <b:Identifier>85000022412313460016</b:Identifier>
            </a:DeviceIdentifier>
            <a:Status>Failed</a:Status>
            <a:Message>The device is not in deactivate state.</a:Message>
          <a:DeleteDevice>
        </a:Devices>
      </Output>
    </DeleteDevicesResponse>
  </s:Body>
</s:Envelope>

Request Schema Diagram

Response Schema Diagram