Vehicles

List all vehicles

GEThttps://api.dashdoc.eu/api/v4/vehicles/

Query parameters

Response

200

Get successful

Body

application/json

countinteger

Example: 1

nextnullable string

previousnullable string

resultsarray of Vehicle (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.dashdoc.eu/api/v4/vehicles/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": false,
      "telematic_vehicle": 0,
      "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

Adds a vehicle in the requester's company fleet

POSThttps://api.dashdoc.eu/api/v4/vehicles/

Body

application/json

remote_idstring

The ID of the vehicle in your system.

Example: "tr123type1"

fleet_numberstring

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

License plate number (has to be unique)

Example: "WE749RM"

categoryvehicle_category (enum)

Vehicle category

unknownlightstraightstraight_tippertippertipper_cerealtipper_constructionrefrigeratedisothermplatformcurtainsiderbox_bodytrailer_truckflatbedlow_flatbedlogcoilcontainervehicleheavy_equipmentsolid_tankerpetrol_tankerchemical_tankerfood_tankerlivestockspecial_convoy

used_for_qualimat_transportsboolean

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.

tagsarray of Tag (object)

List of tags applied to the vehicle.

telematic_data_sourceenum

The telematic where the vehicle is refered

Example: "webfleet"

alertgasoilastrataaddsecuredashdoceliottfleetboardgeodynamicsgeotracerkooveamappingcontrolmapandtruckmasternautqeosquartixrioscaniasudtelematiquetransicstrimbletruckonlinevehizenvolvowebfleetstradaverizonmaponbumpsamsara_mapandtruckwebeyepass_tracabilitebizztrackaktkc_etransportas_mapandtruckanima_mapandtruckarvento_mapandtruckas24_mapandtruckaxxess_mapandtruckbornemann_infleet_mapandtruckbpw_mapandtruckcarrier_mapandtruckcartrack_mapandtruckcommander_services_mapandtruckeasytrack_mapandtruckecofleet_mapandtruckedrive_mapandtruckeffitrailer_mapandtruckekolis_mapandtruckfleetgo_mapandtruckfleethand_mapandtruckfleetmaster_mapandtruckframelogic_mapandtruckfrotcom_mapandtruckgestracking_mapandtruckglobaltrack_mapandtruckgoodyear_france_mapandtruckgps_mobile_mapandtruckicell_mapandtruckims_telematics_mapandtruckinelo_mapandtruckinfis_mapandtruckjaltest_mapandtruckkeeptrace_mapandtruckkonsalnet_mapandtruckkrone_telematic_mapandtrucklegal_telematics_mapandtrucklinqo_mapandtrucklocalizare_mapandtrucklocationsolutions_mapandtruckloctracker_mapandtruckmecomo_mapandtruckmicrolise_mapandtruckmix_telematics_mapandtruckmovildata_mapandtruckmtrack_mapandtruckn2mobil_mapandtrucknaocom_mapandtrucknavifleet_mapandtrucknexus_mapandtruckoptifleet_mapandtruckoptimo_gps_mapandtruckorbcomm_mapandtruckorbcomm_africa_mapandtruckpulsit_electronics_mapandtruckquake_tracking_mapandtruckriverlong_mapandtrucksas_fleet_mapandtrucksatko_mapandtruckschmitz_cargobull_mapandtruckseyir_mobil_mapandtruckskywatch_mapandtrucksolustop_mapandtruckspedion_mapandtruckspeedtelematics_mapandtruckstarcom_mapandtrucktelepass_mapandtruckterramar_networks_mapandtruckthermoking_mapandtrucktracker_mapandtrucktrackit_mapandtrucktracknamic_mapandtruckv3_smart_technologies_mapandtruckvektor_teknoloji_mapandtruckviafleet_mapandtruckviasat_mapandtruckvisirun_mapandtruckwaynet_mapandtruckwayzz_mapandtruckwebdispecink_mapandtruck

vendor_idstring

ID of the vehicle in the telematics system

Response

201

Create successful

Body

application/json

pknumber

Dashdoc's internal id

Example: 928

carriernumber

Dashdoc's internal id of the carrier owning the vehicle

Example: 928

categorystring

Vehicle category

Example: "tipper_cereal"

license_platestring

License plate number

Example: "WE749RM"

fleet_numberstring

Your vehicle fleet number

Example: "TRUCK120"

remote_idstring

The ID of the vehicle in your system

Example: "tr123type1"

createdstring (date-time)

Date of creation on our server

Example: "2020-07-30T21:10:06.44551Z"

used_for_qualimat_transportsboolean

True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)

telematic_vehiclenumber

Ignore. Dashdoc technical data

originalnumber

Example: 40

tagsarray of Tag (object)

List of tags applied to the vehicle.

technical_control_deadlinestring (date-time)

Example: "2020-12-22T15:31:39.26167Z"

tachograph_deadlinestring (date-time)

Example: "2020-12-22T15:31:39.26167Z"

