Unavailability

Create an unavailability for a trucker for a given period

A trucker 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 trucker.

POSThttps://api.dashdoc.eu/api/v4/manager-truckers/{pk}/unavailability/

Body

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

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

Body

pknumber

Dashdoc's internal id.

Example: 23498

userUser (object)

phone_numberstring

invite_codestring

Invite code trucker needs to connect to mobile app. The code is generated by Dashdoc.

app_versionnumber

Ignore. Dashdoc technical data.

Example: 180

readable_app_versionstring

Ignore. Dashdoc technical data.

Example: "2.7.7"

platformstring

Ignore. Dashdoc technical data.

Example: "ios"

remote_idstring

The ID of the trucker in your system. It has to be unique among all your truckers.

carrierCompany (object)

is_rentedboolean

phone_number_personalstring

Example: "0601020304"

addressstring

Example: "A random address 4 square Dashdoc"

postcodestring

Example: "44000"

citystring

Example: "Nantes"

country_codecountry (string)

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

Example: "FR"

driving_license_numberstring

Example: "99 999 999"

driving_license_deadlinestring (date-time)

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

adr_license_deadlinestring (date-time)

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

carrist_license_deadlinestring (date-time)

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

occupational_health_visit_deadlinestring (date-time)

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

new_app_update_availableboolean

Ignore. Dashdoc technical data.

unavailabilityarray of Unavailability (object)

List of unavailable period

eventsarray of object

Ignore. Dashdoc technical data.

tagsarray of Tag (object)

List of tags applied to the trucker.

Request

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

Response

{
  "pk": 23498,
  "user": {
    "pk": 17293,
    "username": "1b3b4c74-5f07-4f09-b18f-2753ffcf916e",
    "display_name": "Adèle Bouvet",
    "email": "adele.bouvet@gmail.com",
    "date_joined": "2024-10-09T06:49:37.931Z",
    "last_login": "2024-10-09T06:49:37.931Z",
    "has_usable_password": true,
    "first_name": "Adèle",
    "last_name": "Bouvet"
  },
  "phone_number": "text",
  "invite_code": "text",
  "app_version": 180,
  "readable_app_version": "2.7.7",
  "platform": "ios",
  "remote_id": "text",
  "carrier": {
    "pk": 928,
    "remote_id": "text",
    "created": "2020-07-30T21:10:06.445510Z",
    "updated": "2020-07-30T21:10:06.44551Z",
    "deleted": false,
    "invoicing_remote_id": "COMP_456",
    "name": "Transport Bouvet",
    "phone_number": "0601020304",
    "email": "i.love.dashdoc@gmail.com",
    "siren": "123456789",
    "trade_number": "text",
    "country": "FR",
    "comments": "text",
    "vat_number": "text",
    "is_verified": false,
    "settings_transport_order_observations": "text",
    "settings_constrain_reference_edition": false,
    "account_type": "text",
    "logo": "text",
    "primary_address": {
      "pk": "text",
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "created_by": 0,
      "created": "2020-07-30T21:10:06.44551Z",
      "instructions": "text",
      "remote_id": "text"
    },
    "managers": [
      {
        "pk": 928,
        "user": {
          "email": "adele.bouvet@gmail.com",
          "first_name": "Adèle",
          "last_name": "Bouvet"
        },
        "display_name": "text",
        "role": "text"
      }
    ],
    "has_loggable_managers": false
  },
  "is_rented": false,
  "phone_number_personal": "0601020304",
  "address": "A random address 4 square Dashdoc",
  "postcode": "44000",
  "city": "Nantes",
  "country_code": "FR",
  "driving_license_number": "99 999 999",
  "driving_license_deadline": "2020-12-22T15:31:39.26167Z",
  "adr_license_deadline": "2020-12-22T15:31:39.26167Z",
  "carrist_license_deadline": "2020-12-22T15:31:39.26167Z",
  "occupational_health_visit_deadline": "2020-12-22T15:31:39.26167Z",
  "new_app_update_available": false,
  "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": [],
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ]
}

Delete an unavailability for a trucker

DELETEhttps://api.dashdoc.eu/api/v4/manager-truckers/{pk}/unavailability/{pk_unavailability}/

Path parameters

pk*number

The trucker's primary key

pk_unavailability*number

The unavailability's primary key

Response

Empty body

Request

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

Partially update an unavailability for a trucker

PATCHhttps://api.dashdoc.eu/api/v4/manager-truckers/{pk}/unavailability/{pk_unavailability}/

Path parameters

pk*number

The trucker's primary key

pk_unavailability*number

The unavailability's primary key

Body

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

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

Body

pknumber

Dashdoc's internal id.

Example: 23498

userUser (object)

phone_numberstring

invite_codestring

Invite code trucker needs to connect to mobile app. The code is generated by Dashdoc.

app_versionnumber

Ignore. Dashdoc technical data.

Example: 180

readable_app_versionstring

Ignore. Dashdoc technical data.

Example: "2.7.7"

platformstring

Ignore. Dashdoc technical data.

Example: "ios"

remote_idstring

The ID of the trucker in your system. It has to be unique among all your truckers.

carrierCompany (object)

is_rentedboolean

phone_number_personalstring

Example: "0601020304"

addressstring

Example: "A random address 4 square Dashdoc"

postcodestring

Example: "44000"

citystring

Example: "Nantes"

country_codecountry (string)

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

Example: "FR"

driving_license_numberstring

Example: "99 999 999"

driving_license_deadlinestring (date-time)

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

