Consultar el catálogo de labels de órdenes de trabajo

Este endpoint retorna el catálogo completo de labels (etiquetas) habilitadas de la empresa del despachador autenticado. Las labels se utilizan para clasificar las órdenes de trabajo y se devuelven ordenadas alfabéticamente por su description. La consulta es de solo lectura y no modifica información.


📘

Add-on requerido: uso general. Este endpoint no requiere un add-on específico.

Parámetros de entrada

Se envían dentro de body:

Requeridos

ParámetroTipoRequeridoDescripción
account_codeTextoCódigo del personal con cuenta de despacho activa. Se obtiene del campo code en el endpoint de personal. No puede ser nulo ni vacío.

Opcionales

Ninguno.

Parámetros de salida

Respuesta exitosa HTTP 200:

ParámetroTipoDescripción
successBooleanotrue si la operación fue exitosa.
messageTextoCódigo HTTP de respuesta.
totalEnteroNúmero de labels retornadas.
dataArray de JSONArray de objetos label.

Estructura de cada objeto de data:

CampoTipoDescripción
idEnteroIdentificador único de la label.
id_companyEnteroIdentificador de la empresa propietaria de la label.
descriptionTextoNombre o descripción de la label.
colorTextoColor de la label en formato hexadecimal (sin #).
enabledBooleanotrue si la label está habilitada.

Validaciones y errores

  • 400account_code faltante, nulo o vacío.
  • 401 — Sin autenticación o cuenta no autorizada como despachador.
  • 404account_code no existe en personal o no tiene cuenta activa.
  • 500 — Error interno del sistema.

Ejemplo:

Petición: (GET) https://app.fracttal.com/api/work_orders_labels/

Body:

{
  "account_code": "USR001"
}

Response:

{
  "success": true,
  "message": "200",
  "total": 3,
  "data": [
    {"id": 1001, "id_company": 5, "description": "Correctivo", "color": "FF0000", "enabled": true},
    {"id": 1002, "id_company": 5, "description": "Preventivo", "color": "00FF00", "enabled": true},
    {"id": 1003, "id_company": 5, "description": "Predictivo", "color": "0000FF", "enabled": true}
  ]
}

Response
200
Language
LoadingLoading…