get
https://app.fracttal.com/api/work_orders_labels/
Este endpoint retorna o catálogo completo de labels (etiquetas) habilitadas da empresa do despachante autenticado. As labels são usadas para classificar as ordens de trabalho e são retornadas em ordem alfabética pela sua description. A consulta é somente leitura e não modifica informações.
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. |
Opcionais
Nenhum.
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 | Número de labels retornadas. |
data | Array de JSON | Array de objetos label. |
Estrutura de cada objeto de 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_codeausente, nulo ou vazio.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.
Exemplo:
Requisição: (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}
]
}