ScanPro

ScanPro is a Voyomotive branded real-time scan of the connected vehicle's Controllers.

ScanPro

Get a current list of Controllers and any DTCs found on those Controllers.

Request

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

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

Parameter	Description
serial	Unique device identifier.

Error Responses

    HTTP/1.1 400 Bad Request

// Requested a {SERIAL} that is not connected to the provided `APIKEY`:
{ "error":"Serial {SERIAL} does not exist!" }

// Requested a {SERIAL} that has yet to connect to the server to report any DTCs:
{ "error":"Device with serial {SERIAL} has no configuration!" }

// VOYO has been moved to a vehicle with a VIN that does not match current scan on the server:
{ "error":"This scan belongs to a previous vehicle!" }

Success Responses

controllers may be empty if no Controllers respond and dtcs may be empty if no DTCs were found on the Controller.

{
    "success":"",
    "validity":"",
    "vin":"",
    "make":"",
    "model":"",
    "year":"",
    "name":"",
    "odometer":"",
    "scan_time":"",
    "total_codes":"",
    "controllers":[
        {
            "address":"",
            "request_id":"",
            "name":"",
            "response":"",
            "bus":"",
            "show":"",
            "dtcs":[]
        },
        {
            "address":"",
            "request_id":"",
            "name":""
            ,"response":"",
            "bus":"",
            "show":"",
            "dtcs":[
                {
                    "id":"",
                    "first_reported":"",
                    "last_reported":"",
                    "address":"",
                    "request_id":"",
                    "bus":"",
                    "raw_code":"",
                    "symptom":"",
                    "response":"",
                    "active":"",
                    "pending":"",
                    "history":"",
                    "light":"",
                    "advanced":"",
                    "name":"",
                    "short":"",
                    "long":"",
                    "severity":""
                }
            ]
        }
    ]
}

Parameter	Description
success	1: Request was successful, 0: Request was unsuccessful.
vin	Vehicle Identification Number.
make	Vehicle make.
model	Vehicle model.
year	Vehicle model year.
name	User defined name for this VOYO device (defaults to "year model").
odometer	Odometer reading in Kilometers.
scan_time	Unix timestamp for the time of this scan.
total_codes	Number of DTCs across every Controller requested.
controllers	Array of requests Controllers.

Controllers

Parameter	Description
address	Location of information as an integer.
request_id	Controller identifier. Integer representation of Controller name.
name	Name of requested Controller.
response	"No": Controller did not respond to request. "Invalid": Controller reported the request was bad. "Negative": A failed request. "Positive": A successful request.
bus	Name of requested vehicle bus.
show	Boolean representation to determine if the Controller responded positively.
dtcs	An array of DTCs reported by this Controller

DTCs

Parameter	Description
id	Identifier representing this specific DTC.
first_reported	Unix timestamp for when this DTC was first reported to the server.
last_reported	Unix timestamp representing when this DTC was last reported to the server.
address	Controller source.
request_id	Controller identifier.
bus	Name of bus Controller was requested on.
raw_code	Integer representation of this DTC.
symptom	Symptom byte.
response	Controller response validity.
active	This DTC is currently active.
pending	This DTC is currently pending.
history	This DTC is being kept historically.
light	MIL indicator status as boolean.
advanced	Boolean indicating if a request was made to a Controller other than the engine Controller.
name	String representation of this DTC.
short	Short description of the DTC.
long	Longer and more detailed description of the DTC.
severity	Severity of the DTC, the larger the value, the more critical.