Trailers | Dashdoc API Documentation

List all trailers

get

Authorizations

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Query parameters

pageintegerOptional

A page number within the paginated result set.

textstringOptional

Search by license plate or fleet number

id__instringOptional

Comma separated list of trailer ids

Example: 123,456

has_license_platebooleanOptional

Filter trailers with or without a license plate

tags__instringOptional

Comma separated list of tag ids

Example: 10,20

categorystringOptional

Filter own fleet or dedicated trailers

carrierintegerOptional

Carrier id to filter on

Responses

200

Get successful

application/json

countintegerOptionalExample: 1

nextstring · nullableOptional

previousstring · nullableOptional

get

/trailers/

GET /api/v4/trailers/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*

200

Get successful

{
  "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,
      "tags": [
        {
          "pk": 1,
          "name": "Urgent",
          "color": "#E5291D",
          "tag_group_id": 1
        }
      ],
      "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

post

Adds a trailer in the requester's company fleet

Authorizations

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Body

remote_idstringOptional

The ID of the trailer in your system.

Example: tr123type1

fleet_numberstring · max: 10Optional

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: 200Optional

License plate number (has to be unique)

Example: WE749RM

used_for_qualimat_transportsbooleanOptional

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.

Responses

201

Create successful

application/json

post

/trailers/

POST /api/v4/trailers/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "remote_id": "tr123type1",
  "fleet_number": "TRUCK120",
  "license_plate": "WE749RM",
  "used_for_qualimat_transports": true,
  "tags": [
    {
      "pk": 1,
      "name": "Urgent",
      "color": "#E5291D",
      "tag_group_id": 1
    }
  ]
}

201

Create successful

{
  "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,
  "tags": [
    {
      "pk": 1,
      "name": "Urgent",
      "color": "#E5291D",
      "tag_group_id": 1
    }
  ],
  "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

delete

Authorizations

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Path parameters

pknumberRequired

remote_idstringOptional

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_fieldstringOptional

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

204

Empty body

delete

/trailers/{pk}/

DELETE /api/v4/trailers/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*

204

Empty body

No content

Read a trailer

get

Authorizations

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Path parameters

pknumberRequired

remote_idstringOptional

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_fieldstringOptional

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

200

Get successful

application/json

pknumberOptional

Dashdoc's internal id

Example: 928

originalnumberOptional

Ignore. Dashdoc technical data

carriernumberOptional

Dashdoc's internal id of the carrier owning the trailer

Example: 928

license_platestringOptional

License plate number

Example: WE749RM

fleet_numberstringOptional

Your trailer fleet number

Example: TRAILER120

remote_idstringOptional

The ID of the trailer in your system

Example: tr123type1

createdstring · date-timeOptional

Date of creation on our server

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

used_for_qualimat_transportsbooleanOptional

True if the trailer can be used for Qualimat transport (only used for visual help and warnings)

technical_control_deadlinestring · date-timeOptionalExample: 2020-12-22T15:31:39.26167Z

countrystringOptional

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

Example: FR

eventsobject[]Optional

Ignore. Dashdoc technical data.

get

/trailers/{pk}/

GET /api/v4/trailers/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*

200

Get successful

{
  "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,
  "tags": [
    {
      "pk": 1,
      "name": "Urgent",
      "color": "#E5291D",
      "tag_group_id": 1
    }
  ],
  "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

patch

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

Authorizations

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Path parameters

pknumberRequired

remote_idstringOptional

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_fieldstringOptional

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_idstringOptional

The ID of the trailer in your system.

Example: tr123type1

fleet_numberstring · max: 10Optional

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: 200Optional

License plate number

Example: WE749RM

used_for_qualimat_transportsbooleanOptional

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.

Responses

200

Get successful

application/json

pknumberOptional

Dashdoc's internal id

Example: 928

originalnumberOptional

Ignore. Dashdoc technical data

carriernumberOptional

Dashdoc's internal id of the carrier owning the trailer

Example: 928

license_platestringOptional

License plate number

Example: WE749RM

fleet_numberstringOptional

Your trailer fleet number

Example: TRAILER120

remote_idstringOptional

The ID of the trailer in your system

Example: tr123type1

createdstring · date-timeOptional

Date of creation on our server

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

used_for_qualimat_transportsbooleanOptional

True if the trailer can be used for Qualimat transport (only used for visual help and warnings)

technical_control_deadlinestring · date-timeOptionalExample: 2020-12-22T15:31:39.26167Z

countrystringOptional

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

Example: FR

eventsobject[]Optional

Ignore. Dashdoc technical data.

patch

/trailers/{pk}/

PATCH /api/v4/trailers/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "remote_id": "tr123type1",
  "fleet_number": "TRUCK120",
  "license_plate": "WE749RM",
  "used_for_qualimat_transports": true,
  "tags": [
    {
      "pk": 1,
      "name": "Urgent",
      "color": "#E5291D",
      "tag_group_id": 1
    }
  ]
}

200

Get successful

{
  "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,
  "tags": [
    {
      "pk": 1,
      "name": "Urgent",
      "color": "#E5291D",
      "tag_group_id": 1
    }
  ],
  "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": [
    {}
  ]
}

hashtagList all trailers

hashtagCreate a trailer

hashtagDelete a trailer

hashtagRead a trailer

hashtagPartially update a trailer

List all trailers

Create a trailer

Delete a trailer

Read a trailer

Partially update a trailer