BIbigchange
Vehicles

Get a vehicle defect

Changed on

Retrieves full detail of a single vehicle defect, including resolution history and attachment references (required scope vehicles:read)

get/v1/vehicles/defects/{defectId}

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/vehicles/defects/{defectId}
  • Auth
    HTTP bearer

Path parameters

defectIdinteger required
Example:5514123

The unique identifier of the defect to retrieve

Headers

Customer-Idinteger required

The customer identifier

Response

OK

defectIdinteger

The unique identifier of the defect

vehicleIdinteger

The unique identifier of the vehicle the defect was reported against

vehicleGroupIdinteger nullable

The unique identifier of the vehicle group that the vehicle belongs to

reportedByResourceIdinteger nullable

The unique identifier of the resource who reported the defect

severitystring

The severity of the defect

categorystring

The category of the defect

descriptionstring

The description of the defect

resolvedByResourceIdinteger nullable

The current status of the defect

resolutionNotesstring nullable

Notes describing how the defect was resolved

occurredAtstring date-time

The UTC timestamp of when the defect occurred

resolvedAtstring date-time nullable

The UTC timestamp of when the defect was resolved

createdAtstring date-time

The UTC timestamp of when this defect was created

updatedAtstring date-time

The UTC timestamp of when this defect was last updated

Example response

{
  "defectId": 5514123,
  "vehicleId": 1211,
  "vehicleGroupId": 4521,
  "reportedByResourceId": 1211,
  "severity": "High",
  "category": "Tyres",
  "description": "Front nearside tyre worn below legal limit",
  "resolutionNotes": "Tyre replaced",
  "occurredAt": "2022-11-29T16:50:16.0000000+00:00",
  "resolvedAt": "2022-11-29T16:50:16.0000000+00:00",
  "createdAt": "2022-11-29T16:50:16.0000000+00:00",
  "updatedAt": "2022-11-29T16:50:16.0000000+00:00",
  "attachments": [
    {
      "attachmentId": 5514123,
      "fileName": "defect-photo.jpg",
      "url": "https://api.bigchange.com/v1/attachments/5514123"
    }
  ]
}

Changes