- Documentación (API v1.0)

Listado de Paises

 - No requiere parámetros

Listado de Provincias

 - Parámetros: idPais  (En el link, el parámetro por default es idPais=1)

Listado de Areas

 - Parámetros: idProvincia  (En el link, el parámetro por default es idProvincia=1)

Listado de Barrios

 - Parámetros: idArea  (En el link, el parámetro por default es idArea=1)

Listado de Countries

 - No requiere parametros

Listado de Productos

 - No requiere parámetros

Listado de Subproductos

 - Parámetros: idProducto  (En el link, el parámetro por default es idProducto=1)

Listado de datos Extras

 - No requiere parámetros
- Moneda / Tipo de operación / Estado de oferta / Estado de unidad / Orientación de la unidad / Ubicación de la unidad / Categoría

Listado de ofertas por inmobiliaria:

Url: http://api.topinmobiliario.com/consultarinventario.php?usuario=UsuarioInmobiliaria&clave=ClaveDeUsuario

- Parámetros: usuario, clave

Buscador de ofertas por inmobiliaria:

Url: http://api.topinmobiliario.com/buscadorinmobiliaria.php?usuario=UsuarioInmobiliaria&clave=ClaveDeUsuario

- Parámetros: usuario, clave, (idPais, idProvincia, idArea, idBarrio, idProducto, idSubproducto, idOperacion, cantidad (Cantidad de resultados por página), pagina (Número de página), precioDesde, precioHasta,
orden:
Devuelve el resultado ordenado.
0: Operación y precio.
1: Dirección.
2: Tipo de producto.
3: Operación y precio Descendente.
4: Dirección Descendente.
5: Tipo de producto Descendente.
* Parámetros opcionales
- Retorna un Array con 3 elementos: Ofertas, CantidadOfertas, CantidadPaginas.

Obtener una oferta por código:

Url: http://api.topinmobiliario.com/consultaroferta.php?CodInmobiliaria=codigoInmob&CodOferta=codigoOferta&usuario=UsuarioInmobiliaria&clave=ClaveDeUsuario

- Parámetros: CodInmobiliaria, CodOferta, usuario, clave

JSON Oferta

La oferta debe enviarse en formato JSON en el body de un POST al siguiente link:

Url: http://api.topinmobiliario.com

Ejemplo de oferta: (Los campos que aparecen en el json son comunes a todas las ofertas)

{
  "usuario":"PRU",
  "clave":"pruebas2001",
  "codigoInmobiliaria":"PRU",
  "codigoOferta":"50",
  "idOrigen":"50",
  "activo":"1",
  "idPais":"1",
  "idProvincia":"1",
  "idArea":"1",
  "idBarrio":"6",
  "idProducto":"1",
  "idSubProducto":"2",
  "idOperacion":"1",
  "idMoneda":"2",
  "idEstado":"1",
  "calle":"Av. Santa Fe",
  "altura":"2500",
  "permuta":"1",
  "impuestoInmobiliario":"1500",
  "impuestoABL":"600",
  "servicioAgua":"900",
  "latitud":"-34.6345539",
  "longitud":"-58.5758123",
  "descripcionDestacada":"Descripción de la propiedad.",
  "precio":"250000.00",
  "fotos":["http://urlfotos.com/foto1.jpg","http://urlfotos.com/foto1.jpg"],
  "planos":["http://urlplanos.com/plano.gif"]
}


Datos comunes a todos los tipos de oferta

Nombre campo Descripción Tipo Obligatorio Parámetros
usuario Nombre de usuario asignado Texto Si
clave Clave asignada al usuaro Texto Si
codigoInmobiliaria Cod. de identificación inmobiliaria en TOP texto Si
codigoOferta Número de oferta en TOP Número entero No
idOrigen Id del sistema de origen Texto Si
activo Indica si la oferta se publica en Top Inmobiliario. 1 / 0 Si
idPais ID del País Ver listado Si
idProvincia ID de provincia Ver listado Si idPais
idArea ID de area Ver listado Si idProvincia
idBarrio ID de barrio Ver listado Si idArea
idProducto ID de tipo de producto Ver listado Si
idSubProducto ID de subproducto Ver listado Si idProducto
idOperacion ID de operación Ver listado Si
idMoneda ID de moneda Ver listado Si
idEstado ID estado de la oferta Ver listado Si
calle Nombre de la calle Texto Si
altura Altura de la calle Número entero No
permuta Indica si permuta 1 / 0 No
impuestoInmobiliario Valor del impuesto inmobiliario Texto No
impuestoABL Valor del impuesto ABL Texto No
servicioAgua Valor del servicio AGUA Texto No
latitud Latitud Numérico No
longitud Longitud Numérico No
descripcionDestacada Descripción de la oferta Texto No
precio Precio de la oferta Numérico Si
fotos URLs de imagenes Vector de urls No
planos URLs de imagenes Vector de urls No

Campos por tipo de producto

Departamento

Nombre campo Descripción Tipo Obligatorio
superficieCubierta Superficie cubierta Numérico Si
superficieTotal Superficie total Numérico Si
antiguedad Antigüedad Número entero No
cochera Cocheras Si / No / Número entero No
piso Piso de la unidad Número entero Si
amoblado Amoblado Si / No No
aptoProfesional Apto profesional Si / No No
telefono Incluye teléfono Si / No No
luminosidad Luminosidad Número de 1 a 10 No
entreCalles Entre calles Texto No
terraza Tiene terraza Si / No No
balcon Tiene balcón Si / No No
comedor Medidas comedor Texto No
cocina Medidas cocina Texto No
living Medidas living Texto No
cantidadCocheras Cocheras Si / No / Número entero No
cantidadBanios Cantidad de baños Número entero No
toiletrecepcion Toilette de recepción Si / No No
toilet Toilette Si / No No
escritorio Escritorio Texto No
pileta Incluye pileta Si / No No
lavadero Medidas lavadero Texto No
aguaCorriente Incluye agua corriente Si / No No
gasnatural Incluye gas natural Si / No No
orientacion Orientación de la unidad Ver listado No
estadoUnidad Estado de la unidad Ver listado No
unidad Número o letra de unidad Número o letra No
ubicacion Ubicación de la unidad Ver listado No
Categoria Categoria Ver listado No
expensas Precio de expensas Numérico No
cantidadPisos Cantidad de pisos del edificio Número entero No

Casa

Nombre campo Descripción Tipo Obligatorio
superficieCubierta Superficie cubierta Numérico Si
superficieTotal Superficie del terreno Numérico Si
antiguedad Antigüedad Número entero No
cantidadCocheras Cantidad de cocheras Número entero No
telefono Incluye teléfono Si / No No
cantidadDormitorios Cantidad de dormitorios Número entero No
escritorio Medidas escritorio Texto No
estadoUnidad Estado de la unidad Ver listado No
frente Medida del frente Texto No
superficieFondo Superficie del fondo Texto No
garage Contiene garage Si / No No
gasnatural Gas natural Si / No No
largo Largo del terreno Numérico No
lavadero Lavadero Si / No / Número entero No
toiletrecepcion Toilette de recepción Si / No No
toilet Toilette Si / No No
escritorio Escritorio Texto No
pileta Incluye pileta Si / No No
quincho Incluye quincho Si / No No
terraza Incluye terraza Si / No No
cantidadDormitorios Cantidad de dormitorios Si / No No
entreCalles Ubicación entre calles Texto No
patios Medida patios Texto No

Oficina

Nombre campo Descripción Tipo Obligatorio
superficieCubierta Superficie cubierta Numérico Si
superficieTotal Superficie total Numérico Si
entreCalles Ubicación entre calles Texto No
estadoUnidad Estado de la unidad Ver listado No
luminosidad Luminosidad Número de 1 a 10 No
ubicacion Ubicación de la unidad Ver listado No
antiguedad Antigüedad Número entero No
ascensor Cantidad de ascensores Número entero No
cantidadDivisiones Cantidad de divisiones Número entero No
cantidadCocheras Cocheras Si / No / Número entero No
patios Medida patios Texto No
office Contiene office Si / No No
piso Piso de la unidad Número entero No
cantidadPisos Cantidad de pisos del edificio Número entero No
Categoria Categoria Ver listado No
banioexclusivo Baño exclusivo Si / No No
baniogerencial Baño gerencial Si / No No
aguaCorriente Incluye agua corriente Si / No No
gasnatural Incluye gas natural Si / No No
pavimento Pavimento Si / No No
orientacion Orientación de la unidad Ver listado No

Local

Nombre campo Descripción Tipo Obligatorio
superficieTotal Superficie total Numérico Si
superficieDescubierta Superficie descubierta Numérico Si
expensas Precio de expensas Numérico No
entreCalles Entre calles Texto No
Categoria Categoria Ver listado No
ubicacion Ubicación de la unidad Ver listado No
aptoProfesional Apto profesional Si / No No
aptoGastronomia Apto gastronomía Si / No No
ancho Medida ancho Texto No
office Contiene office Si / No No
cantidadCocheras Cocheras Si / No / Número entero No
estadoUnidad Estado de la unidad Ver listado No
vivienda Tiene vivienda Si / No No
antiguedad Antigüedad Número entero No
fondo Largo del fondo Texto No
vidriera Vidriera Si / No No

Terreno

Nombre campo Descripción Tipo Obligatorio
frente Medida del frente Numérico No
ancho Medida ancho Numérico Si
largo Medida de largo Numérico Si
entreCalles Entre calles Texto No
superficieEdificable Superficie edificable Numérico No
demolicion Hay demolición Si / No No
aguaCorriente Agua corriente Si / No No
gasnatural Gas natural Si / No No
pavimento Pavimento Si / No / Número entero No
planosaprobados Planos aprobados Si / No No
vivienda Tiene vivienda Si / No No
telefono Incluye teléfono Si / No No
descripcion Descripción Texto No
fot Factor ocupacional del terreno Numérico No
country ID de country Ver listado No
superficie Superficie Numérico Si

Depósito

Nombre campo Descripción Tipo Obligatorio
frente Medida del frente Numérico No
largo Medida de largo Numérico Si
entreCalles Entre calles Texto No
superficieTerreno Superficie del terreno Numérico No
superficieCubierta Superficie cubierta Numérico No
aguaCorriente Agua corriente Si / No No
cantidadPortones Cantidad de portones Número entero No
telefono Incluye teléfono Si / No No
capacidad Capacidad Texto No
antiguedad Antigüedad Número entero No

Propiedades rurales

Nombre campo Descripción Tipo Obligatorio
expensas Valor de las expensas Numérico No
has Hectareas Numérico Si
electricidad Tiene electricidad Si / No No
galpones Tiene galpones Si / No No
silos Contiene silos Si / No No
descripcion Descripción Texto No
molinos Incluye molinos Si / No No
casa Incluye casa Si / No No

Edificios en Block / Estructuras / Obras

Nombre campo Descripción Tipo Obligatorio
entreCalles Ubicación entre calles Texto No
frente Medida del frente Numérico Si
superficieTerreno Superficie del terreno Numérico No
aguaCorriente Tiene agua corriente Si / No No
pavimento Pavimento Si / No No
gasnatural Gas natural Si / No No
descripcion Descripción Texto No
superficieTotal Superficie total Numérico No
destino Destino de la obra Texto No

Cochera

Nombre campo Descripción Tipo Obligatorio
entreCalles Ubicación entre calles Texto No
expensas Valor de las expensas Numérico No
cochFija Cochera fija Si / no No
ascensor Tiene ascensor Si / No No
aguaCorriente Incluye agua corriente Si / No No
gasnatural Incluye gas natural Si / No No
pavimento Pavimento Si / No No

Country

Nombre campo Descripción Tipo Obligatorio
entreCalles Ubicación entre calles Texto No
expensas Valor de las expensas Numérico No
superficieLote Superficie del lote Numérico Si
country ID de country Ver listado No
vivienda Tiene vivienda Si / No No
aguaCorriente Incluye agua corriente Si / No No
gasnatural Incluye gas natural Si / No No
pavimento Pavimento Si / No No
telefono Incluye teléfono Si / No No
pileta Incluye pileta Si / No No

Fondo de comercio

Nombre campo Descripción Tipo Obligatorio
superficieCubierta Superficie cubierta Numérico Si
frente Medida del frente Texto No
vivienda Tiene vivienda Si / No No
largo Largo del terreno Numérico No
aguaCorriente Incluye agua corriente Si / No No
antiguedad Antigüedad Número entero No
gasnatural Incluye gas natural Si / No No
deposito Incluye depósito Si / No No
pavimento Pavimento Si / No No
telefono Incluye teléfono Si / No No

Hoteles / Otros productos

Nombre campo Descripción Tipo Obligatorio
entreCalles Entre calles Texto No
aguaCorriente Incluye agua corriente Si / No No
gasnatural Incluye gas natural Si / No No
telefono Incluye teléfono Si / No No
pavimento Pavimento Si / No No
descripcion Descripción Texto No