BIbigchange
Vehicles

Get defects for a vehicle

Changed on

Retrieve a paged collection of defects for a specific vehicle (required scope vehicles:read)

get/v1/vehicles/{vehicleId}/defects

Request

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

Path parameters

vehicleIdinteger required
Example:678

The unique identifier of the vehicle

Query parameters

status'open' | 'inProgress' | 'closed'

Status of a vehicle defect<p>Possible values:</p><ul><li><b>open</b>: Defect is open</li><li><b>inProgress</b>: Defect is in progress</li><li><b>closed</b>: Defect has been closed</li></ul>

Example:open

Filter by defect status

reportedFromstring date-time
Example:2024-01-01T00:00:00.0000000+00:00

Filter defects reported on or after this date (YYYY-MM-DD format)

reportedTostring date-time
Example:2024-12-31T00:00:00.0000000+00:00

Filter defects reported on or before this date (YYYY-MM-DD format)

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "defectId": 12345,
      "vehicleId": 678,
      "reportedByResourceId": 42,
      "category": "Engine",
      "description": "Oil leak detected under engine",
      "status": "open",
      "occurredAt": "2024-01-15T10:30:00.0000000+00:00",
      "createdAt": "2024-01-15T11:00:00.0000000+00:00"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}

Changes