SAsamsara
Maintenance

Get a single DVIR defect by ID.

Get a single DVIR defect by ID.

<b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Defects under the Maintenance category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

get/defects/{id}

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Path parameters

idstring required

The unique ID of the DVIR defect.

Query parameters

includeExternalIdsboolean

Optional boolean indicating whether to return external IDs on supported entities

Response

OK response.

commentstring required

Comment on the defect.

createdAtTimestring

Time when defect was created in RFC 3339 format.

defectSafetyStatus'safe' | 'unsafe'

Driver-designated safety classification for this defect. Valid values: safe, unsafe

defectTypeIdstring

The unique ID of the defect type.

dvirIdstring required

The unique ID of the defect's DVIR.

idstring required

The unique ID of the DVIR defect.

isResolvedboolean required

Signifies if this defect is resolved.

mechanicNotesstring

The mechanics notes on the defect.

resolvedAtTimestring

Time when this defect was resolved in RFC 3339 format. Will not be returned if the defect is unresolved.

updatedAtTimestring

Time when defect was last updated in RFC 3339 format.

Example response

{
  "comment": "Engine failure.",
  "createdAtTime": "2020-01-27T07:06:25Z",
  "defectPhotos": [
    {
      "createdAtTime": "2020-01-27T07:06:25Z",
      "url": "https://s3.samsara.com/samsara-driver-media-upload/defect-photo-path"
    }
  ],
  "defectSafetyStatus": "unsafe",
  "defectTypeId": "25d6151e-29b5-453e-875a-7c5425332e09",
  "dvirId": "292371177",
  "id": "9700544",
  "isResolved": true,
  "mechanicNotes": "Broken passenger side window.",
  "resolvedAtTime": "2020-01-27T07:06:25Z",
  "resolvedBy": {
    "id": "8172",
    "name": "Jane Mechanic",
    "type": "mechanic"
  },
  "trailer": {
    "id": "494123"
  },
  "updatedAtTime": "2020-01-27T07:06:25Z",
  "vehicle": {
    "id": "494125"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.