Configurações

🗂️

Sobre esta seção

Como toda a API trabalha por nome (tipo de imóvel, bairro, cidade, característica), e esses cadastros mudam de um convênio para outro, você precisa saber o que aquele convênio aceita antes de escrever. É isso que o catálogo faz: ele é a fonte da verdade, não o PropertyInput genérico da documentação.

Fluxo recomendado antes de publicar um imóvel:

1. GET /schema/property-types → escolha o nome de um tipo de imóvel.
2. GET /schema/properties?propertyType=<nome> → receba as características daquele tipo, com o tipo de dado e as opções válidas.
3. Monte o POST /properties usando esses nomes.

📘

Somente leitura, qualquer escopo de imóvel

Todas as rotas desta seção são somente leitura e aceitam imoveis:read ou imoveis:write: quem escreve precisa saber o que mandar, quem lê precisa interpretar o que recebeu. Nome que não existe no convênio é 422.