GetDeviceExtendedDiagnosticsInformation

Returns basic diagnostic information about a specified device, including connectivity, provisioning, and billing status.

Request Parameters

Parameter	Type	Description
AccountName required	string	The Verizon billing account that the device belongs to. An account name is usually numeric, and must include any leading zeros.
Device required	DeviceIdentifier	The device for which you want diagnostic information, specified by the device's MDN. NOTE: You can use GetDeviceList to get a list of all devices in the account.
Device.Kind required	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
Device.Identifier required	string	The value of the device identifier.

Response Parameters

The response includes various types of information about the device, grouped into categories. Each category object contains the category name and a list of Extended Attribute objects.

DeviceIdentifier Category

The hardware and assigned identifiers for the device.

Extended Attribute Key	Extended Attribute Value Description
EID ESN ICCID IMEI IMSI MDN MIN MSISDN	The value of the specified device identifier type.

Provisioning Category

The current service state of the device, and dates of recent service changes.

Extended Attribute Key	Extended Attribute Value Description
CreatedAt	The date and time that the device was added to the system.
LastActivationBy	The user who last activated the device.
LastActivationDate	The date and time that the device was last activated.
LastDateSuspended	The most recent date that a service suspension was started.
ResumeDate	The date that the device will auto-resume based on the suspend reason code, the account contract, and the number of days that it has already been suspended in the last 12 months.
DeviceState	The current service state of the device, which will be one of these values: Pre-active active deactive suspend pending state change name

Connectivity Category

The device's current connection and roaming status.

Extended Attribute Key	Extended Attribute Value Description
Connected	True if the device is connected; false if it is not.
IPAddress	The IP address of the device.
NetworkIdentity	The device's current base station ID.
LastConnectionDate	The most recent date and time that the device connected to the network.
LastDisconnectDate	The most recent date and time that the device disconnected from the network.
LastRoamingStatusUpdate	The date and time of the most recent RoamingStatus information.
RoamingStatus	True if the device is currently roaming.
RoamingCountry	The name of a country if RoamingStatus = true, or empty if false.
RoamingLastModifiedDate	The date and time of the most recent RoamingStatus information.

Billing Category

Information related to the device's billing cycle.

Extended Attribute Key	Extended Attribute Value Description
BillingCycleEndDate	The date and time that the device's current billing cycle ends.

Usage Category

Data and SMS usage.

Extended Attribute Key	Extended Attribute Value Description
CurrentBillCycleDataUsage	The sum of all data, in bytes, that the device sent or received since the beginning of the current bill cycle.
CurrentBillCycleSMSUsage	The sum of all SMS usage since the beginning of the current bill cycle. This number includes all SMS messages sent by the device and all acknowledged messages sent to the device.

Location Category

Device location information (subscription required).

Extended Attribute Key	Extended Attribute Value Description
LocationSkuName	The name of the service bundle for location services.
LastLocationUpdate	The last time the device was located.
Latitude	The last reported latitude of the device, in decimal degrees.
Longitude	The last reported longitude of the device, in decimal degrees.

FOTA Category

Device firmware information (subscription required).

Extended Attribute Key	Extended Attribute Value Description
FotaCurrentFirmwareVersion	The firmware version that is currently on the device.
FotaCampaignDateOccurred	The date and time of the last firmware update.
FotaSkuName	The name of the service bundle for the Software Management (FOTA) Service.

LWM2M Category

Connection quality information for LWM2M devices.

Extended Attribute Key	Extended Attribute Value Description
LinkQuality	Cellular link quality, in db.
LinkQualityDate	The date and time of the LinkQuality measurement.
RadioSignalStrength	Cellular signal strength, in dbm.
RadioSignalStrengthDate	The date and time of the RadioSignalStrength measurement.

DeviceAttributes Category

Various information about the device.

