Cleaning Types

Cleaning types define the specific procedure the driver must perform when an incompatibility between categories requires it. Each type has a name, description, and icon.

Typical examples: "High-pressure water wash", "Dry cleaning", "Manual sweep".

Fields

Field	Type	Required	Description
protocolId	uuid	✅	Protocol this type belongs to.
name	string	✅	Name of the cleaning procedure.
description	string	✅	Detailed description of how to perform the cleaning. Shown to the driver.
imageIndex	integer	✅	Icon index representing the type in the app.
categoryId	uuid	❌	Optional category the type belongs to (informational only).

Relationship with incompatibilities

When an incompatibility has action: "cleaning", its cleaningTypeId field points to one of these types. The driver sees the type's name, description, and icon, and must confirm it before proceeding.

A single type can be referenced by multiple incompatibilities.

Source and read-only fields

Value	Description
native	Created directly in DigiAnt.
erp	Imported from the ERP.

For erp-origin types, the name field is read-only from DigiAnt. The description and imageIndex fields can be updated regardless of the source.

Managing via Partner API

List

GET /partner/cleaning-types?protocolId={id}
X-Partner-API-Key: dpk_live_...

Create

POST /partner/cleaning-types
X-Partner-API-Key: dpk_live_...
Content-Type: application/json

{
  "protocolId": "protocol-uuid",
  "name": "High-pressure water wash",
  "description": "Use a high-pressure hose on the entire truck bed for at least 10 minutes.",
  "imageIndex": 2,
  "categoryId": "category-uuid"
}

Update

PATCH /partner/cleaning-types/{id}
X-Partner-API-Key: dpk_live_...
Content-Type: application/json

{
  "description": "Updated procedure description.",
  "imageIndex": 4
}

All fields are optional in the PATCH. Attempting to change name on an erp-origin type returns 400.