Trailers

List all trailers

get

/trailers/

Authorizations

Query parameters

pageinteger

A page number within the paginated result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.dashdoc.eu/api/v4/trailers/' \
  --header 'Authentication: YOUR_API_KEY'

200

200

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 928,
      "original": 1,
      "carrier": 928,
      "license_plate": "WE749RM",
      "fleet_number": "TRAILER120",
      "remote_id": "tr123type1",
      "created": "2020-07-30T21:10:06.44551Z",
      "used_for_qualimat_transports": true,
      "technical_control_deadline": "2020-12-22T15:31:39.26167Z",
      "country": "FR",
      "tags": [
        {
          "pk": 23498,
          "name": "Remorque"
        }
      ],
      "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_note": "I'm on vacation",
          "unavailability_type": "paid_vacation"
        }
      ],
      "events": [
        {}
      ]
    }
  ]
}

Get successful

Create a trailer

Adds a trailer in the requester's company fleet

post

/trailers/

Authorizations

Body

remote_idstring

The ID of the trailer in your system.

Example: tr123type1

fleet_numberstring · max: 10

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 · max: 200

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.

tagsobject[]

List of tags applied to the trailer.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.dashdoc.eu/api/v4/trailers/' \
  --header 'Authentication: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"remote_id":"tr123type1","fleet_number":"TRUCK120","license_plate":"WE749RM","tags":[{"pk":23498,"name":"Remorque"}]}'

201

201

{
  "pk": 928,
  "original": 1,
  "carrier": 928,
  "license_plate": "WE749RM",
  "fleet_number": "TRAILER120",
  "remote_id": "tr123type1",
  "created": "2020-07-30T21:10:06.44551Z",
  "used_for_qualimat_transports": true,
  "technical_control_deadline": "2020-12-22T15:31:39.26167Z",
  "country": "FR",
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ],
  "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_note": "I'm on vacation",
      "unavailability_type": "paid_vacation"
    }
  ],
  "events": [
    {}
  ]
}

Create successful

Delete a trailer

delete

/trailers/{pk}//

Authorizations

Path parameters

pknumberrequired

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

lookup_fieldstring

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

204

No body

Empty body

Read a trailer

get

/trailers/{pk}//

Authorizations

Path parameters

pknumberrequired

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

lookup_fieldstring

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.dashdoc.eu/api/v4/trailers/{pk}/' \
  --header 'Authentication: YOUR_API_KEY'

200

200

{
  "pk": 928,
  "original": 1,
  "carrier": 928,
  "license_plate": "WE749RM",
  "fleet_number": "TRAILER120",
  "remote_id": "tr123type1",
  "created": "2020-07-30T21:10:06.44551Z",
  "used_for_qualimat_transports": true,
  "technical_control_deadline": "2020-12-22T15:31:39.26167Z",
  "country": "FR",
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ],
  "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_note": "I'm on vacation",
      "unavailability_type": "paid_vacation"
    }
  ],
  "events": [
    {}
  ]
}

Get successful

Partially update a trailer

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

patch

/trailers/{pk}//

Authorizations

Path parameters

pknumberrequired

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

lookup_fieldstring

Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id (see path parameters)

Body

remote_idstring

The ID of the trailer in your system.

Example: tr123type1

fleet_numberstring · max: 10

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 · max: 200

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.

tagsobject[]

List of tags applied to the trailer.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.dashdoc.eu/api/v4/trailers/{pk}/' \
  --header 'Authentication: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"remote_id":"tr123type1","fleet_number":"TRUCK120","license_plate":"WE749RM","tags":[{"pk":23498,"name":"Remorque"}]}'

200

200

{
  "pk": 928,
  "original": 1,
  "carrier": 928,
  "license_plate": "WE749RM",
  "fleet_number": "TRAILER120",
  "remote_id": "tr123type1",
  "created": "2020-07-30T21:10:06.44551Z",
  "used_for_qualimat_transports": true,
  "technical_control_deadline": "2020-12-22T15:31:39.26167Z",
  "country": "FR",
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ],
  "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_note": "I'm on vacation",
      "unavailability_type": "paid_vacation"
    }
  ],
  "events": [
    {}
  ]
}

Get successful