Forms

List all waste forms

get

Authorizations

Query parameters

pageinteger

A page number within the paginated result set.

uid__instring

Filter waste forms by uid

createdstring · date-time

Filter waste forms by creation date

created__gtstring · date-time

Filter waste forms created after a certain date

created__gtestring · date-time

Filter waste forms created on or after a certain date

created__ltstring · date-time

Filter waste forms created before a certain date

created__ltestring · date-time

Filter waste forms created on or before a certain date

statusstring · enum

The status of the waste shipment

Example: completed

Options: draft, signed, cancelled, inTransit, discontinued, arrived, completed

status__instring

Filter waste forms by multiple statuses, comma separated

Example: cancelled,discontinued

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "DAS-1",
      "created": "2022-01-01T00:00:00Z",
      "updated": "2022-01-01T00:00:00Z",
      "status": "completed",
      "pdf": {
        "url": "http://example.com/pdf",
        "updated_date": "2022-01-01T00:00:00Z"
      },
      "discontinued_reason": "Traffic accident",
      "transport_uid": "123e4567-e89b-12d3-a456-426614174000",
      "producer_id": 1,
      "processor_id": 2,
      "carrier_id": 3,
      "organizer_id": 4,
      "origin_id": 5,
      "destination_id": 6,
      "instructions": "Handle with care",
      "transport_date": "2022-01-01T00:00:00Z",
      "carrier_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
      "organizer_signatory_uid": "123e4567-e89b-12d3-a456-426614174000",
      "producer_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
      "processor_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
      "processor_signatory_uid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Get successful

Create a waste form

post

Authorizations

Body

producer_idinteger | nullable

The ID of the producer company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.

Example: 1

processor_idinteger | nullable

The ID of the processor company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.

Example: 2

carrier_idinteger | nullable

The ID of the carrier company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.

Example: 3

organizer_idinteger | nullable

The ID of the organizer company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.

Example: 4

origin_idinteger | nullable

The ID of the origin address. If it does not exist, create it first with the /v4/addresses/ endpoint.

Example: 5

destination_idinteger | nullableDeprecated

The ID of the destination address. If it does not exist, create it first with the /v4/addresses/ endpoint. Deprecated because it is no longer used. We now use the processor address as destination.

Example: 6

instructionsstring | nullable

Example: Handle with care

transport_datestring · date-time | nullable

Example: 2022-01-01T00:00:00Z

carrier_contact_uidstring · uuid | nullable

The UID of the carrier contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.

Example: 123e4567-e89b-12d3-a456-426614174000

organizer_signatory_uidstring · uuid | nullable

The UID of the organizer signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.

Example: 123e4567-e89b-12d3-a456-426614174000

producer_contact_uidstring · uuid | nullable

The UID of the producer contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.

Example: 123e4567-e89b-12d3-a456-426614174000

processor_contact_uidstring · uuid | nullable

The UID of the processor contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.

Example: 123e4567-e89b-12d3-a456-426614174000

processor_signatory_uidstring · uuid | nullable

The UID of the processor signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.dashdoc.eu/api/v4/wam/forms/' \
  --header 'Authentication: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "producer_id": 1,
    "processor_id": 2,
    "carrier_id": 3,
    "organizer_id": 4,
    "origin_id": 5,
    "destination_id": 6,
    "instructions": "Handle with care",
    "transport_date": "2022-01-01T00:00:00Z",
    "carrier_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
    "organizer_signatory_uid": "123e4567-e89b-12d3-a456-426614174000",
    "producer_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
    "processor_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
    "processor_signatory_uid": "123e4567-e89b-12d3-a456-426614174000"
  }'

201

201

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "DAS-1",
  "created": "2022-01-01T00:00:00Z",
  "updated": "2022-01-01T00:00:00Z",
  "status": "completed",
  "pdf": {
    "url": "http://example.com/pdf",
    "updated_date": "2022-01-01T00:00:00Z"
  },
  "discontinued_reason": "Traffic accident",
  "transport_uid": "123e4567-e89b-12d3-a456-426614174000",
  "producer_id": 1,
  "processor_id": 2,
  "carrier_id": 3,
  "organizer_id": 4,
  "origin_id": 5,
  "destination_id": 6,
  "instructions": "Handle with care",
  "transport_date": "2022-01-01T00:00:00Z",
  "carrier_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
  "organizer_signatory_uid": "123e4567-e89b-12d3-a456-426614174000",
  "producer_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
  "processor_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
  "processor_signatory_uid": "123e4567-e89b-12d3-a456-426614174000"
}

Create successful

Delete a waste form

delete

Authorizations

Path parameters

uidstringrequired

Unique identifier of the waste form

