GET Vehicle/CollectionSettings/{id}

Get information about vehicle data collection settings.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

VehicleID

string

Required

Body Parameters

None.

Response Information

Resource Description

VehicleCollectionSettings
NameDescriptionTypeAdditional information
VehicleID

integer

None.

id

integer

None.

vehicle_id

integer

None.

vin

string

None.

display_name

string

None.

option_codes

string

None.

color

string

None.

tokens

string

None.

state

string

None.

id_s

string

None.

remote_start_enabled

boolean

None.

calendar_enabled

boolean

None.

notifications_enabled

boolean

None.

backseat_token

string

None.

backseat_token_updated_at

string

None.

InsertDate

date

None.

UserID

integer

None.

NextGeneralCheck

date

None.

NextLocationCheck

date

None.

VehicleCollectionStatus

byte

None.

VehicleGeneralIntervalSec

integer

None.

LastUpdate

date

None.

isLocationStreaming

byte

None.

LocationStreamingEnabaled

byte

None.

PerfWindowMinutes

integer

None.

SleepTimeMS

integer

None.

SleepOverride

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "VehicleID": 1,
  "id": 2,
  "vehicle_id": 3,
  "vin": "sample string 4",
  "display_name": "sample string 5",
  "option_codes": "sample string 6",
  "color": "sample string 7",
  "tokens": "sample string 8",
  "state": "sample string 9",
  "id_s": "sample string 10",
  "remote_start_enabled": true,
  "calendar_enabled": true,
  "notifications_enabled": true,
  "backseat_token": "sample string 14",
  "backseat_token_updated_at": "sample string 15",
  "InsertDate": "2018-10-15T06:12:33.6943088-07:00",
  "UserID": 17,
  "NextGeneralCheck": "2018-10-15T06:12:33.6943088-07:00",
  "NextLocationCheck": "2018-10-15T06:12:33.6943088-07:00",
  "VehicleCollectionStatus": 64,
  "VehicleGeneralIntervalSec": 21,
  "LastUpdate": "2018-10-15T06:12:33.6943088-07:00",
  "isLocationStreaming": 64,
  "LocationStreamingEnabaled": 64,
  "PerfWindowMinutes": 25,
  "SleepTimeMS": 26,
  "SleepOverride": 27
}

application/xml, text/xml

Sample:
<VehicleCollectionSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CreatorsAPI.Models">
  <InsertDate>2018-10-15T06:12:33.6943088-07:00</InsertDate>
  <LastUpdate>2018-10-15T06:12:33.6943088-07:00</LastUpdate>
  <LocationStreamingEnabaled>64</LocationStreamingEnabaled>
  <NextGeneralCheck>2018-10-15T06:12:33.6943088-07:00</NextGeneralCheck>
  <NextLocationCheck>2018-10-15T06:12:33.6943088-07:00</NextLocationCheck>
  <PerfWindowMinutes>25</PerfWindowMinutes>
  <SleepOverride>27</SleepOverride>
  <SleepTimeMS>26</SleepTimeMS>
  <UserID>17</UserID>
  <VehicleCollectionStatus>64</VehicleCollectionStatus>
  <VehicleGeneralIntervalSec>21</VehicleGeneralIntervalSec>
  <VehicleID>1</VehicleID>
  <backseat_token>sample string 14</backseat_token>
  <backseat_token_updated_at>sample string 15</backseat_token_updated_at>
  <calendar_enabled>true</calendar_enabled>
  <color>sample string 7</color>
  <display_name>sample string 5</display_name>
  <id>2</id>
  <id_s>sample string 10</id_s>
  <isLocationStreaming>64</isLocationStreaming>
  <notifications_enabled>true</notifications_enabled>
  <option_codes>sample string 6</option_codes>
  <remote_start_enabled>true</remote_start_enabled>
  <state>sample string 9</state>
  <tokens>sample string 8</tokens>
  <vehicle_id>3</vehicle_id>
  <vin>sample string 4</vin>
</VehicleCollectionSettings>