Unavailability

Create an unavailability for a vehicle for a given period

A vehicle can be marked as unavailable for a given period of time for various reasons. These unavailabilities are marked on the planning or can be accessed by API by fetching the vehicle.

POSThttps://api.dashdoc.eu/api/v4/vehicles/{pk}/unavailability/

Body

application/json

remote_idstring

The ID of the unavailability in your system

Example: "tr123type1"

createdstring (date-time)

Date of creation on our server

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

start_datestring (date-time)

Start date of the unavailability

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

end_datestring (date-time)

End date of the unavailability

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

unavailability_typeenum

Type of unavailability

paid_vacationday_offsick_leavetrainingvacationmaintenancerentalother

unavailability_notestring

Notes about the unavailability

Example: "I'm on vacation"

Response

201

Successfully created the unavailability, returns the vehicle, which contains the unavailability.

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}/unavailability/', {
    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 an unavailability for a vehicle

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

Path parameters

pk*number

The vehicle's primary key

pk_unavailability*number

The unavailability's primary key

Response

204

Empty body

Request

JavaScriptCurlPython

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

Partially update an unavailability for a vehicle

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

Path parameters

pk*number

The vehicle's primary key

pk_unavailability*number

The unavailability's primary key

Body

application/json

remote_idstring

The ID of the unavailability in your system

Example: "tr123type1"

createdstring (date-time)

Date of creation on our server

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

start_datestring (date-time)

Start date of the unavailability

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

end_datestring (date-time)

End date of the unavailability

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

unavailability_typeenum

Type of unavailability

paid_vacationday_offsick_leavetrainingvacationmaintenancerentalother

unavailability_notestring

Notes about the unavailability

Example: "I'm on vacation"

Response

200

Successfully updated the unavailability, returns the vehicle, which contains the unavailability.

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}/unavailability/{pk_unavailability}/', {
    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": []
}