Crear una etiqueta de orden de trabajo

Este endpoint crea una nueva label (etiqueta) en el catálogo de la empresa del despachador autenticado. La operación es idempotente: si ya existe una label con la misma description (comparación no sensible a mayúsculas/minúsculas), el servicio retorna la label existente sin crear un duplicado y sin generar error.

📘

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.
descriptionTextoDescripción de la label. Máximo 200 caracteres; se aplica trim. Si ya existe una label con el mismo texto (case-insensitive), se retorna la existente sin crear duplicado.

Opcionales

ParámetroTipoRequeridoDescripción
colorTextoOpcionalColor en formato hexadecimal (máximo 10 caracteres). Default FFFFFF.

Parámetros de salida

Respuesta exitosa HTTP 200:

ParámetroTipoDescripción
successBooleanotrue si la operación fue exitosa.
messageTextoCódigo HTTP de respuesta.
totalEntero1 cuando la label fue creada o ya existía.
dataJSONObjeto label.

Estructura del objeto 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 o description faltante, nulo, vacío o solo espacios en blanco; o description supera 200 caracteres.
  • 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.

Diferencia con PUT /api/work_orders_labels/

AspectoPUT /api/work_orders_labels/POST /api/work_orders_labels/ (este endpoint)
FunciónAsigna una label existente a una OT.Crea una label en el catálogo de la empresa.
Parámetros obligatoriosfolio OT + id label + account_code.description + account_code.
Parámetro opcionalcolor (default FFFFFF).
ResultadoLabel asignada a la OT.Label creada, o label existente si ya había.

Ejemplo:

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

Body (label nueva):

{
  "account_code": "USR001",
  "description": "Correctivo urgente",
  "color": "FF5733"
}

Response (label nueva creada):

{
  "success": true,
  "message": "200",
  "total": 1,
  "data": {"id": 1004, "id_company": 5, "description": "Correctivo urgente", "color": "FF5733", "enabled": true}
}

Response (label ya existía — mismo resultado):

{
  "success": true,
  "message": "200",
  "total": 1,
  "data": {"id": 1001, "id_company": 5, "description": "Correctivo urgente", "color": "FF5733", "enabled": true}
}

Response (error — description > 200 caracteres):

{
  "success": false,
  "message": "400",
  "total": 0,
  "data": [{"ERROR": "description exceeds maximum length of 200 characters"}]
}

Response
200
Language
LoadingLoading…