Powered by Redocly

Sessions

openOBD sessions are sessions that can be created to automate diagnostic routines using gRPC. The session allows direct communication with a vehicle, as well as interacting with the vehicle side technician through a user interface. A newly created session will have to be activated through gRPC before communication is possible. More information on openOBD and the available gRPC calls can be found at https://docs.openobd.com.

Session

A session object provides information about the current state of an openOBD session.

id
string <uuid>

Identifier referencing this specific openOBD session.

authentication_token
string

Token required to be passed to the gRPC endpoint to activate the openOBD session. One time use only.

created_at
string <date-time>

Time when the session was created.

grpc_endpoint
string <uri>

Endpoint to communicate to when using gRPC.

state
string

The current state of the openOBD session.

Enum Value Description
available

A new openOBD session has been started and is ready for authentication.

active

The openOBD session has been authenticated and can be used to make gRPC calls.

interrupted

The openOBD session has been forcibly stopped by an API call.

finished

The openOBD session has been gracefully ended by a gRPC call.

failed

The openOBD session has been stopped due to an internal error.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authentication_token": "string",
  • "created_at": "2019-08-24T14:15:22.651+0000",
  • "grpc_endpoint": "http://example.com",
  • "state": "available"
}

Get sessions

Get a list of openOBD sessions.

SecurityOAuth2
Request
query Parameters
limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

Responses
200

Retrieved all sessions.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Session) >= 0 items

List of sessions.

Array (>= 0 items)
id
string <uuid>

Identifier referencing this specific openOBD session.

authentication_token
string

Token required to be passed to the gRPC endpoint to activate the openOBD session. One time use only.

created_at
string <date-time>

Time when the session was created.

grpc_endpoint
string <uri>

Endpoint to communicate to when using gRPC.

state
string

The current state of the openOBD session.

Enum Value Description
available

A new openOBD session has been started and is ready for authentication.

active

The openOBD session has been authenticated and can be used to make gRPC calls.

interrupted

The openOBD session has been forcibly stopped by an API call.

finished

The openOBD session has been gracefully ended by a gRPC call.

failed

The openOBD session has been stopped due to an internal error.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/open-obd/sessions
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 4
}

Get session

Get info on an openOBD session.

SecurityOAuth2
Request
path Parameters
session-id
required
string <uuid>

The identifier of the session.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Identifier referencing this specific openOBD session.

authentication_token
string

Token required to be passed to the gRPC endpoint to activate the openOBD session. One time use only.

created_at
string <date-time>

Time when the session was created.

grpc_endpoint
string <uri>

Endpoint to communicate to when using gRPC.

state
string

The current state of the openOBD session.

Enum Value Description
available

A new openOBD session has been started and is ready for authentication.

active

The openOBD session has been authenticated and can be used to make gRPC calls.

interrupted

The openOBD session has been forcibly stopped by an API call.

finished

The openOBD session has been gracefully ended by a gRPC call.

failed

The openOBD session has been stopped due to an internal error.

default

An error occurred - see status code and problem response for more information.

get/v2/open-obd/sessions/{session-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authentication_token": "string",
  • "created_at": "2019-08-24T14:15:22.651+0000",
  • "grpc_endpoint": "http://example.com",
  • "state": "available"
}

Interrupt a session

Interrupt an openOBD session.

SecurityOAuth2
Request
path Parameters
session-id
required
string <uuid>

The identifier of the session.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Identifier referencing this specific openOBD session.

authentication_token
string

Token required to be passed to the gRPC endpoint to activate the openOBD session. One time use only.

created_at
string <date-time>

Time when the session was created.

grpc_endpoint
string <uri>

Endpoint to communicate to when using gRPC.

state
string

The current state of the openOBD session.

Enum Value Description
available

A new openOBD session has been started and is ready for authentication.

active

The openOBD session has been authenticated and can be used to make gRPC calls.

interrupted

The openOBD session has been forcibly stopped by an API call.

finished

The openOBD session has been gracefully ended by a gRPC call.

failed

The openOBD session has been stopped due to an internal error.

default

An error occurred - see status code and problem response for more information.

delete/v2/open-obd/sessions/{session-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "authentication_token": "string",
  • "created_at": "2019-08-24T14:15:22.651+0000",
  • "grpc_endpoint": "http://example.com",
  • "state": "available"
}
➔ Next to Odometer registrations