speed_limiter_deadlinestring (date-time)

Example: "2020-12-22T15:31:39.26167Z"

countrycountry (string)

Only the 2-character codification is accepted (ISO 3166-1 alpha-2)

Example: "FR"

unavailabilityarray of Unavailability (object)

List of unavailable period

eventsarray of object

Ignore. Dashdoc technical data.

Request

JavaScriptCurlPython

const response = await fetch('https://api.dashdoc.eu/api/v4/vehicles/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "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": false,
  "telematic_vehicle": 0,
  "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

DELETEhttps://api.dashdoc.eu/api/v4/vehicles/{pk}/

Path parameters

pk*number

remote_idstring

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

Response

204

Empty body

Request

JavaScriptCurlPython

const response = await fetch('https://api.dashdoc.eu/api/v4/vehicles/{pk}/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Read a vehicle

GEThttps://api.dashdoc.eu/api/v4/vehicles/{pk}/

Path parameters

pk*number

remote_idstring

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

Response

200

Get successful

Body

application/json

pknumber

Dashdoc's internal id

Example: 928

carriernumber

Dashdoc's internal id of the carrier owning the vehicle

Example: 928

categorystring

Vehicle category

Example: "tipper_cereal"

license_platestring

License plate number

Example: "WE749RM"

fleet_numberstring

Your vehicle fleet number

Example: "TRUCK120"

remote_idstring

The ID of the vehicle in your system

Example: "tr123type1"

createdstring (date-time)

Date of creation on our server

Example: "2020-07-30T21:10:06.44551Z"

used_for_qualimat_transportsboolean

True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)

telematic_vehiclenumber

Ignore. Dashdoc technical data

originalnumber

Example: 40

tagsarray of Tag (object)

List of tags applied to the vehicle.

technical_control_deadlinestring (date-time)

Example: "2020-12-22T15:31:39.26167Z"

tachograph_deadlinestring (date-time)

Example: "2020-12-22T15:31:39.26167Z"

speed_limiter_deadlinestring (date-time)

Example: "2020-12-22T15:31:39.26167Z"

countrycountry (string)

Only the 2-character codification is accepted (ISO 3166-1 alpha-2)

Example: "FR"

unavailabilityarray of Unavailability (object)

List of unavailable period

eventsarray of object

Ignore. Dashdoc technical data.

Request

JavaScriptCurlPython

const response = await fetch('https://api.dashdoc.eu/api/v4/vehicles/{pk}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": false,
  "telematic_vehicle": 0,
  "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

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

PATCHhttps://api.dashdoc.eu/api/v4/vehicles/{pk}/

Path parameters

pk*number

remote_idstring

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

Body

application/json

remote_idstring

The ID of the vehicle in your system.

Example: "tr123type1"

fleet_numberstring

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

License plate number

Example: "WE749RM"

categoryvehicle_category (enum)

Vehicle category

unknownlightstraightstraight_tippertippertipper_cerealtipper_constructionrefrigeratedisothermplatformcurtainsiderbox_bodytrailer_truckflatbedlow_flatbedlogcoilcontainervehicleheavy_equipmentsolid_tankerpetrol_tankerchemical_tankerfood_tankerlivestockspecial_convoy

used_for_qualimat_transportsboolean

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.

tagsarray of Tag (object)

List of tags applied to the vehicle.

Response

200

Get successful

Body

application/json

pknumber

Dashdoc's internal id

Example: 928

carriernumber

Dashdoc's internal id of the carrier owning the vehicle

Example: 928

categorystring

Vehicle category

Example: "tipper_cereal"

license_platestring

License plate number

Example: "WE749RM"

fleet_numberstring

Your vehicle fleet number

Example: "TRUCK120"

remote_idstring

The ID of the vehicle in your system

Example: "tr123type1"

createdstring (date-time)

Date of creation on our server

Example: "2020-07-30T21:10:06.44551Z"

used_for_qualimat_transportsboolean

True if the vehicle can be used for Qualimat transport (only used for visual help and warnings)

telematic_vehiclenumber

Ignore. Dashdoc technical data

originalnumber

Example: 40

tagsarray of Tag (object)

List of tags applied to the vehicle.

technical_control_deadlinestring (date-time)

Example: "2020-12-22T15:31:39.26167Z"

tachograph_deadlinestring (date-time)

Example: "2020-12-22T15:31:39.26167Z"

speed_limiter_deadlinestring (date-time)

Example: "2020-12-22T15:31:39.26167Z"

countrycountry (string)

Only the 2-character codification is accepted (ISO 3166-1 alpha-2)

Example: "FR"

unavailabilityarray of Unavailability (object)

List of unavailable period

eventsarray of object

Ignore. Dashdoc technical data.

Request

JavaScriptCurlPython

const response = await fetch('https://api.dashdoc.eu/api/v4/vehicles/{pk}/', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "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": false,
  "telematic_vehicle": 0,
  "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": []
}