post
https://app.fracttal.com/api/work_orders_labels/
Este endpoint cria uma nova label (etiqueta) no catálogo da empresa do despachante autenticado. A operação é idempotente: se já existir uma label com a mesma description (comparação sem distinção de maiúsculas/minúsculas), o serviço retorna a label existente sem criar duplicata e sem gerar erro.
Parâmetros de entrada
Enviados dentro do body:
Obrigatórios
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
account_code | Texto | Sim | Código do pessoal com conta de despacho ativa. Obtido do campo code no endpoint de pessoal. Não pode ser nulo nem vazio. |
description | Texto | Sim | Descrição da label. Máximo de 200 caracteres; é aplicado trim. Se já existir uma label com o mesmo texto (case-insensitive), a existente é retornada sem criar duplicata. |
Opcionais
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
color | Texto | Opcional | Cor em formato hexadecimal (máximo de 10 caracteres). Default FFFFFF. |
Parâmetros de saída
Resposta bem-sucedida HTTP 200:
| Parâmetro | Tipo | Descrição |
|---|---|---|
success | Booleano | true se a operação foi bem-sucedida. |
message | Texto | Código HTTP de resposta. |
total | Inteiro | 1 quando a label foi criada ou já existia. |
data | JSON | Objeto label. |
Estrutura do objeto data:
| Campo | Tipo | Descrição |
|---|---|---|
id | Inteiro | Identificador único da label. |
id_company | Inteiro | Identificador da empresa proprietária da label. |
description | Texto | Nome ou descrição da label. |
color | Texto | Cor da label em formato hexadecimal (sem #). |
enabled | Booleano | true se a label está habilitada. |
Validações e erros
400—account_codeoudescriptionausente, nulo, vazio ou apenas espaços em branco; oudescriptionexcede 200 caracteres.401— Sem autenticação ou conta não autorizada como despachante.404—account_codenão existe no pessoal ou não tem conta ativa.500— Erro interno do sistema.
Diferença em relação a PUT /api/work_orders_labels/
PUT /api/work_orders_labels/| Aspecto | PUT /api/work_orders_labels/ | POST /api/work_orders_labels/ (este endpoint) |
|---|---|---|
| Função | Atribui uma label existente a uma OT. | Cria uma label no catálogo da empresa. |
| Parâmetros obrigatórios | folio OT + id label + account_code. | description + account_code. |
| Parâmetro opcional | — | color (default FFFFFF). |
| Resultado | Label atribuída à OT. | Label criada, ou label existente se já houver. |
Exemplo:
Requisição: (POST) https://app.fracttal.com/api/work_orders_labels/
Body (label nova):
{
"account_code": "USR001",
"description": "Correctivo urgente",
"color": "FF5733"
}Response (label nova criada):
{
"success": true,
"message": "200",
"total": 1,
"data": {"id": 1004, "id_company": 5, "description": "Correctivo urgente", "color": "FF5733", "enabled": true}
}Response (label já existia — mesmo resultado):
{
"success": true,
"message": "200",
"total": 1,
"data": {"id": 1001, "id_company": 5, "description": "Correctivo urgente", "color": "FF5733", "enabled": true}
}Response (erro — description > 200 caracteres):
{
"success": false,
"message": "400",
"total": 0,
"data": [{"ERROR": "description exceeds maximum length of 200 characters"}]
}