Account Information

These API requests are meant to configure the account holder's information.

GetFunctionality

Full API functionality may not be available by default. Use this request to get a feature list detailing which other API requests can and can not be used.

Request

curl -L -X GET 'https://{DOMAIN}/voyorequest/GetFunctionality

-H 'Accept: application/json'
-H 'Authorization: Bearer {APIKEY}'

Error Response

    HTTP/1.1 400 Bad Request

// Request header was not created properly
{"error":"Malformed Request!"}

Success Response

When this request is successful it will return a list of API requests, by name, and an associated value of "1" if the request is available, and "0" if the request is unavailable.

    {
        "error":"Success!",
        //
        "AddUser":"",
        "CreateUser":"",
        "DeleteUser":"",
        "GetUsers":"",
        "RemoveUser":"",
        "UpdateUser":"",
        //
        "AddVehicle":"",
        "CreateVehicle":"",
        "DeleteVehicle":"",
        "GetVehicles":"",
        "RemoveVehicle":"",
        "UpdateVehicle":"",
        //
        "CreateAlert":"",
        "GetAlerts":"",
        "UpdateAlert":"",
        //
        "UpdateInfo":"",
        "UploadIcon":"",
        //
        "ScanPro":"",
        "GetDevices":"",
        "ParameterData":"",
        "GetEmissionsTestResults":"",
        "GetDTCFreezeFrames":"",
        "GetSupportedFeatures":"",
        "GetBatteryHealth":"",
        "GetVOYOLinkEvents":"",
        //
        "CreateServiceInterval":"",
        "GenerateServiceIntervals":"",
        "GetAllServiceIntervals":"",
        "GetServiceIntervals":"",
        "RemoveServiceInterval":"",
        "UpdateServiceInterval":"",
        //
        "GetSettings":"",
        "UpdateSettings":"",
        //
        "CreateServiceIntervalSetting":"",
        "GetServiceIntervalSettings":"",
        "RemoveServiceIntervalSettings":"",
        "UpdateServiceIntervalSettings":"",
        //
        "CreateShop":"",
        "GetShops":"",
        "OnboardShop":"",
        "OffboardShop":"",
        "UpdateShop":""
    }

UpdateInfo

Update information used to describe your account:
1. Company name
2. Display name
3. Descriptive text
4. Integration notes
5. Service category

Parameters may be updated individually or in any combination.

Request

All parameters are optional, but at least one must be provided to execute an update.

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

-d 'company={COMPANY}&name={NAME}&description={DESCRIPTION}&integration={INTEGRATION}&category={CATEGORY}'
-H 'Accept: application/json'
-H 'Authorization: Bearer {APIKEY}'

Parameter	Description	Max Size
company	Name of the company this account belongs to.	250
name	Name of this account.	250
description	Description of what this account is used for.	65535
integration	Description of how this account is integrated with your company.	65535
category	The category of service this account falls under.	50

Error Responses

    HTTP/1.1 400 Bad Request

// Must provide at least one parameter
{"error":"Requires something to update!"}

Success Responses

Account information was updated successfully.

{"error":"Success!"}

UploadIcon

Upload an image that will service as your account avatar.

This endpoint accepts .jpg, .jpeg, .webp, or .png formats, and enforces size and type restrictions.

Request

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

-d 'icon={ICON}'
-H 'Authorization: Bearer {APIKEY}'

Parameter	Description
icon	Image file to upload; must be .jpg, .jpeg, .webp, or .png format.

Error Responses

    HTTP/1.1 400 Bad Request

// Image must be less than 1 mb
{"error":"File is too large!"}

// Improper file format provided
{"error":"Requires image to be 'jpeg', 'png, or 'webp' format!"}

// Image failed sanity check
{"error":"Requires a valid image file!"}

// "icon" not included in post request
{"error":"Requires 'icon' to be uploaded!"}

Success Responses

The provided icon was uploaded successfully.

{"error":"Success!"}