Request a cleaning

Introduction

An equipment operator can have it’s equipment cleaned in two ways:

Drive your equipment to a cleaning station and have the equipment cleaned
Send a cleaning request (eECO) in advance so the cleaner knows we will be dropping off our equipment for cleaning

This page handles the second option where we send a cleaning request (eECO = electronical European Cleaning Order) to the cleaner. This request is basically a request to clean a certain equipment on a certain date.

To make this request you need a couple of things:

The id of the cleaner
Optionally the id of the cleaning location
The details of the equipment you want to have cleaned

Identify cleaning company

The following call allows you to get an organisation by either its DUNS, VAT or EORI code. Details include the address and phone number of the organisation. You will need its ID in the next step to search and find the cleaning location.

GET {eecdapi}/organisations/{type}/{code}

Usage

Identify the cleaning company.

Information

Gets an organisation by either its DUNS, VAT or EORI code

Query string parameters

type: Either VAT, DUNS or EORI
code: The value of either the VAT number, DUNS code or EORI code

Response

Get organization

JSON

{
    "id": "Guid",
    "organisationName": "string",
    "addressLines": {
        "Street and number": "string",
        "City": "string",
        "PostalCode": "string"
    },
    "phone": "string",
    "fax": "string",
    "webSite": "string",
    "duns": "string",
    "vat": "string",
    "eori": "string",
    "roles": [
        {
            "id": "Guid",
            "name": "string"
        }
    ]
}

Choose a cleaning location

Optionally you can already specify the cleaning location where you want your equipment cleaned. For this you can make a request to the api to get all available cleaninglocations of a certain cleaning company. The selected cleaning location is used to generate the address details on the eECD so the obtained ID of the cleaning location is used later on in the eECD process.

GET {eecdapi}/cleanings/locations/organisation?organisationId={organisationId}

Usage

Retrieve the available cleaning location of a given organisation

Information

Returns an array of available cleaning locations of a given organisation

Query string parameters

organisationId: The id of the cleaningorganisation retrieved in the previous step

Response: Get cleaning locations of organisation

JSON

[
  {
    "id": "string",
    "createdOn": "2021-05-10T13:22:50.961Z",
    "createdByUser": "string",
    "lastUpdatedOn": "2021-05-10T13:22:50.961Z",
    "lastUpdatedByUser": "string",
    "isDeleted": true,
    "version": "string",
    "organisationId": "string",
    "name": "string",
    "description": "string",
    "phone": "string",
    "fax": "string",
    "website": "string",
    "addressLines": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "people": [
      {
        "id": "string",
        "fullName": "string"
      }
    ],
    "supervisor": "string",
    "dunsCode": "string"
  }
]

Find equipment

Finally you need to know the details of the equipment you want to have cleaned. For this you can search through the equipment of an equipmentoperator.

GET {eecdapi}/equipment?operatorId={operatorId}&search={search}

Usage

Identify the equipment. You will need the retrieved equipment ID later in the cleaning process.

Information

Retrieves the information about a specific equipment
Either license plate or container ID will be returned, but never both

Query string parameters

OperatorId: ID of an operator(see Identify transport Company)
Search: A way to uniquely identify the equipment. This may be either the license plate or the container ID.

Response: Get equipment

JSON

[
    {
        "id": "Guid"
        "operatorId": "Guid",
        "equipmentType": "string",
        "subGroup": "string",
        "numberOfManholes": 0,
        "numberOfCompartments": 0,
        "compartments": [
            {
                "key": "1",
                "volume": 0,
                "baffles": 0
            }
        ],
        "licensePlate": "string",
        "internalEquipmentCode": "string",
        "containerId": "string",
        "isIso6346Compliant": true
    }
]

Request a cleaning

POST {eecdapi}/equipment/{equipmentId}/cleaningactions/request

Usage

Request a cleaning action

Information

Two types of cleaning actions are supported: standard or polymer. The type of cleaning determines whether or not extra cleaning requirements, defined by specific EFTCO codes, need to be performed when completing and inspecting the cleaning. Cleaning actions are considered standard by default. A Polymer cleaning does an automatic validation on the presence of the right EFTCO cleaning codes on the ECD and as described within the EFTCO-ECTA-Cefic best practice guideline for polymer cleaning.
By default, the driver of the equipment needs to verify the cleaning action with his signature. Cleaning companies may choose to mark the cleaning action as "Unaccompanied", meaning that this cleaning will be executed while the driver is not waiting and the cleaned equipment will be picked at a later moment. The truck driver is not present to sign off the ECD however the cleaning station is signing off on behalf of the driver and at the moment of cleaner signoff.

Body (JSON object)

Request cleaning

JSON

{
  "locationId": "Guid",
  "type": "Standard",
  "isUnaccompanied": false
  "cleanerId": "Guid",
  "safetyInfo": {
      "tankUnderPressure": true,
      "nitrogenInTank": true,
      "solidNoPressure": true
  },
  "agentRequest": "string",
  "otherRequests": "string",
  "references": {
      "customerReference": "string",
      "internalReference": "string"
  },
  "compartmentCleanings": [
      {
          "key": "string",
          "cleaning": {
              "codes": [
                  "string"
              ]
          }
      }
  ],
  "estimatedTimeOfArrival": "string",
  "estimatedTimeOfPickup": "string"
}

Validation

CleanerId
The ID of the cleaning company which you want to perform the cleaning.

LocationId
The ID of the cleaning location acquired earlier.

Type
The type of the cleaning, which can be either Standard or Polymer. When omitted, the cleaning will be considered Standard.

IsUnaccompanied

Indicator of whether the driver needs to be present when the cleaning is completed. When omitted, the cleaning action will not be considered unaccompanied, and a driver signature is required.

Response: Request cleaning result

JSON

{
  "locationId": "Guid",
  "type": "STANDARD",
  "isUnaccompanied": true,
  "cleaningId": "Guid",
  "cleanerId": "Guid",
  "estimatedTimeOfArrival": "2021-05-11T10:25:58.560Z",
  "estimatedTimeOfPickup": "2021-05-11T10:25:58.560Z",
  "compartmentCleanings": [
    {
      "key": "string",
      "cleaning": {
        "codes": [
          "string"
        ],
        "additional": "string",
        "commentsPerCode": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      },
      "valid": true,
      "isPolymerComplete": true
    }
  ],
  "references": {
    "customerReference": "string",
    "internalReference": "string"
  },
  "safetyInfo": {
    "tankUnderPressure": true,
    "nitrogenInTank": true,
    "solidNoPressure": true
  },
  "agentRequest": "string",
  "otherRequests": "string"
}

Next steps

You have now successfully requested a cleaning in the eECD process. You can continue to the next step (Accept a cleaning request (eECO) ).