OTA Updates API Data

This section provides details on the API’s JSON objects, which report available CP codes and details on completed downloads by vehicles. The response data provided associates downloaded files with vehicles, along with the CP codes provisioning the download traffic.

The data schema tables below list membership requirements as follows:

Member is required to be present, regardless of whether the value is empty or null.
Member is optional, and may be omitted in some cases.

Schemas

NotificationList

Encapsulates a collection of download notifications, with additional pagination context.

Sample GET response:

{
  "notifications": [
    {
      "cpcode": 100001,
      "downloadTime": "2017-05-16T17:30:01+00:00",
      "uid": "0000-0000-0001",
      "host": "downloads.automotive-company.com",
      "path": "/files/0001"
    },
    {
      "cpcode": 100001,
      "downloadTime": "2017-05-16T17:33:02+00:00",
      "uid": "0000-0000-0002",
      "host": "downloads.automotive-company.com",
      "path":"/files/0002"
    }
  ],
  "nextPageStart": 1497627402001
}

NotificationList Members

Member Type Required Description
nextPageStart Integer The timestamp in milliseconds that indicates the start of the next page of notifications.
notifications NotificationList.notifications[n] Encapsulates each download notification.

NotificationList.notifications[n]  

Encapsulates each download notification.

Member Type Required Description
cpcode Integer The content provider code under which traffic is billed.
downloadTime String The date and time of a download event on a Ghost server.
host String The host of a downloaded file.
path String The path of a downloaded file.
uid String The unique identifier of a vehicle.

CpCode

Specifies a content provider code.

Sample GET respone:

[
  {
    "id": 100001,
    "name": "cp code 100001"
  },
  {
    "id": 100002,
    "name": "cp code 100002"
  }
]

CpCode Members

Member Type Required Description
id Integer The identifier of the content provider code.
name String The name of the content provider code.

Last modified: 8/28/2017