1. Listar Atendimentos
Endpoint:
GET https://api1.tradingworks.net/api/v2/workorders/list
Headers:
AUTH-TOKEN: sua_chave_privada
2. Criar Novo Atendimento
Endpoint:
POST https://api1.tradingworks.net/api/v2/workorders/post
Headers:
AUTH-TOKEN: sua_chave_privada Content-Type: application/json
Campos
Campo | Tipo | Requerido | Exemplo | Observações |
ActivityNumber | string (50) | Não | "CX45" | Identificador opcional do atendimento. |
Title | string (250) | Sim | "Manutenção da caldeira" | Pode incluir identificação do cliente; serve para dar contexto ao atendimento. |
Details | string (1000) | Não | "Executar limpeza preventiva." | Descrição livre dos serviços ou observações. |
ActivityStatusID | integer | Não | 2 | Altera status (apenas para atendimentos existentes): 2 = Aberta; 5 = Finalizada; 6 = Cancelada. |
AssignedToID | integer | Sim | 5435 | ID interno do responsável. Pode usar também AssignedToFullName ou AssignedToEmployeeNumber. |
AssignedToEmployeeNumber | string (50) | Sim | "Z-0984" | Matrícula do responsável, alternativa ao AssignedToID. |
AssignedToFullName | string (750) | Sim | "José Pereira" | Nome completo do responsável, alternativa ao AssignedToID. |
AssignmentsEmployeeNumber | string array | Sim | ["Z-0984","Z-0033"] | Lista de responsáveis; cria atendimentos para cada matrícula. |
RequestedByID | integer | Sim | 5435 | ID interno do solicitante. Pode usar também RequestedByEmployeeNumber ou RequestedByFullName. |
RequestedByEmployeeNumber | string (50) | Sim | "Z-0984" | Matrícula do solicitante, alternativa ao RequestedByID. |
RequestedByFullName | string (750) | Sim | "José Pereira" | Nome completo do solicitante, alternativa ao RequestedByID. |
TeamID | integer | Não | 8977 | ID de time; substitui AssignedToID e cria atendimento para cada membro. |
Team | string (100) | Não | "Manutenção" | Nome do time; mesmo comportamento do TeamID. |
PlannedStartDate | date | Não | "2017-04-23" | Data planejada de início do atendimento. |
PlannedFinishDate | date | Não | "2017-04-28" | Data planejada de conclusão do atendimento. |
AllowDuplication | integer | Não | 0, 1 ou 2 | Controle de duplicação: |
Exemplo – Criando novo atendimento
{
"ActivityNumber":"CX45",
"Title":"Manutenção da caldeira",
"Details":"Mapear os responsáveis pelo processo.",
"AssignedToFullName":"José Pereira",
"RequestedByFullName":"Roberto Prado",
"PlannedStartDate":"2017-04-23",
"PlannedFinishDate":"2017-04-28"
}Exemplo – Com múltiplos responsáveis
{
"ActivityNumber":"CX45",
"Title":"Manutenção da caldeira",
"Details":"Mapear os atores responsáveis pelo processo.",
"AssignmentsEmployeeNumber":[
"121",
"122"
],
"RequestedByFullName":"Roberto Prado",
"PlannedStartDate":"2017-04-23",
"PlannedFinishDate":"2017-04-28"
}