Vehicles

List all vehicles

get

Authorizations

Query parameters

pageintegerOptional

A page number within the paginated result set.

Responses

200

Get successful

application/json

get

HTTPcURLJavaScriptPython

GET /api/v4/vehicles/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*

200

Get successful

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 928,
      "carrier": 928,
      "category": "tipper_cereal",
      "license_plate": "WE749RM",
      "fleet_number": "TRUCK120",
      "remote_id": "tr123type1",
      "created": "2020-07-30T21:10:06.44551Z",
      "used_for_qualimat_transports": true,
      "telematic_vehicle": 1,
      "original": 40,
      "tags": [
        {
          "pk": 23498,
          "name": "Remorque"
        }
      ],
      "technical_control_deadline": "2020-12-22T15:31:39.26167Z",
      "tachograph_deadline": "2020-12-22T15:31:39.26167Z",
      "speed_limiter_deadline": "2020-12-22T15:31:39.26167Z",
      "country": "FR",
      "unavailability": [
        {
          "id": 928,
          "remote_id": "tr123type1",
          "created": "2020-07-30T21:10:06.44551Z",
          "start_date": "2020-07-30T21:10:06.44551Z",
          "end_date": "2020-07-30T21:10:06.44551Z",
          "unavailability_type": "paid_vacation",
          "unavailability_note": "I'm on vacation"
        }
      ],
      "events": [
        {}
      ]
    }
  ]
}

Create a vehicle

post

Adds a vehicle in the requester's company fleet

Authorizations

Body

remote_idstringOptional

The ID of the vehicle in your system.

Example: tr123type1

fleet_numberstring · max: 10Optional

Your vehicle fleet number. It has to be unique among all your vehicles. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.

Example: TRUCK120

license_platestring · max: 200Optional

License plate number (has to be unique)

Example: WE749RM

categorystring · enum · max: 200Optional

Vehicle category

Possible values:

used_for_qualimat_transportsbooleanOptional

True if the vehicle can be used for Qualimat transport (only used for vehicle that can handle a load without trailer). This value is used to add a Qualimat logo next to the vehicle in forms, in order to help the user selecting the vehicle when creating a transport. The is no control on the value. You can create a Qualimat transport with a vehicle that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.

telematic_data_sourcestring · enumOptional

The telematic where the vehicle is refered

Example: webfleetPossible values:

vendor_idstringOptional

ID of the vehicle in the telematics system

Responses

201

Create successful

application/json

post

HTTPcURLJavaScriptPython

POST /api/v4/vehicles/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "remote_id": "tr123type1",
  "fleet_number": "TRUCK120",
  "license_plate": "WE749RM",
  "category": "unknown",
  "used_for_qualimat_transports": true,
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ],
  "telematic_data_source": "webfleet",
  "vendor_id": "text"
}

201

Create successful

{
  "pk": 928,
  "carrier": 928,
  "category": "tipper_cereal",
  "license_plate": "WE749RM",
  "fleet_number": "TRUCK120",
  "remote_id": "tr123type1",
  "created": "2020-07-30T21:10:06.44551Z",
  "used_for_qualimat_transports": true,
  "telematic_vehicle": 1,
  "original": 40,
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ],
  "technical_control_deadline": "2020-12-22T15:31:39.26167Z",
  "tachograph_deadline": "2020-12-22T15:31:39.26167Z",
  "speed_limiter_deadline": "2020-12-22T15:31:39.26167Z",
  "country": "FR",
  "unavailability": [
    {
      "id": 928,
      "remote_id": "tr123type1",
      "created": "2020-07-30T21:10:06.44551Z",
      "start_date": "2020-07-30T21:10:06.44551Z",
      "end_date": "2020-07-30T21:10:06.44551Z",
      "unavailability_type": "paid_vacation",
      "unavailability_note": "I'm on vacation"
    }
  ],
  "events": [
    {}
  ]
}

Delete a vehicle

delete

Authorizations

Path parameters

pknumberRequired

remote_idstringOptional

If you choose to identify an object with its remote_id instead of its pk then

• replace the pk value with the remote_id value in the URL

• specify lookup_field=remote_id in the query parameters

Query parameters

lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Responses

