Unavailability

Create an unavailability for a vehicle for a given period

post

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.

Authorizations

Body

remote_idstringoptional

The ID of the unavailability in your system

Example: tr123type1

createdstring · date-timeoptional

Date of creation on our server

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

start_datestring · date-timeoptional

Start date of the unavailability

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

end_datestring · date-timeoptional

End date of the unavailability

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

unavailability_typestring · enumoptional

Type of unavailability

Options: paid_vacation, day_off, sick_leave, training, vacation, maintenance, rental, other

unavailability_notestringoptional

Notes about the unavailability

Example: I'm on vacation

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.dashdoc.eu/api/v4/vehicles/{pk}/unavailability/' \
  --header 'Authentication: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

201

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": 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": [
    {}
  ]
}

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

Delete an unavailability for a vehicle

delete

Authorizations

Path parameters

pknumberrequired

The vehicle's primary key

pk_unavailabilitynumberrequired

The unavailability's primary key

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.dashdoc.eu/api/v4/vehicles/{pk}/unavailability/{pk_unavailability}/' \
  --header 'Authentication: YOUR_API_KEY'

204

204

No body

Empty body

Partially update an unavailability for a vehicle

patch

Authorizations

Path parameters

pknumberrequired

The vehicle's primary key

pk_unavailabilitynumberrequired

The unavailability's primary key

Body

remote_idstringoptional

The ID of the unavailability in your system

Example: tr123type1

createdstring · date-timeoptional

Date of creation on our server

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

start_datestring · date-timeoptional

Start date of the unavailability

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

end_datestring · date-timeoptional

End date of the unavailability

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

unavailability_typestring · enumoptional

Type of unavailability

Options: paid_vacation, day_off, sick_leave, training, vacation, maintenance, rental, other

unavailability_notestringoptional

Notes about the unavailability

Example: I'm on vacation

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.dashdoc.eu/api/v4/vehicles/{pk}/unavailability/{pk_unavailability}/' \
  --header 'Authentication: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

200

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": 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": [
    {}
  ]
}

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