Settings

Setting	Description
Automate Intervals	When a Vehicle is created Service Intervals will be automatically created.
User Defined Intervals	Use custom Service Intervals instead of generic.
Automate Intervals On Initial Odometer	A Vehicle can be created without an odometer value. If this setting is enabled, updating a Vehicle without an odometer value to a valid odometer value will allow Service Intervals to be automatically created.

User Defined Intervals should be used in conjunction with Automate Intervals to automatically generate custom Service Intervals.

GetSettings

Get a list of account settings and their current state. Settings will be returned as enabled (1) or disabled (0).

Request

Please note that this is a GET request and not a POST request.

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

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

Example Response

Enabled	Disabled
1	0

{ 
    "error":"Success!", "automate_intervals":"", "user_defined_intervals":"", "automate_intervals_on_initial_odometer":""
}

UpdateSettings

Update account settings.

Request

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

-d 'automate_intervals={AUTOMATE_INTERVALS}&user_defined_intervals={USER_DEFINED_INTERVALS}'
-H 'Accept: application/json'
-H 'Authorization: Bearer {APIKEY}'

Parameter	Description	Requirement
automate_intervals	When a Vehicle is created Service Intervals will be automatically created.	Optional
user_defined_intervals	Use custom Service Intervals instead of generic.	Optional
automate_intervals_on_initial_odometer	If enabled, allows Service Intervals are generated on Update Vehicle.	Optional

While each setting is optional, at least one is required.

Error Responses

    HTTP/1.1 400 Bad Request

// Settings are expected to be enabled (1) or disabled (0)
{"error":"Automate intervals is outside of valid range!"}
{"error":"User defined intervals is outside of valid range!"}

// Update attempted with no setting to change
{"error":"Requires at least one setting to be changed!"}

Success Responses

Settings updated successfully.

{"error":"Success!"}