Skip to main content
POST
/
v3
/
vehicle-inspections
Create a new vehicle inspection
curl --request POST \
  --url https://api.ctrl-hub.com/v3/vehicle-inspections \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "type": "<string>",
    "attributes": {
      "inspected_at": "2023-11-07T05:31:56Z",
      "checks": {
        "visible_damage": true,
        "tyres": true,
        "washers_and_wipers": true,
        "windscreen": true,
        "number_plate": true,
        "security": true,
        "accessories": true,
        "spare_number_plate": true,
        "safe_access": true,
        "reversing_alarm": true,
        "beacons": true,
        "chemicals_and_fuel": true,
        "storage": true,
        "lights_and_indicators": true,
        "engine_warning_lights": true,
        "servicing": true,
        "levels": true,
        "cleanliness": true,
        "driver_checks": true
      },
      "comments": {
        "visible_damage": "<string>",
        "tyres": "<string>",
        "washers_and_wipers": "<string>",
        "windscreen": "<string>",
        "number_plate": "<string>",
        "security": "<string>",
        "accessories": "<string>",
        "spare_number_plate": "<string>",
        "safe_access": "<string>",
        "reversing_alarm": "<string>",
        "beacons": "<string>",
        "chemicals_and_fuel": "<string>",
        "storage": "<string>",
        "lights_and_indicators": "<string>",
        "engine_warning_lights": "<string>",
        "servicing": "<string>",
        "levels": "<string>",
        "cleanliness": "<string>",
        "driver_checks": "<string>"
      }
    },
    "relationships": {
      "organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "vehicle": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "inspected_at": "2023-11-07T05:31:56Z",
      "checks": {
        "visible_damage": true,
        "tyres": true,
        "washers_and_wipers": true,
        "windscreen": true,
        "number_plate": true,
        "security": true,
        "accessories": true,
        "spare_number_plate": true,
        "safe_access": true,
        "reversing_alarm": true,
        "beacons": true,
        "chemicals_and_fuel": true,
        "storage": true,
        "lights_and_indicators": true,
        "engine_warning_lights": true,
        "servicing": true,
        "levels": true,
        "cleanliness": true,
        "driver_checks": true
      },
      "comments": {
        "visible_damage": "<string>",
        "tyres": "<string>",
        "washers_and_wipers": "<string>",
        "windscreen": "<string>",
        "number_plate": "<string>",
        "security": "<string>",
        "accessories": "<string>",
        "spare_number_plate": "<string>",
        "safe_access": "<string>",
        "reversing_alarm": "<string>",
        "beacons": "<string>",
        "chemicals_and_fuel": "<string>",
        "storage": "<string>",
        "lights_and_indicators": "<string>",
        "engine_warning_lights": "<string>",
        "servicing": "<string>",
        "levels": "<string>",
        "cleanliness": "<string>",
        "driver_checks": "<string>"
      }
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "passed": 123,
      "failed": 123,
      "not_applicable": 123
    },
    "relationships": {
      "organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "vehicle": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "author": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "slug": "<string>",
        "sandbox": true,
        "description": "<string>",
        "settings": {}
      },
      "meta": {
        "v3": true,
        "status": "active",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "features": [
          {
            "name": "<string>",
            "enabled": true,
            "limit": 123
          }
        ]
      },
      "relationships": {
        "users": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "service_accounts": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "groups": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "teams": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "nomenclature": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Body

application/vnd.api+json

The vehicle inspection to create.

data
object
required

Response

Get a vehicle inspection.

JSON API response object

data
object
required

A vehicle inspection

jsonapi
object
required
included
object[]

Related resources that can be included when a vehicle inspection is returned.

An organisation