Trailers

List all trailers

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

Query parameters

Response

200

Get successful

Body

application/json

countinteger

Example: 1

nextnullable string

previousnullable string

resultsarray of Trailer (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 928,
      "original": 0,
      "carrier": 928,
      "license_plate": "WE749RM",
      "fleet_number": "TRAILER120",
      "remote_id": "tr123type1",
      "created": "2020-07-30T21:10:06.44551Z",
      "used_for_qualimat_transports": false,
      "tags": [
        {
          "pk": 23498,
          "name": "Remorque"
        }
      ],
      "technical_control_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 trailer

Adds a trailer in the requester's company fleet

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

Body

application/json

remote_idstring

The ID of the trailer in your system.

Example: "tr123type1"

fleet_numberstring

Your trailer fleet number. It has to be unique among all your trailers. 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"

used_for_qualimat_transportsboolean

True if the trailer can be used for Qualimat transport. This value is used to add a Qualimat logo next to the trailer in forms, in order to help the user selecting the trailer when creating a transport. The is no control on the value. You can create a Qualimat transport with a trailer 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 trailer.

Response

201

Create successful

Body

application/json

pknumber

Dashdoc's internal id

Example: 928

originalnumber

Ignore. Dashdoc technical data

carriernumber

Dashdoc's internal id of the carrier owning the trailer

Example: 928

license_platestring

License plate number

Example: "WE749RM"

fleet_numberstring

Your trailer fleet number

Example: "TRAILER120"

remote_idstring

The ID of the trailer 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 trailer can be used for Qualimat transport (only used for visual help and warnings)

tagsarray of Tag (object)

List of tags applied to the trailer.

technical_control_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/trailers/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "pk": 928,
  "original": 0,
  "carrier": 928,
  "license_plate": "WE749RM",
  "fleet_number": "TRAILER120",
  "remote_id": "tr123type1",
  "created": "2020-07-30T21:10:06.44551Z",
  "used_for_qualimat_transports": false,
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ],
  "technical_control_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 trailer

DELETEhttps://api.dashdoc.eu/api/v4/trailers/{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/trailers/{pk}/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Read a trailer

GEThttps://api.dashdoc.eu/api/v4/trailers/{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

originalnumber

Ignore. Dashdoc technical data

carriernumber

Dashdoc's internal id of the carrier owning the trailer

Example: 928

license_platestring

License plate number

Example: "WE749RM"

fleet_numberstring

Your trailer fleet number

Example: "TRAILER120"

remote_idstring

The ID of the trailer 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 trailer can be used for Qualimat transport (only used for visual help and warnings)

tagsarray of Tag (object)

List of tags applied to the trailer.

technical_control_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/trailers/{pk}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "pk": 928,
  "original": 0,
  "carrier": 928,
  "license_plate": "WE749RM",
  "fleet_number": "TRAILER120",
  "remote_id": "tr123type1",
  "created": "2020-07-30T21:10:06.44551Z",
  "used_for_qualimat_transports": false,
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ],
  "technical_control_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 trailer

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

PATCHhttps://api.dashdoc.eu/api/v4/trailers/{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 trailer in your system.

Example: "tr123type1"

fleet_numberstring

Your trailer fleet number. It has to be unique among all your trailers. 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"

used_for_qualimat_transportsboolean

True if the trailer can be used for Qualimat transport. This value is used to add a Qualimat logo next to the trailer in forms, in order to help the user selecting the trailer when creating a transport. The is no control on the value. You can create a Qualimat transport with a trailer 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 trailer.

Response

200

Get successful

Body

application/json

pknumber

Dashdoc's internal id

Example: 928

originalnumber

Ignore. Dashdoc technical data

carriernumber

Dashdoc's internal id of the carrier owning the trailer

Example: 928

license_platestring

License plate number

Example: "WE749RM"

fleet_numberstring

Your trailer fleet number

Example: "TRAILER120"

remote_idstring

The ID of the trailer 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 trailer can be used for Qualimat transport (only used for visual help and warnings)

tagsarray of Tag (object)

List of tags applied to the trailer.

technical_control_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/trailers/{pk}/', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "pk": 928,
  "original": 0,
  "carrier": 928,
  "license_plate": "WE749RM",
  "fleet_number": "TRAILER120",
  "remote_id": "tr123type1",
  "created": "2020-07-30T21:10:06.44551Z",
  "used_for_qualimat_transports": false,
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ],
  "technical_control_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": []
}