3. Modelos de avisos de la API

En esta página

Esta sección detalla las estructuras de datos y los endpoints de la API que te ayudarán a obtener los valores y catálogos necesarios para construirlos correctamente.

Modelo de avisos de clasificados

Un aviso clasificado representa una propiedad individual (ej. una casa).

Campo	Descripción	Obligatorio / Sugerido
codigoAviso	Tu identificador único para el aviso.	Requerido
titulo	Título del aviso (máx. 80 caracteres).	Requerido
descripcion	Descripción detallada de la propiedad (mín. 50 caracteres).	Requerido
publicador	Objeto con la información de contacto de la inmobiliaria.	Requerido
publicacion	Objeto que define el plan de publicación a utilizar.	Requerido
tipoDePropiedad	Objeto que define el tipo y subtipo de la propiedad usando IDs.	Requerido
localizacion	Objeto con la información de la ubicación de la propiedad.	Requerido
precios	Array de objetos, cada uno definiendo una operación y su precio.	Requerido
caracteristicas	Array de objetos con los atributos de la propiedad.	Requerido
multimedia	Objeto que contiene arrays para imágenes, planos, videos, etc.	Requerido
planos	Incluir al menos un plano en multimedia.planos es sugerido para evitar el warning WARN-0207.	Sugerido
Características	Incluir SUPERFICIE_TOTAL, MEDIO_BANO y GARAGE es sugerido para evitar warnings.	Sugerido

Modelo de avisos de desarrollos y unidades

Un desarrollo es un aviso que agrupa a varios avisos llamados unidades (ej. un edificio con departamentos). El modelo de Desarrollo comparte los campos de un aviso clasificado y agrega los siguientes:

Campo	Descripción	Obligatorio
unidades	Array que contiene los avisos de cada unidad. Siempre se debe enviar el array completo al modificar.	Requerido
etapaDesarrollo	ID que indica la fase del proyecto (ej. "Pre-venta").	Requerido
fechaEntrega	Fecha estimada en que el desarrollo será finalizado.	Opcional
urlLogo	URL del logotipo de la constructora o del proyecto.	Opcional

Modelo de unidad

La estructura de una unidad es idéntica a la de un aviso clasificado.

Importante: el codigoAviso de cada unidad debe ser único en todo el sistema.
Recomendación: se recomienda enviar todos los campos completos para cada unidad, incluso si comparte datos con el aviso de desarrollo (como la localizacion) para asegurar la correcta indexación.

Endpoints de catálogo y soporte

Ubicaciones

Las ubicaciones están organizadas en una jerarquía de árbol. Para obtener la idUbicacion final (ej. una ciudad o barrio), tenés que navegar desde el nivel superior hasta el inferior realizando llamadas consecutivas.

Obtener nivel superior: para obtener la lista de ubicaciones del primer nivel (ej. Provincias en Argentina) usá:

**GET /v1/ubicaciones**

Obtener siguientes niveles: tomá el id de la ubicación deseada del paso anterior y usalo para consultar el siguiente nivel con:

 **GET /v1/ubicaciones/{id}.**

Repetir: repetí el paso 2 con los nuevos IDs obtenidos hasta llegar al nivel más bajo requerido para el aviso.

Otros catálogos

Propiedades y características:

GET /v1/tipopropiedades y GET /v1/tipopropiedades/desarrollos

GET /v1/tipopropiedades/{id}/subtipos

GET /v1/tipopropiedades/{id}/caracteristicas

Publicación y operaciones:
Multimedia y desarrollos:

Información de campos

Usá estos endpoints para obtener metadatos y descripciones detalladas de cada campo de los modelos, como complemento a esta documentación.

GET /v1/informacion/aviso/{campo}

GET /v1/informacion/desarrollo/{campo}