Get Device Extended Diagnostic Information

Get Extended Diagnostic Information about a Device:
POST /devices/extendeddiagnostics/actions/list

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

Contents

See also:
Get Device Information

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/devices/extendeddiagnostics/actions/list

Resource and Query Parameters

None.

Header Parameters

The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.

Parameter Name Data Type Description
Authorization
required
string HTTP Authorization bearer token.
VZ-M2M-Token
required
string A valid session token returned by POST /session/login.
Content-Type
required
string Must be application/json.

Request Body

Specify the account name and device ID in the body of the request.

Parameter Name Data 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.
deviceList
required
deviceId object The device for which you want diagnostic information, specified by the device’s MDN.
deviceList.kind
required for deviceList
string The type of the device identifier. Must be MDN.
deviceList.id
required for deviceList
string The device’s MDN.

Example Request Body

{
  "accountName": "1223334444-00001",
  "deviceList": [
    {
      "id": "7746853630",
      "kind": "mdn"
    }
  ]
}

Success Responses

Status 200

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 as key-value pairs.

DeviceIdentifier Category

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.
RoamingStatus True if the device is currently roaming.
RoamingCountry The name of a country if RoamingStatus = true, or empty if false.
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.

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 the Device Location Service.
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.
FotaSku 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.
BundleSku The name of the service bundle that the device is enrolled in.
DeviceMake The device manufacturer.
DeviceModel The device model name.
DeviceSku The SKU of the device model.
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.
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.
RatePlanName The service plan that the device is assigned to.

Example Success Response

{
  "categories":[
    {
      "categoryName":"DeviceIdentifier",
      "extendedAttributes":[
        {
          "key":"ICCID",
          "value":"10515037247935438481"
        },
        {
          "key":"IMEI",
          "value":"105150324867352"
        },
        {
          "key":"IMSI",
          "value":"311480144568312"
        },
        {
          "key":"MDN",
          "value":"7746853630"
        },
        {
          "key":"MIN",
          "value":"7746853630"
        },
        {
          "key":"MSISDN",
          "value":"17746853630"
        }
      ]
    },
    {
      "categoryName":"DeviceAttributes",
      "extendedAttributes":[
        {
          "key":"AccountName",
          "value":"1223334444-00001"
        },
        {
          "key":"GroupName",
          "value":"Default"
        },
        {
          "key":"MCC",
          "value":"311"
        },
        {
          "key":"MNC",
          "value":"480"
        },
        {
          "key":"FeatureCodes",
          "value":"73584,76193"
        },
        {
          "key":"FeatureNames",
          "value":"73584,NP5"
        },
        {
          "key":"FeatureTypes",
          "value":"Private Static,NP5"
        },
        {
          "key":"RatePlanName",
          "value":"CAS10MB"
        }
      ]
    },
    {
      "categoryName":"Provisioning",
      "extendedAttributes":[
        {
          "key":"LastActivationBy",
          "value":"Vutukuri, Raghavenderrvqa4"
        },
        {
          "key":"LastActivationDate",
          "value":"2018-08-17T18:55:34Z"
        },
        {
          "key":"CreatedAt",
          "value":"2018-08-17T18:55:28Z"
        },
        {
          "key":"LastDateSuspended",
          "value":"2018-08-21T00:00:00Z"
        },
        {
          "key":"DeviceState",
          "value":"active"
        },
        {
          "key":"ResumeDate",
          "value":"2018-08-21T00:00:00Z"
        }
      ]
    },
    {
      "categoryName":"Connectivity",
      "extendedAttributes":[
        {
          "key":"Connected",
          "value":"false"
        },
        {
          "key":"LastConnectionDate",
          "value":"2018-09-17T19:38:43Z"
        },
        {
          "key":"IPAddress",
          "value":"16.3.20.98"
        },
        {
          "key":"LastDisconnectDate",
          "value":"2018-09-17T19:38:54Z"
        },
        {
          "key":"NetworkIdentity",
          "value":"11dd2ab4156"
        }
      ]
    },
    {
      "categoryName":"Billing",
      "extendedAttributes":[
        {
          "key":"BillingCycleEndDate",
          "value":"2019-01-14T00:00:00Z"
        }
      ]
    },
    {
      "categoryName":"Usage",
      "extendedAttributes":[
        {
          "key":"CurrentBillCycleDataUsage",
          "value":"2097152"
        },
        {
          "key":"CurrentBillCycleSMSUsage",
          "value":"10"
        }
      ]
    },
    {
      "categoryName":"Location",
      "extendedAttributes":[
        {
          "key":"LocationSkuName",
          "value":"TS-LOC-COARSE-CELLID-5K"
        }
      ]
    },
    {
      "categoryName":"FOTA",
      "extendedAttributes":[
        {
          "key":"FotaSku",
          "value":"TS-HFOTA-MRC"
        }
      ]
    },
    {
      "categoryName":"LWM2M",
      "extendedAttributes":[
        {
          "key":"RadioSignalStrength",
          "value":"0"
        },
        {
          "key":"LinkQuality",
          "value":"0"
        }
      ]
    }
  ]
}

Failure Responses

Status 400

All error messages are returned in this format:

{
  "errorCode": "error code string",
  "errorMessage": "error message string"
}

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.

Try It Out!