Extended Attribute Key	Extended Attribute Value Description
AccountName	The account that the device belongs to.
GroupName	The device group that the device belongs to.
MCC	Mobile Country Code, showing which country a device is registered in.
MNC	Mobile Network Code, showing which network a device is connected to.
FeatureCodes	List of numeric codes of features applied to the device.
FeatureNames	List of names of the features applied to the device.
FeatureTypes	IP address pool type and other features.
RatePlanName	The service plan that the device is assigned to.

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.DeviceService" xmlns:nph1="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
  <soapenv:Header>
    <token xmlns="http://nphase.com/unifiedwebservice/v2">c90dc3b0-fd42-4e37-ab30-e82f3cbea71c</token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:GetDeviceExtendedDiagnosticsInformation>
      <v2:Input>
        <nph:Device>
          <nph1:Kind>MDN</nph1:Kind>
          <nph1:Identifier>3124705634</nph1:Identifier>
        </nph:Device>
        <nph:AccountName>1223334444-00001</nph:AccountName>
      </v2:Input>
    </v2:GetDeviceExtendedDiagnosticsInformation>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetDeviceExtendedDiagnosticsInformationResponse 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:Device>
          <a:Categories>
            <a:Category>
              <a:CategoryName>DeviceIdentifier</a:CategoryName>
              <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
                <b:ExtendedAttributesObj>
                  <b:Key>ICCID</b:Key>
                  <b:Value>89310410106543789301</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>IMEI</b:Key>
                  <b:Value>311480188</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>IMSI</b:Key>
                  <b:Value>311480188596801</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>MDN</b:Key>
                  <b:Value>1112223333</b:Value>
                </b:ExtendedAttributesObj>
              </a:ExtendedAttributes>
            </a:Category>
            <a:Category>
              <a:CategoryName>Provisioning</a:CategoryName>
              <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
                <b:ExtendedAttributesObj>
                  <b:Key>CreatedAt</b:Key>
                  <b:Value>2018-01-01T14:26:00Z</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>LastActivationBy</b:Key>
                  <b:Value>system</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>LastActivationDate</b:Key>
                  <b:Value>2018-01-31T12:59:00Z</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>LastDateSuspended</b:Key>
                  <b:Value>2018-04-16T14:53:00Z</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>DeviceState</b:Key>
                  <b:Value>suspend</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>ResumeDate</b:Key>
                  <b:Value>2018-04-16T14:53:00Z</b:Value>
                </b:ExtendedAttributesObj>
              </a:ExtendedAttributes>
            </a:Category>
            <a:Category>
              <a:CategoryName>Connectivity</a:CategoryName>
              <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
                <b:ExtendedAttributesObj>
                  <b:Key>Connected</b:Key>
                  <b:Value>true</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>IPAddress</b:Key>
                  <b:Value>10.11.34.230</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>NetworkIdentity</b:Key>
                  <b:Value>1011</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>RoamingStatus</b:Key>
                  <b:Value>true</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>RoamingCountry</b:Key>
                  <b:Value>UK</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>LastConnectionDate</b:Key>
                  <b:Value>2018-04-16T14:53:00Z</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>LastDisconnectDate</b:Key>
                  <b:Value>2018-04-16T14:52:00Z</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>LastRoamingStatusUpdate</b:Key>
                  <b:Value>2018-04-18T11:22:00Z</b:Value>
                </b:ExtendedAttributesObj>
              </a:ExtendedAttributes>
            </a:Category>
            <a:Category>
              <a:CategoryName>Billing</a:CategoryName>
              <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
                <b:ExtendedAttributesObj>
                  <b:Key>BillingCycleEndDate</b:Key>
                  <b:Value>2018-07-04T01:00:00Z</b:Value>
                </b:ExtendedAttributesObj>
              </a:ExtendedAttributes>
            </a:Category>
            <a:Category>
              <a:CategoryName>Usage</a:CategoryName>
              <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
                <b:ExtendedAttributesObj>
                  <b:Key>CurrentBillCycleDataUsage</b:Key>
                  <b:Value>2097152</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>CurrentBillCycleSMSUsage</b:Key>
                  <b:Value>12</b:Value>
                </b:ExtendedAttributesObj>
              </a:ExtendedAttributes>
            </a:Category>
            <a:Category>
              <a:CategoryName>Location</a:CategoryName>
              <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
                <b:ExtendedAttributesObj>
                  <b:Key>LocationSkuName</b:Key>
                  <b:Value>TS-LOC-COARSE-CELLID-5K</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>LastLocationUpdate</b:Key>
                  <b:Value>2018-04-12T14:53:00Z</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>Latitude</b:Key>
                  <b:Value>-181.0</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>Longitude</b:Key>
                  <b:Value>-181.0</b:Value>
                </b:ExtendedAttributesObj>
              </a:ExtendedAttributes>
            </a:Category>
            <a:Category>
              <a:CategoryName>FOTA</a:CategoryName>
              <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
                <b:ExtendedAttributesObj>
                  <b:Key>FotaCurrentFirmwareVersion</b:Key>
                  <b:Value>testversion</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>FotaCampaignDateOccurred</b:Key>
                  <b:Value>2018-04-16T14:53:00Z</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>FotaSkuName</b:Key>
                  <b:Value>TS-HFOTA-MRC</b:Value>
                </b:ExtendedAttributesObj>
              </a:ExtendedAttributes>
            </a:Category>
            <a:Category>
              <a:CategoryName>LWM2M</a:CategoryName>
              <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
                <b:ExtendedAttributesObj>
                  <b:Key>RadioSignalStrength</b:Key>
                  <b:Value>0</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>LinkQuality</b:Key>
                  <b:Value>0</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>RadioSignalStrengthDate</b:Key>
                  <b:Value>2018-04-16T14:53:00Z</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>LinkQualityDate</b:Key>
                  <b:Value>2018-04-16T14:53:00Z</b:Value>
                </b:ExtendedAttributesObj>
              </a:ExtendedAttributes>
            </a:Category>
            <a:Category>
              <a:CategoryName>DeviceAttributes</a:CategoryName>
              <a:ExtendedAttributes xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
                <b:ExtendedAttributesObj>
                  <b:Key>AccountName</b:Key>
                  <b:Value>1223334444-00001</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>GroupName</b:Key>
                  <b:Value>Default</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>MCC</b:Key>
                  <b:Value>311</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>MNC</b:Key>
                  <b:Value>480</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>FeatureCodes</b:Key>
                  <b:Value>73584,76193</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>FeatureNames</b:Key>
                  <b:Value>73584,NP5</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>FeatureTypes</b:Key>
                  <b:Value>Private Static,NP5</b:Value>
                </b:ExtendedAttributesObj>
                <b:ExtendedAttributesObj>
                  <b:Key>RatePlanName</b:Key>
                  <b:Value>CAS10MB</b:Value>
                </b:ExtendedAttributesObj>
              </a:ExtendedAttributes>
            </a:Category>
            </a:Categories>
        </a:Device>
      </Output>
    </GetDeviceExtendedDiagnosticsInformationResponse>
  </s:Body>
</s:Envelope>