1. Exemplo do json:
...
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
...
as comissões
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
...
comissões
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.
...
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.
...
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 endpointretorna os conceitos as comissões baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:
...