1. Exemplo do json:
[ { "codigo": 123, "descricao": "Comissão 1", "codigo_externo": "123", "data_alteracao": "2024-09-14T19:54:03.210Z", "ativo": "S" } ]
Campos:
codigo: Código único da comissão no nosso sistema.
descricao: Descrição da comissão.
codigo_externo: Código externo da comissão
data_alteracao: Data da última alteração do registro. Não deve ser enviado no json, pois é preenchido automaticamente pelo sistema.
ativo: Indica se a comissão está ativa. Valores aceitos: S (Sim), N (Não)
2. Endpoints
2.1 - Buscar Comissões pelo código
Endpoint: /pessoa-comissao
Tipo: get
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da comissão no banco de dados do CRM.
Resposta: Status 200 - Retorna a comissão no formato documentado na sessão Exemplo do json
2.2 - Buscar todos os conceitos
Endpoint: /pessoa-comissao/todos
Tipo: get
Resposta: Status 200 - Retorna a lista de comissões no formato documentado na sessão Exemplo do json
2.3 - Cadastrar ou editar conceitos
Endpoint: /pessoa-comissao
Tipo: post
Notas:
Informe no corpo da requisição o json conforme exemplo na sessão 1.
Para cadastrar uma nova comissão não informe o campo “codigo”;
Para editar uma comissão já existente informe o campo “codigo” com o código da comissão que deseja editar;
Serão permitidos o cadastro/edição de até 20 itens por vez.
Resposta: Status 200 - Retorna a comissão cadastrada, no formato documentado na sessão Exemplo do json
2.4 - Inativar uma comissão
Não é possível deletar uma comissão, apenas inativar, pois a comissão pode ter vinculo com pessoas. Nesse caso, a comissão continua no banco de dados porém com o status inativo.
Endpoint: /pessoa-comissao
Tipo: delete
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da comissão no banco de dados do CRM.
codigoExterno: Tipo: String. Código da comissão no banco de dados do sistema integrado, caso existir.
Resposta: Status 200 - Mensagem: Registro inativado com sucesso.
2.5 - Retornar os metadados das comissões
Endpoint: /pessoa-comissao/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 das comissões
2.6 - Pesquisar
Endpoint: /pessoa-comissao/pesquisa
Tipo: post
Notas:
Esse endpoint retorna os conceitos baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:
{ "pagina": 1, "quantidadeRegistros": 10, "filtros": [ { "campo": "descricao", "comparacao": "COMECA_COM", "valor": "C" } ], "ordenacao": [ { "campo": "descricao", "ordenacao": "ASC" } ] }
Nesse exemplo, estamos filtrando todas as comissões cuja descrição começa com a letra C, ordenadas por descrição;