Powered by Redocly

Diagnostic equipment

Diagnostic equipment represents a device that is used to diagnose or repair a vehicle.

Diagnostic equipment

A diagnostic equipment represents a device that is used to diagnose or repair a vehicle.

id
integer <int64>

Diagnostic Equipment identifier.

available
boolean

Whether the provider has this diagnostic equipment available for use.

local_connector_numbers
Array of numbers <int32> >= 0 items

List of local connnector numbers to which the diagnostic equipment is connected.

name
string [ 1 .. 255 ] characters

Name of the diagnistic equipment tool.

version
string or null [ 1 .. 255 ] characters

Version of the diagnostic equipment.

{
  • "id": 121,
  • "available": true,
  • "local_connector_numbers": [
    ],
  • "name": "iCarsoft CR Pro",
  • "version": "2.0"
}

Retrieve all diagnostic equipment

Retrieve a list of all diagnostic equipment.

SecurityOAuth2
Request
query Parameters
available
boolean

Filter diagnostic equipment by availability.

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

Successful response.

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 (Diagnostic equipment) >= 0 items

List of diagnostic equipment.

Array (>= 0 items)
id
integer <int64>

Diagnostic Equipment identifier.

available
boolean

Whether the provider has this diagnostic equipment available for use.

local_connector_numbers
Array of numbers <int32> >= 0 items

List of local connnector numbers to which the diagnostic equipment is connected.

name
string [ 1 .. 255 ] characters

Name of the diagnistic equipment tool.

version
string or null [ 1 .. 255 ] characters

Version of the diagnostic equipment.

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/providers/diagnostic-equipment
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Retrieve a diagnostic equipment.

Retrieve a single diagnostic equipment by its identifier.

SecurityOAuth2
Request
path Parameters
diagnostic-equipment-id
required
integer <int64>

Diagnostic equipment identifier.

Responses
200

Successful response.

Response Schema: application/json
id
integer <int64>

Diagnostic Equipment identifier.

available
boolean

Whether the provider has this diagnostic equipment available for use.

local_connector_numbers
Array of numbers <int32> >= 0 items

List of local connnector numbers to which the diagnostic equipment is connected.

name
string [ 1 .. 255 ] characters

Name of the diagnistic equipment tool.

version
string or null [ 1 .. 255 ] characters

Version of the diagnostic equipment.

default

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

get/v2/providers/diagnostic-equipment/{diagnostic-equipment-id}
Response samples
application/json
{
  • "id": 121,
  • "available": true,
  • "local_connector_numbers": [
    ],
  • "name": "iCarsoft CR Pro",
  • "version": "2.0"
}

Update a diagnostic equipment

Update a single diagnostic equipment by its identifier.

SecurityOAuth2
Request
path Parameters
diagnostic-equipment-id
required
integer <int64>

Diagnostic equipment identifier.

Request Body schema: application/json
available
boolean

Whether the provider has this diagnostic equipment available for use.

local_connector_numbers
Array of numbers <int32> >= 0 items

List of local connnector numbers to which the diagnostic equipment is connected.

Responses
200

Successful response.

Response Schema: application/json
id
integer <int64>

Diagnostic Equipment identifier.

available
boolean

Whether the provider has this diagnostic equipment available for use.

local_connector_numbers
Array of numbers <int32> >= 0 items

List of local connnector numbers to which the diagnostic equipment is connected.

name
string [ 1 .. 255 ] characters

Name of the diagnistic equipment tool.

version
string or null [ 1 .. 255 ] characters

Version of the diagnostic equipment.

default

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

put/v2/providers/diagnostic-equipment/{diagnostic-equipment-id}
Request samples
application/json
{
  • "available": true,
  • "local_connector_numbers": [
    ]
}
Response samples
application/json
{
  • "id": 121,
  • "available": true,
  • "local_connector_numbers": [
    ],
  • "name": "iCarsoft CR Pro",
  • "version": "2.0"
}
➔ Next to Local connectors