DataSet

A DataSet is a collection of DataPoint s taken at the same time. For example, a DataSet may contain a speed value, a battery voltage value and a GPS location. It should be assumed that the DataPoints are related and were collected at the same time. This allows you to correlate different DataPoints with each other.

Properties

Property Type Description Required for Creation
id Integer The internal system identifier for this data set. Unsupported
vin String The VIN of the vehicle the data is from Optional
deviceId String The deviceId of the device collecting the data Required
timestamp DateTime The time that the DataSet was created. Required
datum DataPoint The DataPoint s contained within this DataSet. Required
ignitionStatus String Enumeration ON OFF RUNNING The state of the vehicle when this DataSet was collected. Required

Supported Verbs

  • GET
  • POST

GET

Returns data sets for the specified vehicle. By default, the first 50 results are returned.

Query Paths

  • /vehicle/{vehicle-id}/dataSet/
  • /vehicle/{vehicle-id}/dataSet/?startTime={startTime}&endTime={endTime}

Query Parameters

Parameter Description
startTime Used for filtering the results. Only data sets that started after this time are returned. See DateTime for the format details.
endTime Used for filtering the results. Only data sets that started before this time are returned. See DateTime for the format details.

Call Options

Sortable Yes (by timestamp)
Pageable Yes

Sample JSON Response:

{
    "dataSet": [
        {
            "id": 1187922,
            "timestamp": "19991130T000000+0000",
            "datum": [
                {
                    "id": 4562158,
                    "timestamp": "19991130T000000+0000",
                    "key": "GEN_WAYPOINT",
                    "value": "0.000000,0.000000",
                    "translatedValue": "0.000000,0.000000"
                },
                {
                    "id": 4562160,
                    "timestamp": "19991130T000000+0000",
                    "key": "GEN_VOLTAGE",
                    "value": "13.9",
                    "translatedValue": "13.9V"
                },
                {
                    "id": 4562163,
                    "timestamp": "19991130T000000+0000",
                    "key": "GEN_FUELRATE",
                    "value": "0.0",
                    "translatedValue": "0.0 gph"
                }
            ]
        },
        {
            "id": 1562501,
            "timestamp": "19991130T000000+0000",
            "datum": [
                {
                    "id": 6223164,
                    "timestamp": "19991130T000000+0000",
                    "key": "GEN_WAYPOINT",
                    "value": "0.000000,0.000000",
                    "translatedValue": "0.000000,0.000000"
                },
                {
                    "id": 6223165,
                    "timestamp": "19991130T000000+0000",
                    "key": "GEN_VOLTAGE",
                    "value": "13.9",
                    "translatedValue": "13.9V"
                },
                {
                    "id": 6223167,
                    "timestamp": "19991130T000000+0000",
                    "key": "GEN_FUELLEVEL",
                    "value": "0",
                    "translatedValue": "0 %"
                }
            ]
        }
    ],
    "totalRecords": 23893,
    "actions": [
        {
            "name": "next",
            "uri": "https://api.carvoyant.com/v1/api/vehicle/C201200001/dataSet/?searchOffset=2&searchLimit=2",
            "methods": null,
            "inputs": null
        }
    ]
}

POST

Saves the data set to the specified vehicle. Note that in the production environment, this is a restricted call that only certain partners are authorized to use. If you feel you need to make calls to this endpoint, please contact us . In the sandbox environment, this is available for everyone.

Be aware that the system expects that a waypoint will be included with all DataSets that are posted to the system. It will not fail without one, but the user expects location to to be available for all recorded data points.

Query Paths

  • /vehicle/{vehicle-id}/dataSet/

Sample JSON Request:

{
   "timestamp":"20140811T140444+0000",
   "vin":"123456789ABCDEFGH",
   "deviceId":"C20120000X",
   "ignitionStatus":"ON",
   "datum":[
      {
         "timestamp":"20140811T140444+0000",
         "key":"GEN_WAYPOINT",
         "value":"28.027065,-82.588619"
      },
      {
         "timestamp":"20140811T140444+0000",
         "key":"GEN_HEADING",
         "value":323
      },
      {
         "timestamp":"20140811T140444+0000",
         "key":"GEN_VOLTAGE",
         "value":"13.6"
      }
   ]
}