...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
1. Exemplo do json:
| Code Block |
|---|
{
"codigo": 1,
"descricao": "Matrícula de Terreno",
"codigo_externo": "EXT123",
"ativo": "S",
"data_alteracao": "01/01/2023 12:00"
} |
...
Todos os endpoints, com exceção do deletar, retornam o json nesse formato.
...
2. Endpoints
2.1 - Buscar matrícula pelo código
Endpoint: /matricula-imovel
Tipo: get
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da matrícula no banco de dados do CRM.
codigoExterno:Tipo: String.Código da matrícula no banco de dados do sistema integrado
...
Resposta: Status 200 - Retorna a matrícula no formato documentado na sessão Exemplo do json
2.2 - Buscar todas as matrículas
Endpoint: /matricula-imovel/todos
Tipo: get
Resposta: Status 200 - Retorna a lista das matrículas no formato documentado na sessão Exemplo do json
2.3 - Cadastrar ou editar matrícula
Endpoint:/matricula-imovel
Tipo: post
Notas:
Informe no corpo da requisição o json conforme exemplo na sessão 1.
Para cadastrar uma nova matrícula não informe o campo “codigo”;
Para editar uma matrícula já existente informe o campo “codigo” com o código da matrícula que deseja editar;
Resposta: Status 200 - Retorna a matrícula cadastrada, no formato documentado na sessão Exemplo do json
2.4 - Inativar uma matrícula
Não é possível deletar uma matrícula, apenas inativar, pois a matrícula pode ter vinculo com atividades econômicas de pessoas. Nesse caso, a matrícula continua no banco de dados porém com o status inativo.
Endpoint:/matricula-imovel
Tipo: delete
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da matrícula no banco de dados do CRM.
codigoExterno:Tipo: String.Código da matrícula no banco de dados do sistema integrado, caso existir.
Resposta: Status 200 - Mensagem: Registro inativado com sucesso.
2.5 - Retornar os metadados da matrícula
Endpoint: /matricula-imovel/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 matrícula
2.6 - Pesquisar
Endpoint: /matricula-imovel/pesquisa
Tipo: post
Notas:
Esse endpointretorna as matrículas baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:
...