API - Atividades
Objetivo
Descrever métodos de acesso à API de Atividades (Activities).
CustomerStatus
Endpoint
https://api1.tradingworks.net/api/v2/activities/customerstatus
Método
PUT
Headers
AUTH-TOKEN = Sua Chave privada
Dados
| Campo | Tipo | Requerido | Exemplo | Observações |
|---|---|---|---|---|
| Status | integer |
Não | 1 | O campo CustomerStatus não tem nenhuma influência dentro do sistema TradingWorks, podendo assumir qualquer valor inteiro desejável pelo cliente para seus procedimentos internos de importação. |
Exemplo 1
Neste exemplo é atualizado com o status 1 o log de atividade 9999.
https://api1.tradingworks.net/api/v2/activities/customerstatus/9999?status=1
Exemplo 2
Neste exemplo é atualizado com o status NULO o log de atividade 9999.
https://api1.tradingworks.net/api/v2/activities/customerstatus/9999?status
Nova atividade
Endpoint
https://api1.tradingworks.net/api/v2/activities/post
Método
POST
Headers
AUTH-TOKEN = Sua Chave privada Content-Type = application/json
Dados
| Campo | Tipo | Requerido | Exemplo | Observações |
|---|---|---|---|---|
| ActivityNumber | string (50) |
Não | "CX45" | |
| Title | string (250) |
Sim | "Manutenção da caldeira" | O título pode conter informações que sejam relevantes para identificação da atividade como por exemplo o nome do cliente. |
| Details | string (1000) |
Não | "Executar todo o processo de limpeza e manutenção preventiva." | |
| Template | string |
Não | "Help Desk" | Deve ser informado exatamente o título do formulário cadastrado. Se o nome do template (formulário) não for informado, será usado o primeiro formulário encontrado na empresa. |
| CustomerNumber | string (255) |
Não | "C-456" | Número do cliente que deverá ser vinculado à atividade. Se o cliente for novo, o campo CustomerName deve ser informado. |
| CustomerName | string (255) |
Não | "Siderúrgica Nacional S/A" | Campo necessário somente quando o cliente não existir cadastrado (CustomerNumber inexistente). |
| ProjectNumber | string |
Não | "PAX-342-A" | Código do projeto que a atividade pertence. Se informado código inexistente a atividade é criada, mas não vinculada a nenhum projeto, podendo ser editada posteriormente sem prejuízo da informação. |
| ActivityStatusID | integer |
Não | 2 | Altera o status da atividade (apenas para atividades já existentes). Valores permitidos: 2 - Aberta 5 - Finalizada 6 - Cancelada |
| AssignedToID | integer |
Sim | 5435 | O ID é o código interno da TradingWorks para designar quem é o responsável pela atividade. Opcionalmente pode ser usado o campo AssignedToFullName ou AssignedToEmployeeNumber. |
| AssignedToEmployeeNumber | string (50) |
Sim | "Z-0984" | Número da matrícula do colaborador em substituição do campo AssignedToID. |
| AssignedToFullName | string (750) |
Sim | "José Pereira" | Nome completo do colaborador em substituição do campo AssignedToID. |
| AssignmentsEmployeeNumber | string array |
Sim | "Z-0984", "Z-0033", "Z-0742" | Lista de matrículas de colaboradores responsáveis pela atividade. Pode ser usado em substituição do Team ou do AssignedToID. |
| RequestedByID | integer |
Sim | 5435 | O ID é o código interno da TradingWorks para designar quem é o solicitante da atividade. Opcionalmente pode ser usado o campo RequestedByFullName ou RequestedByEmployeeNumber. |
| RequestedByEmployeeNumber | string (50) |
Sim | "Z-0984" | Número da matrícula do colaborador em substituição do campo RequestedByID. |
| RequestedByFullName | string (750) |
Sim | "José Pereira" | Nome completo do colaborador em substituição do campo RequestedByID. |
| TeamID | integer |
Não | 8977 | ID interno da TradingWorks do time. Se informado, substitui o AssignedToID e cria uma atividade para cada membro do time. |
| Team | string (100) |
Não | "Manutenção de caldeiras" | Nome do time. Se informado, substitui o AssignedToID e cria uma atividade para cada membro do time. |
| PlannedStartDate | date |
Não | "2017-04-23" | |
| PlannedFinishDate | date |
Não | "2017-04-28" | |
| AllowDuplication | integer |
Não | 0, 1 ou 2 | Valor padrão: 0 0 - Não cria nova atividade se ActivityNumber já existir independente do responsável da atividade. 1 - Não cria nova atividade se ActivityNumber já existir para o responsável da atividade. 2 - Cria nova atividade sob qualquer condição. Quando o valor for 0 ou 1 apenas atualiza Title, Details, PlannedStartDate, PlannedFinishDate. E quando o valor for 1 também cria novas atividades em caso de designação para times ou lista de responsáveis. Exemplo: Atividade designada a um time. Novos colaboradores foram adicionados a este time. Se esta opção estiver 1, ela não duplicará atividade para os já existentes e criará novas para os colaboradores que ainda não tem. |
Exemplo
{
"ActivityNumber": "CX45",
"Title": "Manutenção da caldeira",
"Details": "Mapear os atores responsáveis pelo processo.",
"AssignedToFullName": "José Pereira",
"RequestedByFullName": "Roberto Prado",
"PlannedStartDate": "2017-04-23",
"PlannedFinishDate": "2017-04-28"
}
Exemplo com lista de 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"
}