Saltar al contenido principal

Tipos de limpieza

Los tipos de limpieza definen el procedimiento concreto que debe aplicar el conductor cuando una incompatibilidad entre categorías lo requiere. Cada tipo tiene nombre, descripción e icono.

Ejemplos típicos: "Lavado con agua a presión", "Limpieza en seco", "Barrido manual".

Campos

CampoTipoRequeridoDescripción
protocolIduuidProtocolo al que pertenece el tipo.
namestringNombre del procedimiento de limpieza.
descriptionstringDescripción detallada de cómo realizar la limpieza. Se muestra al conductor.
imageIndexintegerÍndice del icono que representa el tipo en la app.
categoryIduuidCategoría opcional a la que pertenece el tipo (solo informativo).

Relación con incompatibilidades

Cuando una incompatibilidad tiene action: "cleaning", su campo cleaningTypeId apunta a uno de estos tipos. El conductor verá el nombre, descripción e icono del tipo asignado y deberá confirmarlo antes de proceder.

Un tipo puede estar referenciado por múltiples incompatibilidades.

Origen y campos de solo lectura

ValorDescripción
nativeCreado directamente en DigiAnt.
erpImportado desde el ERP.

Para tipos de origen erp, el campo name es de solo lectura desde DigiAnt. Los campos description e imageIndex pueden actualizarse independientemente del origen.

Gestión vía Partner API

Listar

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

Crear

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

{
"protocolId": "uuid-del-protocolo",
"name": "Lavado con agua a presión",
"description": "Utilizar manguera de alta presión en toda la caja del vehículo durante al menos 10 minutos.",
"imageIndex": 2,
"categoryId": "uuid-de-categoria"
}

Actualizar

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

{
"description": "Descripción actualizada del procedimiento.",
"imageIndex": 4
}

Todos los campos son opcionales en el PATCH. Intentar cambiar name en un tipo de origen erp devuelve 400.