Serviço de Logradouros¶

Objetivo¶

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

Endpoints Disponíveis¶

Listagem de Logradouros¶

GET /logradouros

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

Consulta por ID¶

GET /logradouros/{id}

Retorna um logradouro específico pelo seu identificador.

Criação de Logradouro¶

POST /logradouros

Permite criar um novo logradouro no sistema.

Atualização de Logradouro¶

PUT /logradouros/{id}

Permite atualizar um logradouro existente.

Exclusão Lógica de Logradouro¶

DELETE /logradouros/{id}

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

Campos Obrigatórios¶

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

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

Campos Condicionais¶

Alguns campos são condicionais:

• id_tipo_logradouro ou tipo_logradouro_informado
• id_municipio ou municipio_informado

Regras de Negócio¶

1. Logradouros devem estar associados a um município
2. Logradouros podem ter um tipo (rua, avenida, etc.) associado
3. Apenas logradouros de sistemas serão indexados no Elasticsearch