Request Select Parameters

This request requires a customized list of vehicle parameters. The information returned will be reduced fit that customization. Each parameter returned represents the last known state of that parameter obtained by the requested VOYO device.

GetSelectParameters

Returns a list of requested parameter data.

Request

curl -L -X POST 'https://{DOMAIN}/voyorequest/GetSelectParameters

-d 'serial={SERIAL}&parameters={PARAMETERS}'
-H 'Accept: application/json'
-H 'Authorization: Bearer {APIKEY}'

Parameter	Description
`serial`	VOYO Device serial number.
`parameters`	A JSON encoded array of vehicle parameters.

The following list includes all parameter data available for this request at this time:

`parameters` Option	Description
`LATITUDE`	GPS Latitude.
`LONGITUDE`	GPS Longitude.
`PDOP`	Position Dilution of Precision.
`NUM_SATELLITES`	Number of satellites GPS is currently fixed to.
`ODOMETER`	Vehicle mileage.
`SPEED`	Vehicle Speed.
`RPM`	Revolutions Per Minute.
`INSTANTANEOUS_FUEL_ECONOMY`	Liters of fuel used per second.
`MASS_AIR_FLOW`	Grams of fuel entering the engine per second.
`ENGINE_RUNNING`	Vehicle engine state.
`MANIFOLD_ABSOLUTE_PRESSURE`	Current air pressure inside the intake manifold.
`ENGINE_LOAD`	Percentage based "load" on the engine.
`KEY_POSITION`	Vehicle key position state.
`PARKING_BRAKE`	Vehicle parking brake state.
`TRANSMISSION_GEAR`	Transmission gear state.
`SHIFT_POSITION`	Vehicle shift position state.
`PROPULSION_ACTIVE`	Is this vehicle on a trip cycle?
`BATTERY_VOLTAGE`	12 Volt battery reading.
`FUEL_LEVEL`	Percentage of fuel remaining.
`OIL_PRESSURE`	Vehicle oil pressure.
`OIL_LIFE`	Percentage of oil remaining.
`FRONT_LEFT_DOOR_OPEN`	Front left door state.
`FRONT_LEFT_DOOR_LOCK`	Front left door lock state.
`FRONT_RIGHT_DOOR_OPEN`	Front right door state.
`FRONT_RIGHT_DOOR_LOCK`	Front right door lock state.
`REAR_LEFT_DOOR_OPEN`	Rear left door state.
`REAR_LEFT_DOOR_LOCK`	Rear left door lock state.
`REAR_RIGHT_DOOR_OPEN`	Rear right door state.
`REAR_RIGHT_DOOR_LOCK`	Rear right door lock state.
`TRUNK_OPEN`	Trunk state.
`HOOD_OPEN`	Hood state.
`ALARM_STATE`	Alarm state.
`HORN`	Horn state.
`GLOVE_BOX_OPEN`	Glove box state.
`HAZARDS_STATUS`	Hazard light state.
`TURN_SIGNAL`	Turn signal state.
`FOG_LIGHTS`	Fog light state.
`HEADLIGHTS`	Headlight state.
`WINDSHIELD_WIPER_STATE`	Windshield wiper state.
`INTERIOR_LIGHTS`	Interior light state.
`MIL_STATUS`	MIL status indicator state.
`FRONT_LEFT_SEAT_BUCKLED`	Front left seat belt state.
`FRONT_RIGHT_SEAT_OCCUPIED`	Front right seat occupied state.
`FRONT_RIGHT_SEAT_BUCKLED`	Front right seat belt state.
`ACCELERATOR_PEDAL_POSITION`	Percentage accelerator pedal is pressed down.
`BRAKE_PEDAL_POSITION`	Percentage brake pedal is pressed down.
`STEERING_WHEEL_ANGLE`	Steering wheel angle.
`BRAKE_PEDAL_STATE`	Brake pedal state.
`THROTTLE_POSITION`	Throttle position.
`AMBIENT_AIR_TEMPERATURE`	Ambient air temperature.
`BAROMETRIC_PRESSURE`	Barometric pressure reading.
`ENGINE_COOLANT_TEMPERATURE`	Engine coolant temperature.
`AMBIENT_LIGHT_SENSOR`	Ambient light sensor state.
`INTAKE_AIR_TEMPERATURE`	Intake air temperature.
`LEFT_FRONT_TIRE_PRESSURE`	Left front tire pressure.
`RIGHT_FRONT_TIRE_PRESSURE`	Right front tire pressure.
`LEFT_REAR_TIRE_PRESSURE`	Left rear tire pressure.
`RIGHT_REAR_TIRE_PRESSURE`	Right rear tire pressure.
`LEFT_FRONT_TIRE_TEMPERATURE`	Left front tire temperature.
`RIGHT_FRONT_TIRE_TEMPERATURE`	Right front tire temperature.
`LEFT_REAR_TIRE_TEMPERATURE`	Left rear tire temperature.
`RIGHT_REAR_TIRE_TEMPERATURE`	Right rear tire temperature.
`STABILITY`	Stability sensor state.
`TRACTION`	Traction sensor state.
`ABS`	ABS sensor state.
`AC`	Air conditioner state.
`X`	X-axis accelerometer reading.
`Y`	Y-axis accelerometer reading.
`Z`	Z-axis accelerometer reading.
`TRIP_COUNT`	Current trip number for the lifecycle of this VOYO device.
`TRIP_ACTIVE`	Is this device on an active trip?
`TRIP_DURATION`	Duration of active trip.
`TRIP_DISTANCE`	Kilometers driven in active trip.
`TRIP_STOP_TIME`	Amount of time spent stopped during active trip.
`TRIP_IFE_LITERS`	Total liters consumed during active trip.
`TRIP_MAF_KG`	Total mass air flow over course of active trip.
`MAP_RPM_SUM`	Total MAP readings over course of active trip.

