SAsamsara
Maintenance

Get a single DVIR by ID.

Get a single DVIR 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 DVIRs 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/dvirs/{id}

Request

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

Path parameters

idstring required

Id of the DVIR.

Query parameters

includeExternalIdsboolean

Optional boolean indicating whether to return external IDs on supported entities

Response

OK response.

defectIdsstring[]

IDs of defects registered for the DVIR.

dvirSubmissionBeginTimestring required

Time when driver created DVIR. UTC timestamp in RFC 3339 format.

dvirSubmissionTimestring required

Time when driver submitted the DVIR. UTC timestamp in RFC 3339 format.

formattedAddressstring
idstring required

The unique id of the DVIR

mechanicNotesstring

The mechanics notes on the DVIR.

odometerMetersinteger

The odometer reading in meters.

safetyStatus'unknown' | 'safe' | 'unsafe' | 'resolved'

The condition of vehicle on which DVIR was done. Valid values: unknown, safe, unsafe, resolved

type'preTrip' | 'postTrip' | 'mechanic' | 'unspecified' required

Inspection type of the DVIR. Valid values: preTrip, postTrip, mechanic, unspecified

updatedAtTimestring required

Time of any DVIR updates. UTC timestamp in RFC 3339 format.

Example response

{
  "authorSignature": {
    "signatoryUser": {
      "id": "938172"
    },
    "signedAtTime": "2020-01-27T07:06:25Z",
    "type": "driver"
  },
  "defectIds": [
    "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596",
    "25d6151e-29b5-453e-875a-7c5425332e09"
  ],
  "dvirSubmissionBeginTime": "2020-01-27T07:06:25Z",
  "dvirSubmissionTime": "2020-01-27T07:06:25Z",
  "formattedAddress": "350 Rhode Island St Ste. 400S, San Francisco, CA 94103",
  "id": "12345",
  "mechanicNotes": "Replaced headlight on passenger side.",
  "odometerMeters": 91823,
  "safetyStatus": "unsafe",
  "secondSignature": {
    "signatoryUser": {
      "id": "938172"
    },
    "signedAtTime": "2020-01-27T07:06:25Z",
    "type": "driver"
  },
  "thirdSignature": {
    "signatoryUser": {
      "id": "938172"
    },
    "signedAtTime": "2020-01-27T07:06:25Z",
    "type": "driver"
  },
  "trailer": {
    "id": "494123"
  },
  "type": "mechanic",
  "updatedAtTime": "2020-01-27T07:06:25Z",
  "vehicle": {
    "id": "494123"
  },
  "walkaroundPhotos": [
    {
      "createdAtTime": "2020-01-27T07:06:25Z",
      "name": "Name 1",
      "url": "https://s3.samsara.com/samsara-driver-media-upload/walkaround-photo-path"
    }
  ]
}

Changes

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