Endpoints - Atividades

1. Exemplo do json:

[
  {
    "codigo": 1
    "descricao": "Atividade de exemplo",
    "predominio": "A",
    "codigo_externo": "EXT123",
    "data_alteracao": "16/08/2024 13:24"
  }
]

Campos:

codigo: Código do registro no banco de dados do CRM
descricao: Descrição da atividade informada no cadastro do registro.
predominio: Predomínio da atividade. Podendo receber os valores (A) Agropecuária - (P) Pecuária.
codigo_externo: Código da atividade no sistema integrado.
data_alteração: Data da última alteração do registro no banco de dados do CRM. Não deve ser enviado no JSON, pois é preenchido automaticamente ao salvar/editar o registro.

Todos os endpoints, com exceção do deletar, retornam o json nesse formato.

2. Endpoints

2.1 - Buscar uma atividade pelo código

Endpoint: /atividade

Tipo: get

Parâmetros:

codigoInterno: Tipo: Inteiro. Código da atividade no banco de dados do CRM.
codigoExterno: Tipo: String. Código da atividade no banco de dados do sistema integrado

Validações: É necessário informar pelo menos um dos parâmetros. Caso informado os dois o sistema prioriza o código externo.

Resposta: Status 200 - Retorna a atividade no formato documentado na sessão Exemplo do json

2.2 - Buscar todas as atividades

Endpoint: /atividade/todos

Tipo: get

Resposta: Status 200 - Retorna a lista das atividades no formato documentado na sessão Exemplo do json

2.3 - Cadastrar ou editar atividades

Endpoint: /atividade

Tipo: post

Notas:

Informe no corpo da requisição o json conforme exemplo na sessão 1.
Para cadastrar uma nova atividade não informe o campo “codigo”;
Para editar uma atividade já existente informe o campo “codigo” com o código da atividade que deseja editar;
O campo descrição é obrigatório;
Serão permitidos o cadastro/edição de até 20 itens por vez.

Resposta: Status 200 - Retorna a atividade cadastrada, no formato documentado na sessão Exemplo do json

2.4 - Deletar uma atividade

Endpoint: /atividade

Tipo: delete

Parâmetros:

codigoInterno: Tipo: Inteiro. Código da atividade no banco de dados do CRM.
codigoExterno: Tipo: String. Código da atividade no banco de dados do sistema integrado, caso existir.

Resposta: Status 200 - Mensagem: Registro deletado com sucesso.

2.5 - Retornar os metadados da atividade

Endpoint: /atividade/metadados

Tipo: get

Descrição: Retorna os campos do json, com as informações de tipo, tamanho máximo, se o campo é requerido, filtrável e/ou ordenável

Resposta: Status 200 - Retorna um json com as informações dos campos da atividade

2.6 - Pesquisar

Endpoint: /atividade/pesquisa

Tipo: post

Notas:

Esse endpoint retorna as atividades baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:
{ "pagina": 1, "quantidadeRegistros": 10, "filtros": [ { "campo": "descricao", "comparacao": "CONTEM", "valor": "ATIVIDADE" } ], "ordenacao": [ { "campo": "descricao", "ordenacao": "ASC" } ] }
Nesse exemplo, estamos filtrando todas as atividade cuja descrição possua o texto “ATIVIDADE”, também estamos ordenando os registros pela descrição de forma ascendente.