Powered by Redocly

Local connectors

Local connectors are used to connect diagnostic equipment to the Jifeline network.

Local Connector

A local connector is a device used by a provider to connect diagnostic equipment to the Jifeline network.

id
string <uuid>

Local connector identifier.

label
string [ 1 .. 255 ] characters

Description of the local connector.

number
number <int32>

Human-readable connector identifier.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "label": "Marcel's local",
  • "number": 124
}

Retrieve all local connectors

Retrieve a list of local connectors.

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

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

List of local connectors.

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

Local connector identifier.

label
string [ 1 .. 255 ] characters

Description of the local connector.

number
number <int32>

Human-readable connector identifier.

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

Retrieve a local connector

Retrieve a local connector by its identifier.

SecurityOAuth2
Request
path Parameters
local-connector-id
required
string <uuid>

Local connector identifier.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Local connector identifier.

label
string [ 1 .. 255 ] characters

Description of the local connector.

number
number <int32>

Human-readable connector identifier.

default

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

get/v2/providers/local-connectors/{local-connector-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "label": "Marcel's local",
  • "number": 124
}
➔ Next to Employees