Accept a cleaning request (eECO)

There are two ways a cleaning company can plan in a cleaning. One way is to plan a cleaning from scratch by the cleaning company (Plan a cleaning action ), and another way is to accept a cleaning request defined by the transport company. For this a cleaning company can get a list of all cleanings in the REQUESTED state and then plan the cleaning in.

To be able to accept the correct cleaning request you need a couple of items:

The license plate or container id of the equipment for which the cleaning is requested
The id of the cleaning location where the cleaning will be performed
The id of the cleaning request

Choose a cleaning location

Once you decided to accept a cleaning request and start the cleaning action, and in case there are multiple cleaning locations set up within one and the same cleaning organization, a "logged in user" may have access to several cleaning locations and such user can choose the cleaning location where this equipment is being cleaned. 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/users

Usage

Retrieve the available cleaning location for active user

Information

Returns an array of available cleaning locations for logged in user

Result

JSON

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

Find the correct cleaning request (eECO)

The next step in the process is to find the correct cleaning request for the equipment that needs to be cleaned. We can make a call to find all cleanings in a certain state (for cleaning requests we use state REQUESTED), and for a specific search parameter on equipment.

GET {eecdapi}/cleaningactions?status=REQUESTED&search={search}

Usage

Retrieve the available cleanings owned by the logged in cleaning company

Information

Returns an array of available cleanings for the logged in cleaning company

Query string parameters

search: The license plate or container ID of the equipment
status: REQUESTED

Result

JSON

{
  "hitCountTotal": 0,
  "hitCountPage": 0,
  "pageCurrent": 0,
  "pageSize": 0,
  "pageTotal": 0,
  "hasMorePages": true,
  "comment": "string",
  "results": [
    {
      "id": "Guid",
      "equipment": {
        "id": "Guid",
        "uniqueEquipmentId": "string",
        "internalEquipmentCode": "string",
        "licensePlate": "string",
        "operatorId": "Guid",
        "equipmentType": "TANKCONTAINER"
      },
      "compartments": [
        "string"
      ],
      "status": "REQUESTED",
      "displayDate": "2021-05-11T06:32:46.504Z",
      "references": {
        "customerReference": "string",
        "internalReference": "string"
      },
      "cleaningLocationId": "Guid"
    }
  ]
}

Initiate for cleaning

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

Usage

Accept a cleaning request and plan in the cleaning

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)

JSON

{
  "cleaningId": "Guid",
  "locationId": "Guid",
  "type": "Standard",
  "isUnaccompanied": false
}

Validation

CleaningId
The ID of the cleaning request acquired earlier.

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.

Result

JSON

{
    "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"
}

Next steps

You have now successfully set up the first steps of the Cleaning action of the eECD process. You can continue to the next step (performing cleaning).