Responses

cURL

JavaScript

Python

HTTP

cURL

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

405

405

No body

A waste form cannot be deleted, but cancelling or discontinuing it is allowed from the web app

Read a waste form

get

Authorizations

Path parameters

uidstringrequired

Unique identifier of the waste form

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.dashdoc.eu/api/v4/wam/forms/{uid}/' \
  --header 'Authentication: YOUR_API_KEY'

200

200

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "DAS-1",
  "created": "2022-01-01T00:00:00Z",
  "updated": "2022-01-01T00:00:00Z",
  "status": "completed",
  "pdf": {
    "url": "http://example.com/pdf",
    "updated_date": "2022-01-01T00:00:00Z"
  },
  "discontinued_reason": "Traffic accident",
  "transport_uid": "123e4567-e89b-12d3-a456-426614174000",
  "producer_id": 1,
  "processor_id": 2,
  "carrier_id": 3,
  "organizer_id": 4,
  "origin_id": 5,
  "destination_id": 6,
  "instructions": "Handle with care",
  "transport_date": "2022-01-01T00:00:00Z",
  "carrier_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
  "organizer_signatory_uid": "123e4567-e89b-12d3-a456-426614174000",
  "producer_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
  "processor_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
  "processor_signatory_uid": "123e4567-e89b-12d3-a456-426614174000"
}

Get successful

Update a waste form

patch

Authorizations

Path parameters

uidstringrequired

Unique identifier of the waste form

Body

producer_idinteger | nullable

The ID of the producer company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.

Example: 1

processor_idinteger | nullable

The ID of the processor company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.

Example: 2

carrier_idinteger | nullable

The ID of the carrier company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.

Example: 3

organizer_idinteger | nullable

The ID of the organizer company. You need to have the company created first with the /v4/companies/ endpoint. Make sure you also set the specific details that are mandatory for waste activity with the endpoint /v4/wam/companies/{id}/details/.

Example: 4

origin_idinteger | nullable

The ID of the origin address. If it does not exist, create it first with the /v4/addresses/ endpoint.

Example: 5

destination_idinteger | nullableDeprecated

The ID of the destination address. If it does not exist, create it first with the /v4/addresses/ endpoint. Deprecated because it is no longer used. We now use the processor address as destination.

Example: 6

instructionsstring | nullable

Example: Handle with care

transport_datestring · date-time | nullable

Example: 2022-01-01T00:00:00Z

carrier_contact_uidstring · uuid | nullable

The UID of the carrier contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.

Example: 123e4567-e89b-12d3-a456-426614174000

organizer_signatory_uidstring · uuid | nullable

The UID of the organizer signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.

Example: 123e4567-e89b-12d3-a456-426614174000

producer_contact_uidstring · uuid | nullable

The UID of the producer contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.

Example: 123e4567-e89b-12d3-a456-426614174000

processor_contact_uidstring · uuid | nullable

The UID of the processor contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.

Example: 123e4567-e89b-12d3-a456-426614174000

processor_signatory_uidstring · uuid | nullable

The UID of the processor signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.dashdoc.eu/api/v4/wam/forms/{uid}/' \
  --header 'Authentication: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "producer_id": 1,
    "processor_id": 2,
    "carrier_id": 3,
    "organizer_id": 4,
    "origin_id": 5,
    "destination_id": 6,
    "instructions": "Handle with care",
    "transport_date": "2022-01-01T00:00:00Z",
    "carrier_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
    "organizer_signatory_uid": "123e4567-e89b-12d3-a456-426614174000",
    "producer_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
    "processor_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
    "processor_signatory_uid": "123e4567-e89b-12d3-a456-426614174000"
  }'

200

200

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "DAS-1",
  "created": "2022-01-01T00:00:00Z",
  "updated": "2022-01-01T00:00:00Z",
  "status": "completed",
  "pdf": {
    "url": "http://example.com/pdf",
    "updated_date": "2022-01-01T00:00:00Z"
  },
  "discontinued_reason": "Traffic accident",
  "transport_uid": "123e4567-e89b-12d3-a456-426614174000",
  "producer_id": 1,
  "processor_id": 2,
  "carrier_id": 3,
  "organizer_id": 4,
  "origin_id": 5,
  "destination_id": 6,
  "instructions": "Handle with care",
  "transport_date": "2022-01-01T00:00:00Z",
  "carrier_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
  "organizer_signatory_uid": "123e4567-e89b-12d3-a456-426614174000",
  "producer_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
  "processor_contact_uid": "123e4567-e89b-12d3-a456-426614174000",
  "processor_signatory_uid": "123e4567-e89b-12d3-a456-426614174000"
}

Update successful