Error Responses

    HTTP/1.1 400 Bad Request
    HTTP/1.1 401 Unauthorized

/// Request requires "serial"
{ "error":"Requires Device Identifier!" }
/// "serial" is not registered to provided "apikey"
{ "error":"Unauthorized Device Requested!" }
// There is no record of this device
{ "error":"Device does not exist!" }
// This request requires at least one parameter
{ "error":"Empty parameter list!" }
// Request requires "parameters"
{ "error":"No parameters provided!" }

Success Responses

"parameters" array may be empty if no parameter data is available.

{ 
    "error":"Success!", "parameters":[
        {
            "LATITUDE":"",
            "LONGITUDE":"",
            "PDOP":"",
            "NUM_SATELLITES":"",
            "ODOMETER":"",
            "SPEED":"",
            "RPM":"",
            "INSTANTANEOUS_FUEL_ECONOMY":"",
            "MASS_AIR_FLOW":"",
            "ENGINE_RUNNING":"",
            "MANIFOLD_ABSOLUTE_PRESSURE":"",
            "ENGINE_LOAD":"",
            "KEY_POSITION":"",
            "PARKING_BRAKE":"",
            "TRANSMISSION_GEAR":"",
            "SHIFT_POSITION":"",
            "PROPULSION_ACTIVE":"",
            "BATTERY_VOLTAGE":"",
            "FUEL_LEVEL":"",
            "OIL_PRESSURE":"",
            "OIL_LIFE":"",
            "FRONT_LEFT_DOOR_OPEN":"",
            "FRONT_LEFT_DOOR_LOCK":"",
            "FRONT_RIGHT_DOOR_OPEN":"",
            "FRONT_RIGHT_DOOR_LOCK":"",
            "REAR_LEFT_DOOR_OPEN":"",
            "REAR_LEFT_DOOR_LOCK":"",
            "REAR_RIGHT_DOOR_OPEN":"",
            "REAR_RIGHT_DOOR_LOCK":"",
            "TRUNK_OPEN":"",
            "HOOD_OPEN":"",
            "ALARM_STATE":"",
            "HORN":"",
            "GLOVE_BOX_OPEN":"",
            "HAZARDS_STATUS":"",
            "TURN_SIGNAL":"",
            "FOG_LIGHTS":"",
            "HEADLIGHTS":"",
            "WINDSHIELD_WIPER_STATE":"",
            "INTERIOR_LIGHTS":"",
            "MIL_STATUS":"",
            "FRONT_LEFT_SEAT_BUCKLED":"",
            "FRONT_RIGHT_SEAT_OCCUPIED":"",
            "FRONT_RIGHT_SEAT_BUCKLED":"",
            "ACCELERATOR_PEDAL_POSITION":"",
            "BRAKE_PEDAL_POSITION":"",
            "STEERING_WHEEL_ANGLE":"",
            "BRAKE_PEDAL_STATE":"",
            "THROTTLE_POSITION":"",
            "AMBIENT_AIR_TEMPERATURE":"",
            "BAROMETRIC_PRESSURE":"",
            "ENGINE_COOLANT_TEMPERATURE":"",
            "AMBIENT_LIGHT_SENSOR":"",
            "INTAKE_AIR_TEMPERATURE":"",
            "LEFT_FRONT_TIRE_PRESSURE":"",
            "RIGHT_FRONT_TIRE_PRESSURE":"",
            "LEFT_REAR_TIRE_PRESSURE":"",
            "RIGHT_REAR_TIRE_PRESSURE":"",
            "LEFT_FRONT_TIRE_TEMPERATURE":"",
            "RIGHT_FRONT_TIRE_TEMPERATURE":"",
            "LEFT_REAR_TIRE_TEMPERATURE":"",
            "RIGHT_REAR_TIRE_TEMPERATURE":"",
            "STABILITY":"",
            "TRACTION":"",
            "ABS":"",
            "AC":"",
            "X":"",
            "Y":"",
            "Z":"",
            "TRIP_COUNT":"",
            "TRIP_ACTIVE":"",
            "TRIP_DURATION":"",
            "TRIP_DISTANCE":"",
            "TRIP_STOP_TIME":"",
            "TRIP_IFE_LITERS":"",
            "TRIP_MAF_KG":"",
            "MAP_RPM_SUM":""
        }
    ]
}