GetDeviceDiagnosticsInformation

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

NOTE: This method has been deprecated and may be removed. The newer version is GetDeviceExtendedDiagnosticsInformation.

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. Must be MDN.
Device.Identifier
required
string The device's MDN.

Response Parameters

Parameter Type Description
Device Device object The diagnostics information about the device.
Device.DeviceIdentifiers DeviceIdentifier array Array of one or more identifiers for the device.
Device.DeviceIdentifiers.DeviceIdentifier Kind and Identifier An identifiers for the device.
Device.DeviceIdentifiers.DeviceIdentifier.Kind string The type of the device identifier. Valid types of identifiers are:

  • ESN (decimal)
  • EID
  • ICCID (up to 20 digits)
  • IMEI (up to 15 digits)
  • MDN
  • MEID (hexadecimal)
  • MIN
  • MSISDN
Device.DeviceIdentifiers.DeviceIdentifier.Identifier string The value of the device identifier.
Device.Attributes DeviceAttributes object Information about the device.
Device.Attributes.AccountName string The account that the device belongs to.
Device.Attributes.SkuNumber string The SKU of the device.
Device.Attributes.MCC string Mobile Country Code, showing which country a device is registered in.
Device.Attributes.MNC string Mobile Network Code, showing which network a device is connected to.
Device.Attributes.DeviceGroupName string The device group that the device belongs to.
Device.Attributes.ServicePlan string The service plan that the device is assigned to.
Device.Provisioning ProvisioningInfo object Information about the device's line of service.
Device.Provisioning.CreatedAt dateTime The date and time that the device was added to the system.
Device.Provisioning.State string The current state of the device, which will be one of these values:
  • Pre-active
  • active
  • deactive
  • suspend
  • pending state change name
Device.Provisioning.LastActivationBy string The user who last activated the device.
Device.Provisioning.LastActivationDate datetime The date and time that the device was last activated.
Device.Connectivity ConnectivityInfo object Information about the device's network connectivity.
Device.Connectivity.Connected Boolean True if the device is connected; false if it is not.
Device.Connectivity.IPAddress string The IP address of the device.
Device.Connectivity.LastConnectionDate datetime The most recent connection date and time.
Device.Connectivity.LastDisconnectDate datetime The date and time of the last disconnect.
Device.Connectivity.LastRoamingStatusUpdate datetime The date and time of the most recent RoamingStatus information.
Device.Connectivity.RoamingStatus Boolean True if the device is currently roaming.
Device.Connectivity.NetworkIdentity string The device's current base station ID.
Device.Billing BillingInfo object Billing information.
Device.Billing.BillingCycleEndDate datetime The date and time that the device's current billing cycle ends.
Device.Usage UsageInfo object Data and SMS usage information.
Device.Usage.CurrentBillCycleDataUsage string The sum of all data, in bytes, that the device sent or received since the beginning of the current bill cycle.
Device.Usage.CurrentBillCycleSMSUsage string 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.
Device.Location LocationInfo object Device location information (subscription required).
Device.Location.locationSkuName string The name of the service bundle for location services.
Device.Location.lastLocationUpdate string The last time the device was located.
Device.Location.latitude string The last reported latitude of the device, in decimal degrees.
Device.Location.longitude string The last reported longitude of the device, in decimal degrees.
Device.Fota FOTAInfo object Device firmware information (subscription required).
Device.Fota.fotaMakeAndModel string The device make and model, for firmware management purposes.
Device.Fota.fotaCurrentFirmwareVersion string The firmware version that is currently on the device.
Device.Fota.fotaCampaignDateOccurred string The date and time of the last firmware update.

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:GetDeviceDiagnosticsInformation>
      <v2:Input>
        <nph:Device>
          <nph1:Kind>MDN</nph1:Kind>
          <nph1:Identifier>3124705634</nph1:Identifier>
        </nph:Device>
        <nph:AccountName>Verizon Test 1</nph:AccountName>
      </v2:Input>
    </v2:GetDeviceDiagnosticsInformation>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetDeviceDiagnosticsInformationResponse 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:DeviceIdentifiers xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
            <b:DeviceIdentifier>
              <b:Kind>ICCID</b:Kind>
              <b:Identifier>89310410106543789103</b:Identifier>
            </b:DeviceIdentifier>
            <b:DeviceIdentifier>
              <b:Kind>IMSI</b:Kind>
              <b:Identifier>311480188596108</b:Identifier>
            </b:DeviceIdentifier>
            <b:DeviceIdentifier>
              <b:Kind>MDN</b:Kind>
              <b:Identifier>3124705634</b:Identifier>
            </b:DeviceIdentifier>
          </a:DeviceIdentifiers>
          <a:Attributes>
            <a:AccountName>1223334444-00001</a:AccountName>
            <a:SkuNumber>sk001</a:SkuNumber>
            <a:MCC>311</a:MCC>
            <a:MNC>480</a:MNC>
            <a:DeviceGroupName>defg</a:DeviceGroupName>
            <a:ServicePlan>M2MRatePlan</a:ServicePlan>
          </a:Attributes>
          <a:Provisioning>
            <a:CreatedAt>2013-04-12T20:20:03Z</a:CreatedAt>
            <a:State>active</a:State>
            <a:LastActivationBy>system</a:LastActivationBy>
            <a:LastActivationDate>2018-04-11T01:00:00Z</a:LastActivationDate>
          </a:Provisioning>
          <a:Connectivity>
            <a:Connected>true</a:Connected>
            <a:IPAddress>10.11.34.230</a:IPAddress>
            <a:LastConnectionDate>2018-04-11T14:53:00Z</a:LastConnectionDate>
            <a:LastDisconnectDate>2017-08-11T14:52:58Z</a:LastDisconnectDate>
            <a:LastRoamingStatusUpdate i:nil="true"/>
            <a:RoamingStatus>true</a:RoamingStatus>
            <a:NetworkIdentity>1011</a:NetworkIdentity>
            <a:RoamingCountry i:nil="true"/>
          </a:Connectivity>
          <a:Billing>
            <a:BillingCycleEndDate>2017-11-10T01:00:00Z</a:BillingCycleEndDate>
          </a:Billing>
          <a:Usage>
            <a:CurrentBillCycleDataUsage>917981249536</a:CurrentBillCycleDataUsage>
            <a:CurrentBillCycleSMSUsage>1009</a:CurrentBillCycleSMSUsage>
          </a:Usage>
          <a:Location>
            <a:locationSkuName>TS-BUNDLE-COARSE-CELLID-5K-ECPD</a:locationSkuName>
            <a:lastLocationUpdate>2019-01-04T05:28:20Z</a:lastLocationUpdate>
            <a:latitude>37.66174</a:latitude>
            <a:longitude>-122.4264</a:longitude>
          </a:Location>
          <a:Fota>
            <a:fotaMakeAndModel>Verizon Model-A</a:fotaMakeAndModel>
            <a:fotaCurrentFirmwareVersion>VerizonFirmwareVersion-01</a:fotaCurrentFirmwareVersion>
            <a:fotaCampaignDateOccurred>2018-12-20T18:09:02.000Z</a:fotaCampaignDateOccurred>
          </a:Fota>
        </a:Device>
      </Output>
    </GetDeviceDiagnosticsInformationResponse>
  </s:Body>
</s:Envelope>