Powered by Redocly

Providers

Providers describe organisations that perform services on vehicles. You are one of these, but there are others available that could support you in your business.

Provider

id
string <uuid>

Provider identifier.

name
string [ 1 .. 255 ] characters

Name of the provider.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Remote Diagnostics Provider"
}

Retrieve all providers

Retrieve a list of providers.

SecurityApiKey and OAuth2
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

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

List of providers.

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

Provider identifier.

name
string [ 1 .. 255 ] characters

Name of the provider.

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

Retrieve provider

Retrieve a provider by its identifier.

SecurityApiKey and OAuth2
Request
path Parameters
provider-id
required
string <uuid>

Provider identifier.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Provider identifier.

name
string [ 1 .. 255 ] characters

Name of the provider.

default

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

get/v2/providers/providers/{provider-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Remote Diagnostics Provider"
}

Retrieve authenticated provider

Obtain the currently authenticated provider.

SecurityApiKey and OAuth2
Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Provider identifier.

name
string [ 1 .. 255 ] characters

Name of the provider.

default

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

get/v2/providers/providers/me
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Remote Diagnostics Provider"
}
➔ Next to Diagnostic equipment