Consulta e manutenção do cadastro de condomínios e empreendimentos.
Sobre esta seçãoCadastrar, consultar e alterar os condomínios e empreendimentos do convênio. O condomínio é o que dá endereço, construtora e matrícula às unidades: um imóvel vinculado a ele herda esses dados.
Escopos: leitura com
condominios:read, escrita comcondominios:write
Regras que valem para toda a seção:
| Regra | O que significa |
|---|---|
| 🏷️ Referência por nome, nunca por id | neighborhood (bairro) e builder (construtora) vão pelo nome, resolvido no cadastro do convênio. Você não precisa conhecer os ids internos. |
| 🚫 Nome errado recusa, não cria | Nome que não existe, ou que casa com mais de um registro, devolve 422 (UNKNOWN_NAME ou AMBIGUOUS_NAME). A API nunca cadastra um bairro ou uma pessoa por conta própria: erro de digitação viraria lixo no cadastro do convênio. |
| 🏙️ Cidade vem do bairro | O condomínio não tem cidade nem estado próprios: os dois saem do bairro vinculado. Envie city apenas para desempatar o bairro — "Centro" existe em quase toda cidade. |
| 🔁 Formato simétrico | O que o GET /{id} devolve é o mesmo formato que o PUT aceita de volta: você lê, altera e reenvia sem tradução. |
| 🚪 Acessos adicionais | addresses são entradas extras (portaria, acesso de serviço): informativos, fora da busca e do geo. No PUT, enviar a lista substitui todas; omitir não mexe; [] apaga. |
