Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
569 lines (507 sloc) 20.2 KB

This API is used to retrieve all car related information, the format is:

GET http://52.28.33.220:3000/vehicle/v2/{vin}

Parameter Type Required Read only Description

Vehicle identification

vin

String

True

Yes

Vehicle identification number

wmi

String

False

Yes

World Manufacture Identifier

iccid

String

False

Yes

Integrated Circuit Card Identifier

imsi

String

False

Yes

International Mobile Subscriber Identity

tcusn

String

False

Yes

TCU Serial Number

vehicleType

String

False

Yes

Vehicle type

brand

String

False

Yes

Vehicle brand

model

String

False

Yes

Vehicle model

description

String

False

Yes

Model name description

year

Integer

False

Yes

Vehicle model year

deliveryMileage

Long

False

Yes

Odometer at delivery

deliveryDate

Date

False

Yes

Sale date (retail)

licenseNumber

String

False

Yes

License plate number

transmissionNumber

String

False

Yes

Transmission serial number

engineNumber

String

False

Yes

Serial number of the engine

ignitionKeyNumber

String

False

Yes

Vehicle ignition key number

doorKeyNumber

String

False

Yes

Door key number

category

String

True

Yes

Sedan, SUV, a???|

owner

String

True

Yes

Owner ID

ownerType

String

True

Yes

Owner Type: subscriber, dealer, oem

Vehicle configuration

doors

Integer

False

Yes

Number of doors

interiorColor

{array}

False

Yes

Vehicle interior colors

interiorColor.colorCode

String

True

Yes

Color code

interiorColor.colorName

String

False

Yes

Color description

exteriorColor

{array}

False

Yes

Vehicle exterior colors

exteriorColor.colorCode

String

True

Yes

Color code

exteriorColor.colorName

String

False

Yes

Color description

transmissionType

String

False

Yes

Vehicle transmission type

weight

Float

False

Yes

Vehicle weight

options

{array}

False

Yes

Vehicle options (array of attribute: value)

Vehicle status

speed

Integer

False

No

Vehicle speed (KM/h or MP/h

averageSpeed

Integer

False

No

Estimated average speed in KM/h

rpm

Integer

False

No

Engine RPM 10X1000.

fuel_usage

Integer

False

No

Fuel level as a percentage of fullness

oil_life

Integer

False

No

Remaining engine oil as percentage of fullness

oil_pressure

Integer

False

No

Engine Oil Pressure in PSi

Vehicle climate control

airflow_direction

String

False

No

Airflow direction: "frontpanel", "floorduct", "bilevel", "defrostfloor"

fan_speed_level

Integer

False

No

Fan speed of the air flowing (0: off, 1: weakest ~ 10: strongest )

target_temperature

Integer

False

No

Desired temperature(in degrees Celsius)

air_conditioning

Boolean

False

No

Air conditioning system T/F

heater_state

Boolean

False

No

Heating system T/F

seat_heater_state

Integer

False

No

Seat warmer (0: off, 1: least warm ~ 10: warmest)

seat_cooler_state

Integer

False

No

Seat ventilation (0: off, 1: least warm ~ 10: warmest)

air_recirculation

Boolean

False

No

Air recirculation. (True : on, False : pulling in outside air)

steeringWheelHeater

Integer

False

No

Steering wheel heater (0: off, 1: least warm ~ 10: warmest)

front_left_window_lock_status

Boolean

False

No

Whether or not the window is locked T/F

front_right_window_lock_status

Boolean

False

No

Whether or not the window is locked T/F

rear_right_window_lock_status

Boolean

False

No

Whether or not the window is locked T/F

rear_left_window_lock_status

Boolean

False

No

Whether or not the window is locked T/F

front_right_window_openness

Integer

False

No

Side window as a percentage of openness. (0:Closed, 100:Fully Opened)

rear_left_window_openness

Integer

False

No

Side window as a percentage of openness. (0:Closed, 100:Fully Opened)

rear_right_window_openness

Integer

False

No

Side window as a percentage of openness. (0:Closed, 100:Fully Opened)

front_left_window_openness

Integer

False

No

Side window as a percentage of openness. (0:Closed, 100:Fully Opened)

Driving safety

driver_door_state

String

False

No

Door status enum: "open", "ajar", "close"

hood_door_state

String

False

No

Door status enum: "open", "ajar", "close"

rear_left_door_state

String

False

No

Door status enum: "open", "ajar", "close"

fuel_door_state

String

False

No

Door status enum: "open", "ajar", "close"

trunk_door_state

String

False

No

Door status enum: "open", "ajar", "close"

passenger_door_state

String

False

No

Door status enum: "open", "ajar", "close"

rear_right_door_state

String

False

No

Door status enum: "open", "ajar", "close"

rear_right_door_lock_state

Boolean

False

No

Whether or not the door is locked T/F

rear_left_door_lock_state

Boolean

False

No

Whether or not the door is locked T/F

driver_door_lock_state

Boolean

False

No

Whether or not the door is locked T/F

hood_door_lock_state

Boolean

False

No

Whether or not the door is locked T/F

passenger_door_lock_state

Boolean

False

No

Whether or not the door is locked T/F

fuel_door_lock_state

Boolean

False

No

Whether or not the door is locked T/F

trunk_door_lock_state

Boolean

False

No

Whether or not the door is locked T/F

airbags

String

False

Yes

The state of airebag OK/Failure

Sample: Get http://52.28.33.220/ericsson/vehicle/v2/12345678