Trip Inspection

Retrieve a single trip inspection

Retrieves information for a trip inspection by its id

get/v2/tripInspections/{id}

Request

  • Base URL: https://api.onswitchboard.com
  • URL: https://api.onswitchboard.com/v2/tripInspections/{id}
  • Auth: API key in header x-api-id and API key in header x-api-key

Path parameters

idstring required

The trip inspection id to perform the operation on

Query parameters

debug'true' | 'false'

Enable debug logging for development

Response

Successfully performed operation

idstring

Unique identifier for the trip inspection record

type1 | 2 | 3 required

Type of inspection: 1 = Pre-trip, 2 = Post-trip, 3 = CTPAT

dateTimestring date-time required

Date and time when the inspection was performed

notesstring

Additional notes about the inspection

Example response

{
  "id": "2ntvSpRGIK",
  "type": 1,
  "dateTime": "2023-01-15T10:30:00Z",
  "driver": {
    "id": "abc123",
    "name": "John Doe"
  },
  "vehicle": {
    "id": "veh123",
    "unitId": "101"
  },
  "trailerFirst": {
    "id": "trail123",
    "unitId": "201"
  },
  "trailerSecond": {
    "id": "trail456",
    "unitId": "202"
  },
  "defects": [
    {
      "typeDescription": "Brake system defect",
      "equipment": "vehicle",
      "severity": 1,
      "description": "Brake pads need replacement",
      "fixedNotes": "Replaced brake pads",
      "vehicleUnitId": "101"
    }
  ],
  "notes": "Inspection completed successfully"
}

Changes

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