Inspecting the booklet
Once the cleaning has been started, it can be found in the active cleaning actions for the cleaning company. Once an action has been selected, the booklet may be opened to view the history of the equipment. The newly started cleaning can be seen there, as well as the three previous loads. After inspection of both the booklet and the container, the cleaning company may decide to cancel, or to continue and perform the cleaning.
It may be possible that the load in the booklet does not match the actual contents of the container. In that case, the cleaning company can add a nonregistered load to the booklet. A proof is needed in the form of one or more documents, such as the CMR.
Get active cleaning actions
GET {eecdapi}/cleaningactions
Usage
Get a list of all active (both planned and completed) cleaning actions
Information
Completed cleaning actions still require a driver’s signature.
Response
Get active cleaning actions
[
{
"equipmentId": "Guid",
"compartments": [],
"id": "Guid",
"lastStatusDate": "2018-09-05T12:57:50.092149Z",
"status": "PLANNED",
"cleanedBy": {
"locationId": "Guid",
"locationName": "string",
"organisationId": "Guid",
"organisationName": "string",
"addressLines": {
"Street and number": "string",
"City": "string",
"PostalCode": "string"
},
"phone": "string",
"fax": "string",
"website": "string"
},
"process": {
"createdBy": "string",
"createdById": "Guid",
"createdAt": "2018-09-05T12:57:50.0928697Z"
},
"type": "STANDARD"
}
]Open the booklet
GET {eecdapi}/equipment/{equipmentId}/history
Usage
Get partial overview of the history of the equipment.
Information
The booklet may be opened to see a partial overview of the history of the equipment. This includes his own cleanings, and the most recent load per compartment.
Result
Open the booklet
{
"equipmentId": "Guid",
"compartments": [
{
"key": "1",
"cleanings": [],
"loads": [
{
"id": "Guid",
"lastStatusDate": "2018-09-06T08:02:19.844Z",
"status": "COMPLETED",
"product": {
"productId": "Guid",
"sellerName": "string",
"productType": "string",
"articleNumber": "string",
"articleName": "string"
},
"loadDetails": {
"loadPlannedAt": "2018-09-06T00:00:00Z",
"chemical companyName": "string",
"loadingLocation": "string"
}
}
]
}
]
}View a full cleaning
GET {eecdapi}/equipment/{equipmentId}/cleaningactions/{cleaningId}
Usage
Get detailed information about for which compartments the cleaning was performed
Information
The history contained in the booklet is always arranged by compartment. This means that a cleaning action performed on multiple compartments, will be added to the history of those compartments. In some cases, a cleaning action performed on multiple compartments may be ‘pushed’ out of the history of one of those compartments
Body (JSON object)
View full cleaning
{
"equipmentId": "Guid",
"compartments": [
{
"key": "1",
"cleaning": {
"codes": ["T01"],
"additional": "string"
},
"valid": false
}
],
"id": "Guid",
"lastStatusDate": "2018-09-26T08:00:04.616Z",
"status": "PLANNED",
"cleanedBy": {
"locationId": "Guid",
"locationName": "string",
"organisationId": "Guid",
"organisationName": "string",
"addressLines": {
"Street and number": "string",
"City": "string",
"PostalCode": "string"
},
"phone": "string",
"fax": "string",
"website": "string"
},
"references": {
"customerReference": "string",
"internalReference": "string"
},
"process": {
"createdBy": "string",
"createdById": "Guid",
"createdAt": "2018-09-05T12:57:50.0928697Z"
},
"type": "STANDARD",
"isUnaccompanied": false
}Download attachment from previous loads
In case a previous load contains an attachment for proof this attachment can be downloaded with the below API call.
GET {eecdapi}/equipment/{equipmentId}/loads/{loadId}/attachments/{attachmentId}
Usage
Get an attachment that proofs an unregistered load
Information
The file will be downloaded directly upon following the link.