APIs/Connected Vehicle API
APIs/Connected Vehicle API

Commands

Get accessibility status

Provides information if the vehicle is accessible to receive and process invocation commands together with a timestamp when it is or was accessible. If the accessible field is false, the vehicle needs to be started manually.

get

https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/command-accessibility

Scopes

  • openid

  • conve:command_accessibility

Headers

KeyDescription
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.

FieldDescription

Examples

curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/command-accessibility' \
-H 'accept: application/vnd.volvocars.api.connected-vehicle.commands.accessibility.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'

Get sent command details

Used to get the details of an sent command referenced by the request id parameter.

get

https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/requests/{id}

Scopes

  • openid

  • conve:commands

Headers

KeyDescription
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 request.

FieldDescription

Examples

curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/requests/5e62fd15-f92f-4d3a-91d2-e1432b4a52c1' \
-H 'accept: application/vnd.volvocars.api.connected-vehicle.requestdetailresponse.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'

List commands

Used to list the commands which can be sent to the vehicle. Each command can then be used in the respective endpoint. See below example response with list of commands.

get

https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/commands

Scopes

  • openid

  • conve:commands

Headers

KeyDescription
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 request.

FieldDescription

Examples

curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/commands' \
-H 'accept: application/vnd.volvocars.api.connected-vehicle.commandlist.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'

List sent commands

Used to get a list of the active and past command-requests invoked against the vehicle.

get

https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/requests/

Scopes

  • openid

  • conve:commands

Headers

KeyDescription
All these header values are mandatory. They must exist in every request.

Query parameters

ParameterDescription
The query parameters are optional values to be added in the request URL.

Response body

The response’s data node provides the details for the queried request.

FieldDescription

Examples

curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/requests?limit=50&after=2537699f-e34e-4bef-9b78-0c56a52a2234' \
-H 'accept: application/vnd.volvocars.api.connected-vehicle.requestlist.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'

Search sent commands

Used to perform an advanced search through the sent command requests.

post

https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/requests/search

Scopes

  • openid

  • conve:commands

Headers

KeyDescription
All these header values are mandatory. They must exist in every request.

Query parameters

ParameterDescription
The query parameters are optional values to be added in the request URL.

Request body

The request body data to perform the advance search.

FieldDescription

Response body

The response’s data node provides the details for the queried request.

FieldDescription

Examples

curl -v -X POST 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/requests/search?limit=50&after=2537699f-e34e-4bef-9b78-0c56a52a2234' \
-H 'content-type: application/vnd.volvocars.api.connected-vehicle.requestlist.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>' \
-d '{\"searchCommandRequest\":{\"operationId\":\"d91bc882-ab09-4cdf-95eb-1e52b43d06d6\",\"commands\":[\"FLASH\", \"ENGINE_START\"],\"startDate\":\"2021-03-16T14:12:31.802Z\",\"endDate\":\"2021-03-16T14:12:31.802Z\",\"ids\":[\"5e62fd15-f92f-4d3a-91d2-e1432b4a52c1\"]}}'

Body

{
  "searchCommandRequest": {
    "operationId": "d91bc882-ab09-4cdf-95eb-1e52b43d06d6",
    "commands": ["FLASH", "ENGINE_START"],
    "startDate": "2021-01-16T14:12:31Z",
    "endDate": "2021-03-16T14:12:31Z",
    "ids": ["5e62fd15-f92f-4d3a-91d2-e1432b4a52c1"]
  }
}

Commands/Get accessibility status