204

Empty body

delete

HTTPcURLJavaScriptPython

DELETE /api/v4/vehicles/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*

204

Empty body

No content

Read a vehicle

get

Authorizations

Path parameters

pknumberRequired

remote_idstringOptional

If you choose to identify an object with its remote_id instead of its pk then

• replace the pk value with the remote_id value in the URL

• specify lookup_field=remote_id in the query parameters

Query parameters

lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Responses

200

Get successful

application/json

get

HTTPcURLJavaScriptPython

GET /api/v4/vehicles/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*

200

Get successful

{
  "pk": 928,
  "carrier": 928,
  "category": "tipper_cereal",
  "license_plate": "WE749RM",
  "fleet_number": "TRUCK120",
  "remote_id": "tr123type1",
  "created": "2020-07-30T21:10:06.44551Z",
  "used_for_qualimat_transports": true,
  "telematic_vehicle": 1,
  "original": 40,
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ],
  "technical_control_deadline": "2020-12-22T15:31:39.26167Z",
  "tachograph_deadline": "2020-12-22T15:31:39.26167Z",
  "speed_limiter_deadline": "2020-12-22T15:31:39.26167Z",
  "country": "FR",
  "unavailability": [
    {
      "id": 928,
      "remote_id": "tr123type1",
      "created": "2020-07-30T21:10:06.44551Z",
      "start_date": "2020-07-30T21:10:06.44551Z",
      "end_date": "2020-07-30T21:10:06.44551Z",
      "unavailability_type": "paid_vacation",
      "unavailability_note": "I'm on vacation"
    }
  ],
  "events": [
    {}
  ]
}

Partially update a vehicle

patch

Update information for a vehicle in the requester's company fleet

Authorizations

Path parameters

pknumberRequired

remote_idstringOptional

If you choose to identify an object with its remote_id instead of its pk then

• replace the pk value with the remote_id value in the URL

• specify lookup_field=remote_id in the query parameters

Query parameters

lookup_fieldstringOptional

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Body

remote_idstringOptional

The ID of the vehicle in your system.

Example: tr123type1

fleet_numberstring · max: 10Optional

Your vehicle fleet number. It has to be unique among all your vehicles. When filled, fleet number will be displayed in the web and mobile app next to license plate number. It can also be used for searches.

Example: TRUCK120

license_platestring · max: 200Optional

License plate number

Example: WE749RM

categorystring · enum · max: 200Optional

Vehicle category

Possible values:

used_for_qualimat_transportsbooleanOptional

True if the vehicle can be used for Qualimat transport (only used for vehicle that can handle a load without trailer). This value is used to add a Qualimat logo next to the vehicle in forms, in order to help the user selecting the vehicle when creating a transport. The is no control on the value. You can create a Qualimat transport with a vehicle that is not flagged for Qualimat. In this case a warning is displayed in the transport detail.

Responses

200

Get successful

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v4/vehicles/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "remote_id": "tr123type1",
  "fleet_number": "TRUCK120",
  "license_plate": "WE749RM",
  "category": "unknown",
  "used_for_qualimat_transports": true,
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ]
}

200

Get successful

{
  "pk": 928,
  "carrier": 928,
  "category": "tipper_cereal",
  "license_plate": "WE749RM",
  "fleet_number": "TRUCK120",
  "remote_id": "tr123type1",
  "created": "2020-07-30T21:10:06.44551Z",
  "used_for_qualimat_transports": true,
  "telematic_vehicle": 1,
  "original": 40,
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ],
  "technical_control_deadline": "2020-12-22T15:31:39.26167Z",
  "tachograph_deadline": "2020-12-22T15:31:39.26167Z",
  "speed_limiter_deadline": "2020-12-22T15:31:39.26167Z",
  "country": "FR",
  "unavailability": [
    {
      "id": 928,
      "remote_id": "tr123type1",
      "created": "2020-07-30T21:10:06.44551Z",
      "start_date": "2020-07-30T21:10:06.44551Z",
      "end_date": "2020-07-30T21:10:06.44551Z",
      "unavailability_type": "paid_vacation",
      "unavailability_note": "I'm on vacation"
    }
  ],
  "events": [
    {}
  ]
}