Forms
A page number within the paginated result set.
Filter waste forms by uid
Filter waste forms by creation date
Filter waste forms created after a certain date
Filter waste forms created on or after a certain date
Filter waste forms created before a certain date
Filter waste forms created on or before a certain date
The status of the waste shipment
completed
Possible values: Filter waste forms by multiple statuses, comma separated
cancelled,discontinued
GET /api/v4/wam/forms/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
Get successful
{
"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,
"instructions": "Handle with care",
"sea_ship_name": "Sea ship name",
"sea_ship_imo_number": "IMO1234567",
"sea_ship_mmsi_number": "123456789",
"sea_ship_eni_number": "12345678",
"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"
}
]
}
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/.
1
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/.
2
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/.
3
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/.
4
The ID of the origin address. If it does not exist, create it first with the /v4/addresses/ endpoint.
5
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.
6
Handle with care
Name of the sea ship
Sea ship name
IMO number of the sea ship
IMO1234567
MMSI number of the sea ship
123456789
ENI number of the sea ship
12345678
2022-01-01T00:00:00Z
The UID of the carrier contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.
123e4567-e89b-12d3-a456-426614174000
The UID of the organizer signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.
123e4567-e89b-12d3-a456-426614174000
The UID of the producer contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.
123e4567-e89b-12d3-a456-426614174000
The UID of the processor contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.
123e4567-e89b-12d3-a456-426614174000
The UID of the processor signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.
123e4567-e89b-12d3-a456-426614174000
POST /api/v4/wam/forms/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 605
{
"producer_id": 1,
"processor_id": 2,
"carrier_id": 3,
"organizer_id": 4,
"origin_id": 5,
"instructions": "Handle with care",
"sea_ship_name": "Sea ship name",
"sea_ship_imo_number": "IMO1234567",
"sea_ship_mmsi_number": "123456789",
"sea_ship_eni_number": "12345678",
"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
{
"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,
"instructions": "Handle with care",
"sea_ship_name": "Sea ship name",
"sea_ship_imo_number": "IMO1234567",
"sea_ship_mmsi_number": "123456789",
"sea_ship_eni_number": "12345678",
"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"
}
Unique identifier of the waste form
DELETE /api/v4/wam/forms/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
A waste form cannot be deleted, but cancelling or discontinuing it is allowed from the web app
No content
Unique identifier of the waste form
GET /api/v4/wam/forms/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
Get successful
{
"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,
"instructions": "Handle with care",
"sea_ship_name": "Sea ship name",
"sea_ship_imo_number": "IMO1234567",
"sea_ship_mmsi_number": "123456789",
"sea_ship_eni_number": "12345678",
"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"
}
Unique identifier of the waste form
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/.
1
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/.
2
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/.
3
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/.
4
The ID of the origin address. If it does not exist, create it first with the /v4/addresses/ endpoint.
5
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.
6
Handle with care
Name of the sea ship
Sea ship name
IMO number of the sea ship
IMO1234567
MMSI number of the sea ship
123456789
ENI number of the sea ship
12345678
2022-01-01T00:00:00Z
The UID of the carrier contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.
123e4567-e89b-12d3-a456-426614174000
The UID of the organizer signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.
123e4567-e89b-12d3-a456-426614174000
The UID of the producer contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.
123e4567-e89b-12d3-a456-426614174000
The UID of the processor contact. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.
123e4567-e89b-12d3-a456-426614174000
The UID of the processor signatory. If it does not exist, create it first with the /v4/wam/contacts/ endpoint.
123e4567-e89b-12d3-a456-426614174000
PATCH /api/v4/wam/forms/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 605
{
"producer_id": 1,
"processor_id": 2,
"carrier_id": 3,
"organizer_id": 4,
"origin_id": 5,
"instructions": "Handle with care",
"sea_ship_name": "Sea ship name",
"sea_ship_imo_number": "IMO1234567",
"sea_ship_mmsi_number": "123456789",
"sea_ship_eni_number": "12345678",
"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
{
"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,
"instructions": "Handle with care",
"sea_ship_name": "Sea ship name",
"sea_ship_imo_number": "IMO1234567",
"sea_ship_mmsi_number": "123456789",
"sea_ship_eni_number": "12345678",
"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"
}
Last updated
Was this helpful?