Device Experience - Bulk Latest

POST /v1/intelligence/device-experience/bulk/latest

Run a report to view the latest device experience score for specific devices.

Contents

See also:

Request Components

Header Parameters

The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit  Getting Started.

Parameter Name Data Type Description
Authorization
required		 string

HTTP Authorization bearer token:
Authorization: Bearer {token}
VZ-M2M-Token
required		 string

A valid session token:
VZ-M2M-Token: {M2Mtoken}
Content-Type
required		 string

Must be application/json:
Content-Type: application/json

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/intelligence/device-experience/bulk/latest

Request Parameters

All parameters are required unless marked "optional".

Parameter Data Type Description
accountName
 string The numeric name of the account, including leading zeros.

deviceList

 object

A list of individual device identifiers to query.
   id
 string The numeric value of the device ID type.
   kind
 string

The type of device ID represented by the ID value. Only the following are supported by the request and both values must be present:

  • iccid - Integrated circuit card ID (SIM card)
  • eid - Electronic ID, a 32-digit unique ID of the device
  • imei - International Mobile Equipment Identifier 
  • mdn - Mobile Device Number (a 10-digit phone number)

Request Body

Example request:

{
  "accountName": "0000123456-00001",
  "deviceList":[
      {
         "id":"10-digit MDN",
         "kind":"mdn"
      },
      {
         "id":"20-digit ICCID",
         "kind":"iccId"
      },
      {
         "id":"15-digit IMEI",
         "kind":"imei"
      },
      {
         "id":"20-digit ICCID",
         "kind":"iccId"
      },
      {
         "id":"32-digit EID",
         "kind":"eid"
      }
   ]
}

Success Response

Status 200

A successful response shows a system generated request ID to track the request.

Example Response:

{
  "requestId": "d1f08526-5443-4054-9a29-4456490ea9f8"
}

Callback Response

These endpoints send responses asynchronously. In order to read the results a callback is required.To learn more about callbacks, please visit About Callback Services. The callback service to subscribe to is IntelligenceService.

Example callback response:

{
  "username" : "the user's login information",
  "password" : "the user's password",
  "requestId": "d1f08526-5443-4054-9a29-4456490ea9f8",
  "intelligenceResponse": {
    "deviceExperienceScoreBulk": {
      "deviceExperienceScores": [
        {
          "device": [
            {
              "id": "20-digit ICCID",
              "kind": "ICCID"
            }
          ],
          "date": "2022-07-06",
          "averageScore": "50",
          "status" : "SUCCESS",
          "reason" : "Device Data Found"
         },
        {
          "device": [
            {
              "id": "10-digit phone number",
              "kind": "MDN"
            }
          ],
          "date": "2022-07-06",
          "averageScore": "50",
          "status" : "SUCCESS",
          "reason" : "Device Data Found"
         }
      ]
    }
  },
  "status": "SUCCESS",
  "callbackCount": 1,
  "maxCallbackThreshold": 4
}

Callback Parameters

Parameter Data Type Description
username string The user's login information.
password object The user's password.
requestId string The requestId being viewed. This is a system generated value from the request above.
intelligenceResponse object Contains the response details of the request.
   deviceExperienceScoreBulk  object

Contains the details of network service history.
      device array Device identifier objects responding to the query.
         id
 string The numeric value of the device ID type.
         kind
 string

The type of device ID represented by the ID value:

  • ICCID - Integrated circuit card ID (SIM card)
  • EID - Electronic ID, a 32-digit unique ID of the device
  • IMEI - International Mobile Equipment Identifier
  • MDN - Mobile Device Number (a 10-digit phone number) 
      scores array A list of date and score objects for the 30 day period queried.
           date string Year, month and day of the 24-hour period recorded.
           averageScore string A score assigned, out of 100, for that 24-hour period.
           status string

Status of the device's reply. This will be either:

  • SUCCESS
  • FAILED
           reason string Additional information about the status.
status string The status of the intelligenceResponse..
callbackCount string The number of responses for intelligenceResponse found.
maxCallbackThreshold string The maximum number of responses for intelligenceResponse allowed.

Failure Responses

All error responses will be in the following format

{
  "errorCode": "The 3-digit HTML error code",
  "errorMessage": "string"
}