Engine
Get engine status
Vehicle’s latest engine status value.
get
https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/engine-status
Scopes
openid
conve:engine_status
Headers
| Key | Description |
Key accept | Description The mediatype of what should be returned. The valid values are: application/vnd.volvocars.api.connected-vehicle.vehicledata.v1+json |
Key authorization | Description The access token issued by Volvo ID identity system. |
Key vcc-api-key | Description Your application’s VCC API Key. |
All these header values are mandatory. They must exist in every request.Response body
The response’s data node provides the details for the queried vehicle data.
| Field | Description |
Field engineRunning.value | Description The latest retrieved engine-status value. Possible values: RUNNING, STOPPED. |
Field engineRunning.timestamp | Description Timestamp in ISO-8601 format when the value has been last retrieved from the vehicle. |
Examples
curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/engine-status' \
-H 'accept: application/vnd.volvocars.api.connected-vehicle.vehicledata.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'Start engine
Breaking changes planned. This endpoint will be replaced in the next version.
Command used to start the engine of the vehicle.
post
https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/commands/engine-start
Scopes
openid
conve:engine_start_stop
Headers
| Key | Description |
Key content-type | Description The mediatype of what should be returned. The valid values are: application/vnd.volvocars.api.connected-vehicle.enginestart.v1+json |
Key authorization | Description The access token issued by Volvo ID identity system. |
Key vcc-api-key | Description Your application’s VCC API Key. |
All these header values are mandatory. They must exist in every request.Request body
The request body data needed to perform the invocation command is runtimeMinutes. This is the time in minutes engine will be running. Is required for engine start and can maximum be set to 15 minutes.
Response body
The response’s data node provides the details for the queried request.
| Field | Description |
Field status | Description Response status code. |
Field operationId | Description Id to log and track the request. |
Field async.status | Description Status of the request sent to the car. Possible values: RUNNING, WAITING, COMPLETED, REJECTED, UNKNOWN, TIMEOUT, CONNECTION_FAILURE, VEHICLE_IN_SLEEP, UNLOCK_TIME_FRAME_PASSED, UNABLE_TO_LOCK_DOOR_OPEN. |
Field async.id | Description Request id. |
Field async.href | Description URL of the request to see the details and status of the command. |
Field async.expires | Description The expiry date for getting the details about the request. The invocation log is stored for one year. |
Examples
curl -v -X POST 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/commands/engine-start' \
-H 'content-type: application/vnd.volvocars.api.connected-vehicle.enginestart.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>' \
-d '{\"runtimeMinutes\":10}'Body
{
"runtimeMinutes": 10
}Stop engine
Breaking changes planned. This endpoint will be replaced in the next version.
Command used to stop the engine of the vehicle.
post
https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/commands/engine-stop
Scopes
openid
conve:engine_start_stop
Headers
| Key | Description |
Key content-type | Description The mediatype of what should be returned. The valid values are: application/vnd.volvocars.api.connected-vehicle.enginestop.v1+json |
Key authorization | Description The access token issued by Volvo ID identity system. |
Key vcc-api-key | Description Your application’s VCC API Key. |
All these header values are mandatory. They must exist in every request.Request body
The request body data needed to perform the invocation command is NONE.
Response body
The response’s data node provides the details for the queried request.
| Field | Description |
Field status | Description Response status code. |
Field operationId | Description Id to log and track the request. |
Field async.status | Description Status of the request sent to the car. Possible values: RUNNING, WAITING, COMPLETED, REJECTED, UNKNOWN, TIMEOUT, CONNECTION_FAILURE, VEHICLE_IN_SLEEP, UNLOCK_TIME_FRAME_PASSED, UNABLE_TO_LOCK_DOOR_OPEN. |
Field async.id | Description Request id. |
Field async.href | Description URL of the request to see the details and status of the command. |
Field async.expires | Description The expiry date for getting the details about the request. The invocation log is stored for one year. |
Examples
curl -v -X POST 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/commands/engine-stop' \
-H 'content-type: application/vnd.volvocars.api.connected-vehicle.enginestop.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>' \
-d ''