Used diagnostic equipment

Diagnostic equipment used on a ticket.

Used diagnostic equipment

Used diagnostic Equipment represent diagnostic equipment that is used by an operator to diagnose or repair a vehicle.

ticket_id	string <uuid> Identifier of the ticket.
diagnostic_equipment_id	integer <int32> Identifier of diagnostic equipment.
name	string [ 0 .. 255 ] characters Name of the diagnostic equipment.
version	string or null [ 1 .. 255 ] characters Version of the diagnostic equipment.

{"ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
"diagnostic_equipment_id": 12,
"name": "iCarsoft CR Pro",
"version": "2.0"
}

Retrieve all used diagnostic equipment [BETA]

Retrieve a list of diagnostic equipment that has been used by an operator on a ticket.

SecurityOAuth2 and ApiKey

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.
ticket_id	string <uuid> The identifier of the ticket of which you want to retrieve the used diagnostic equipment.

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

List of used diagnostic equipment.

Array (>= 0 items)

ticket_id	string <uuid> Identifier of the ticket.
diagnostic_equipment_id	integer <int32> Identifier of diagnostic equipment.
name	string [ 0 .. 255 ] characters Name of the diagnostic equipment.
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/tickets/used-diagnostic-equipment

Response samples

200
default

application/json

{"query": {"limit": 25,
"offset": 0
},
"result": [{"ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
"diagnostic_equipment_id": 12,
"name": "iCarsoft CR Pro",
"version": "2.0"
}
],
"total": 3255
}

Add used diagnostic equipment [BETA]

Add diagnostic equipment that has been used by an operator on a ticket. Diagnostic equipment can only be added on a 'In Progress' ticket.

SecurityApiKey and OAuth2

Request

Request Body schema: application/json
required

The diagnostic equipment that has been used.

ticket_id	string <uuid> Identifier of the ticket.
diagnostic_equipment_id	integer <int32> Identifier of diagnostic equipment.

Responses

201

Created.

Response Schema: application/json

ticket_id	string <uuid> Identifier of the ticket.
diagnostic_equipment_id	integer <int32> Identifier of diagnostic equipment.
name	string [ 0 .. 255 ] characters Name of the diagnostic equipment.
version	string or null [ 1 .. 255 ] characters Version of the diagnostic equipment.

400

Bad request.

default

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

post/v2/tickets/used-diagnostic-equipment

Request samples

Payload

application/json

{"ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
"diagnostic_equipment_id": 12
}

Response samples

201
400
default

application/json

{"ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
"diagnostic_equipment_id": 12,
"name": "iCarsoft CR Pro",
"version": "2.0"
}

Retrieve a used diagnostic equipment [BETA]

Retrieve a used diagnostic equipment by its identifiers.

SecurityOAuth2 and ApiKey

Request

path Parameters

ticket-id required	string <uuid> Ticket on which the diagnostic equipment was used.
diagnostic-equipment-id required	integer <int32> Used Diagnostic Equipment identifier.

Responses

200

Successful response.

Response Schema: application/json

ticket_id	string <uuid> Identifier of the ticket.
diagnostic_equipment_id	integer <int32> Identifier of diagnostic equipment.
name	string [ 0 .. 255 ] characters Name of the diagnostic equipment.
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/tickets/used-diagnostic-equipment/{ticket-id}/{diagnostic-equipment-id}

Response samples

200
default

application/json

{"ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
"diagnostic_equipment_id": 12,
"name": "iCarsoft CR Pro",
"version": "2.0"
}

Remove used diagnostic equipment [BETA]

Remove diagnostic equipment that has been used by an operator on a ticket. Diagnostic equipment can only be removed from a 'In Progress' ticket.

SecurityApiKey and OAuth2

Request

path Parameters

ticket-id required	string <uuid> Ticket on which the diagnostic equipment was used.
diagnostic-equipment-id required	integer <int32> Used Diagnostic Equipment identifier.

Responses

204

Successfully removed.

default

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

delete/v2/tickets/used-diagnostic-equipment/{ticket-id}/{diagnostic-equipment-id}

Response samples

default

application/problem+json

Returned when the request cannot be handled due to something that is perceived to be a client error.

{"detail": "The request violates one or more constraints. Please resolve all of them and try again.",
"status": 400,
"title": "Bad request",
"type": "/problems/violations",
"violations": [{"property_path": "gross_price.amount",
"in": "body",
"detail": "Value must be greater than 0"
},
{"property_path": "provider_id",
"in": "query",
"detail": "Provider with ID 3445 does not exist."
}
]
}

➔ Next to Service Center

Used diagnostic equipment