Trailers

List all trailers

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

Query parameters

Response

Get successful

Body

countinteger

nextnullable string

previousnullable string

resultsarray of Trailer (object)

Request

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

Response

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

Create a trailer

Adds a trailer in the requester's company fleet

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

Body

remote_idstring

The ID of the trailer in your system.

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.

license_platestring

License plate number (has to be unique)

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

Create successful

Body

pknumber

Dashdoc's internal id

originalnumber

Ignore. Dashdoc technical data

carriernumber

Dashdoc's internal id of the carrier owning the trailer

license_platestring

License plate number

fleet_numberstring

Your trailer fleet number

remote_idstring

The ID of the trailer in your system

createdstring (date-time)

Date of creation on our server

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)

countrycountry (string)

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

unvailabilityarray of object

List of unavailable period

eventsarray of object

Ignore. Dashdoc technical data.

Request

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

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

Empty body

Request

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

Get successful

Body

pknumber

Dashdoc's internal id

originalnumber

Ignore. Dashdoc technical data

carriernumber

Dashdoc's internal id of the carrier owning the trailer

license_platestring

License plate number

fleet_numberstring

Your trailer fleet number

remote_idstring

The ID of the trailer in your system

createdstring (date-time)

Date of creation on our server

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)

countrycountry (string)

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

unvailabilityarray of object

List of unavailable period

eventsarray of object

Ignore. Dashdoc technical data.

Request

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

Response

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

remote_idstring

The ID of the trailer in your system.

fleet_numberstring

license_platestring

License plate number

used_for_qualimat_transportsboolean

tagsarray of Tag (object)

List of tags applied to the trailer.

Response

Get successful

Body

pknumber

Dashdoc's internal id

originalnumber

Ignore. Dashdoc technical data

carriernumber

Dashdoc's internal id of the carrier owning the trailer

license_platestring

License plate number

fleet_numberstring

Your trailer fleet number

remote_idstring

The ID of the trailer in your system

createdstring (date-time)

Date of creation on our server

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)

countrycountry (string)

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

unvailabilityarray of object

List of unavailable period

eventsarray of object

Ignore. Dashdoc technical data.

Request

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

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

PreviousTraces NextTrack Dechets

Last updated 6 months ago

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();

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

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();