Serviço de Bairros¶

Objetivo¶

O serviço de Bairros permite a consulta e gestão de bairros associados aos endereços.

Endpoints Disponíveis¶

Listagem de Bairros¶

GET /bairros

Permite pesquisar bairros com diversos filtros e parâmetros de paginação.

Consulta por ID¶

GET /bairros/{id}

Retorna um bairro específico pelo seu identificador.

Criação de Bairro¶

POST /bairros

Permite criar um novo bairro no sistema.

Atualização de Bairro¶

PUT /bairros/{id}

Permite atualizar um bairro existente.

Exclusão Lógica de Bairro¶

DELETE /bairros/{id}

Realiza uma exclusão lógica do bairro, alterando seu status para inativo.

Campos Obrigatórios¶

Os seguintes campos são obrigatórios para a criação de um bairro:

• id_sistema_origem: Identificador do sistema responsável pelo bairro
• nome: Nome do bairro

Campos Condicionais¶

Alguns campos são condicionais:

• id_municipio ou municipio_informado

Regras de Negócio¶

1. Bairros devem estar associados a um município
2. Apenas bairros de sistemas serão indexados no Elasticsearch