Scopes - Volteras

Introduction

When building an integration on top of the Volteras platform, you may only want specific information, or capabilities from the end-user account that will be connected. You can achieve this using the scopes parameter when constructing the account connect url.

Vehicle Scopes

Scopes available

Scope	Description
vehicle:all	Access to everything
vehicle:information	Access to VIN, registration plate, specifications, options, range, state of health and listening history
vehicle:telemetry	Access to telemetry (such as location, odometer, state of charge and tire pressure), journeys, services and manufacturer alerts
vehicle:charging_history	Access to charging history, departure times and charging windows
vehicle:commands	Access to remote commands

scopes is required when generating the account connect URL, and must contain at least one scope. Scopes are chosen per account connection. Vehicles connected by VIN, through the Connect Vehicles endpoint or the Volteras Portal, are given vehicle:all.

Scoped endpoints

These are vehicle endpoints where scopes are used to determine whether you have access to data, or whether you can perform a remote action. An account with vehicle:all has access to all of them.

Endpoint	Scope	Required	Effect when scope is not present
GET /vehicles/	vehicle:information		These fields are excluded: vin, registrationPlate
GET /vehicles/[id]	vehicle:information		These fields are excluded: vin, registrationPlate
POST /vehicles/[id]/registration-plate	vehicle:information	Yes	401 Response
GET /vehicles/[id]/options	vehicle:information	Yes	401 Response
GET /vehicles/[id]/specifications	vehicle:information	Yes	401 Response
GET /vehicles/[id]/range	vehicle:information	Yes	401 Response
GET /vehicles/[id]/state-of-health	vehicle:information	Yes	401 Response
GET /vehicles/[id]/listening-audit	vehicle:information	Yes	401 Response
GET /vehicles/[id]/telemetry	vehicle:telemetry	Yes	401 Response
GET /vehicles/[id]/journeys	vehicle:telemetry	Yes	401 Response
GET /vehicles/[id]/maintenance/services	vehicle:telemetry	Yes	401 Response
GET /vehicles/[id]/maintenance/tires/historic	vehicle:telemetry	Yes	401 Response
GET /vehicles/[id]/maintenance/manufacturer-alerts/current	vehicle:telemetry	Yes	401 Response
GET /vehicles/[id]/charging-history	vehicle:charging_history	Yes	401 Response
GET /vehicles/[id]/charging-history/[id]	vehicle:charging_history	Yes	401 Response
GET /vehicles/[id]/departure-times	vehicle:charging_history	Yes	401 Response
GET /vehicles/[id]/charging-windows	vehicle:charging_history	Yes	401 Response
GET /vehicles/[id]/command-executions/	vehicle:commands	Yes	401 Response
GET /vehicles/[id]/command-executions/[id]	vehicle:commands	Yes	401 Response
POST /vehicles/[id]/command-execution:[command]	vehicle:commands	Yes	401 Response

The other vehicle endpoints, such as alerts, listening, connection and eligibility, do not require a scope.