adr_license_deadlinestring (date-time)

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

carrist_license_deadlinestring (date-time)

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

occupational_health_visit_deadlinestring (date-time)

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

new_app_update_availableboolean

Ignore. Dashdoc technical data.

unavailabilityarray of Unavailability (object)

List of unavailable period

eventsarray of object

Ignore. Dashdoc technical data.

tagsarray of Tag (object)

List of tags applied to the trucker.

Request

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

Response

{
  "pk": 23498,
  "user": {
    "pk": 17293,
    "username": "1b3b4c74-5f07-4f09-b18f-2753ffcf916e",
    "display_name": "Adèle Bouvet",
    "email": "adele.bouvet@gmail.com",
    "date_joined": "2024-10-09T06:49:37.931Z",
    "last_login": "2024-10-09T06:49:37.931Z",
    "has_usable_password": true,
    "first_name": "Adèle",
    "last_name": "Bouvet"
  },
  "phone_number": "text",
  "invite_code": "text",
  "app_version": 180,
  "readable_app_version": "2.7.7",
  "platform": "ios",
  "remote_id": "text",
  "carrier": {
    "pk": 928,
    "remote_id": "text",
    "created": "2020-07-30T21:10:06.445510Z",
    "updated": "2020-07-30T21:10:06.44551Z",
    "deleted": false,
    "invoicing_remote_id": "COMP_456",
    "name": "Transport Bouvet",
    "phone_number": "0601020304",
    "email": "i.love.dashdoc@gmail.com",
    "siren": "123456789",
    "trade_number": "text",
    "country": "FR",
    "comments": "text",
    "vat_number": "text",
    "is_verified": false,
    "settings_transport_order_observations": "text",
    "settings_constrain_reference_edition": false,
    "account_type": "text",
    "logo": "text",
    "primary_address": {
      "pk": "text",
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "created_by": 0,
      "created": "2020-07-30T21:10:06.44551Z",
      "instructions": "text",
      "remote_id": "text"
    },
    "managers": [
      {
        "pk": 928,
        "user": {
          "email": "adele.bouvet@gmail.com",
          "first_name": "Adèle",
          "last_name": "Bouvet"
        },
        "display_name": "text",
        "role": "text"
      }
    ],
    "has_loggable_managers": false
  },
  "is_rented": false,
  "phone_number_personal": "0601020304",
  "address": "A random address 4 square Dashdoc",
  "postcode": "44000",
  "city": "Nantes",
  "country_code": "FR",
  "driving_license_number": "99 999 999",
  "driving_license_deadline": "2020-12-22T15:31:39.26167Z",
  "adr_license_deadline": "2020-12-22T15:31:39.26167Z",
  "carrist_license_deadline": "2020-12-22T15:31:39.26167Z",
  "occupational_health_visit_deadline": "2020-12-22T15:31:39.26167Z",
  "new_app_update_available": false,
  "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": [],
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ]
}

PreviousGenerate Invite Code NextSecurity Protocols

Last updated 3 months ago

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

{ "pk": 23498, "user": { "pk": 17293, "username": "1b3b4c74-5f07-4f09-b18f-2753ffcf916e", "display_name": "Adèle Bouvet", "email": "adele.bouvet@gmail.com", "date_joined": "2024-10-09T06:49:37.931Z", "last_login": "2024-10-09T06:49:37.931Z", "has_usable_password": true, "first_name": "Adèle", "last_name": "Bouvet" }, "phone_number": "text", "invite_code": "text", "app_version": 180, "readable_app_version": "2.7.7", "platform": "ios", "remote_id": "text", "carrier": { "pk": 928, "remote_id": "text", "created": "2020-07-30T21:10:06.445510Z", "updated": "2020-07-30T21:10:06.44551Z", "deleted": false, "invoicing_remote_id": "COMP_456", "name": "Transport Bouvet", "phone_number": "0601020304", "email": "i.love.dashdoc@gmail.com", "siren": "123456789", "trade_number": "text", "country": "FR", "comments": "text", "vat_number": "text", "is_verified": false, "settings_transport_order_observations": "text", "settings_constrain_reference_edition": false, "account_type": "text", "logo": "text", "primary_address": { "pk": "text", "name": "Transport Bouvet", "address": "3 rue des champs", "city": "Nantes", "postcode": "44000", "country": "FR", "latitude": -52.5561625, "longitude": 92.896504, "coords_validated": false, "is_demo": false, "is_carrier": false, "is_shipper": false, "is_origin": false, "is_destination": false, "created_by": 0, "created": "2020-07-30T21:10:06.44551Z", "instructions": "text", "remote_id": "text" }, "managers": [ { "pk": 928, "user": { "email": "adele.bouvet@gmail.com", "first_name": "Adèle", "last_name": "Bouvet" }, "display_name": "text", "role": "text" } ], "has_loggable_managers": false }, "is_rented": false, "phone_number_personal": "0601020304", "address": "A random address 4 square Dashdoc", "postcode": "44000", "city": "Nantes", "country_code": "FR", "driving_license_number": "99 999 999", "driving_license_deadline": "2020-12-22T15:31:39.26167Z", "adr_license_deadline": "2020-12-22T15:31:39.26167Z", "carrist_license_deadline": "2020-12-22T15:31:39.26167Z", "occupational_health_visit_deadline": "2020-12-22T15:31:39.26167Z", "new_app_update_available": false, "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": [], "tags": [ { "pk": 23498, "name": "Remorque" } ] }

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