Inmuebles


Introducción

Esta es la lista de inmuebles de Domus, es la ruta para obtener todos los inmuebles en los diferentes estados; su enfoque está destinado a páginas web y aplicaciones para mostrar inmuebles con su respectivo paginador y toda la información necesaria

Ejemplo de uso

{success} GET: /properties

use GuzzleHttp\Client;

$client = new Client();
$res = $client->request("GET", "{$endpoint}/properties", [
    "headers" => [
        "Authorization" => "TOKEN_INGRESO",
        "inmobiliaria" => 1,
        "perpage" => 12
    ]
]);

$properties = json_decode($res->getBody(), true);
return $properties;

Ejemplo de respuesta

{
    "total": 346,
    "per_page": 12,
    "current_page": 1,
    "last_page": 29,
    "from": 1,
    "to": 12,
    "data":[
        {
            "idpro": 123456,
            "codpro": 123,
            "branch": 1,
            "address":[],
            "city": "CIUDAD",
            "city_code": 1,
            "zone": "ZONA",
            "zone_code": 1,
            "neighborhood": "BARRIO",
            "neighborhood_code": 1,
            "type": "TIPO_INMUEBLE",
            "type_code": 1,
            "biz": "GESTION",
            "biz_code": 1,
            "area_cons": 1,
            "area_lot": 1,
            "bedrooms": 1,
            "bathrooms": 1,
            "price": "1000000/1000000",
            "price_format": "$ 1.000.000 / .000.000",
            "rent": 1000000,
            "saleprice": 1000000,
            "administration": 0,
            "latitude": "1.1",
            "longitude": "-1.1",
            "description": "Descripcion de prueba para documentación",
            "english_description": "",
            "parking": 1,
            "parking_covered": 0,
            "registry_date": "2018-09-19 15:51:47",
            "real_state": 10,
            "real_state_name": "Inmobiliaria ejemplo",
            "build_year": 0,
            "status": 1,
            "comment": "",
            "comment2": "",
            "great": "",
            "video": "",
            "detached_count": 0,
            "iva": 0,
            "price_iva": 0,
            "tour3d": "0",
            "images360_count": 0,
            "proyect_id": 0,
            "image": "http://pictures.domus.la/inmobiliaria_code/picture.jpg"
        }
    ]
}

Parámetros que recibe

Por Header

Parámetro Descripción Ejemplo
Authorization Token de ingreso e identificador de la inmobiliaria (obligatorio) "Authorization" => "TOKEN_INGRESO"
Perpage Cantidad de inmuebles a mostrar por página (por defecto 1) "Perpage" => 12
Inmobiliaria Permite mostrar todos los inmuebles de la inmobiliaria si se envía el valor 1 (por defecto 0 y solo se muestran inmuebles de la sucursal adscrita al token) "Inmobiliaria" => 1
Ficha Permite ver la ficha del inmueble si se envía el valor 1 "ficha" => 1

Por URL

En general la mayoría de parámetros que no se trate de rangos o campos de texto se pueden buscar con valores múltiples, por ejemplo ciudad, tipo de inmueble, gestión, entre otros: "&city=11001,5001"

Parámetro Descripción Ejemplo
page Numero de la pagina que desea ver &page=3
codpro Traer un codigo especifico ?codpro=262
city Buscar por ciudad &city=11001
address Buscar por direccion  &address=25
zone Buscar por zona &zone=3
biz Buscar por tipo de negocio &biz=2
stratum Buscar por estrato &stratum=4
type Buscar por tipo de inmueble &type=5
neighborhood Buscar por barrio &neighborhood=colina
neighborhood_code Buscar por id barrio &neighborhood_code=4751
area_cons Filtrar area construida en m² &area_cons=60
minarea - maxarea Filtrar por rango de area en m² &minarea=45&maxarea=65
area_lot Filtrar por area de lote en m² &area_lot=80
floor_type Filtrar tipo de piso &floor_type=ceramica
bedrooms Filtrar por habitaciones &bedrooms=4
minbed - maxbed Filtrar por rango de habitaciones &minbed=2&maxbed=4
bathrooms Filtrar por baños &bathrooms=4
minbath - maxbath Filtrar por rango de baños &minbath=2&maxbath=3
rent Filtrar por valor del canon &rent=1200000
pcmin - pcmax Filtrar por rango de canon &pcmin=800000&pcmax=1100000
saleprice Filtrar por valor de venta &saleprice=200000000
pvmin - pvmax Filtrar por rango de venta &pvmin=85000000&pvmax=92000000
administration Filtrar por valor de administracion &administration=250000
description Filtrar por una palabra contenida en la descripcion &description=remodelado
status Filtrar por estado &status=3
nostatus Si se envía el valor 0 muestra inmuebles en cualquier estado &nostatus=0
built_year Filtrar por año de construido &built_year=1998
minage - maxage Filtrar por rango de año construido &minage=2000&maxage=2005
great Traer inmuebles destacados &great=on
destination Filtrar destinacion &destination=2
broker Filtrar por id asesor &broker=1256
branch Filtrar por sucursal en caso que la inmobiliaria tenga mas de una &branch=601
minparking - maxparking Filtrar por rango de parquedaeros &minparking=2&maxparking=4
minstratum - maxstratum Filtrar por rango de estrato &minstratum=2&maxstratum=4
minfloor - maxfloor Filtrar por rango de nivel o piso &minfloor=2&maxfloor=4
amenities Filtrar por caracteristicas &amenities=24,87,63
amenitiesin Filtrar por caracteristicas incluyentes &amenitiesin=24,87,63
keyword Filtrar por diferentes campos como al descripción y el código, es un filtro general &keyword=prueba
min_street Busca por rango de calle mínima según la dirección suministrada del inmueble &min_street=10
max_street Busca por rango de calle máxima según la dirección suministrada del inmueble &max_street=10
min_avenue Busca por rango de carrera mínima según la dirección suministrada del inmueble &min_avenue=10
max_avenue Busca por rango de carrera máxima según la dirección suministrada del inmueble &max_avenue=10

Índices de ordenamiento

Son parámetros también enviados por url que permiten organizar los inmuebles de acuerdo a diferentes parámetros, en general se debe enviar como "&order=order&sort=SORT" para que funcione en coherencia, sin embargo esto no es necesario con los últimos dos índices (pricemin y pricemax)

Parámetro Descripción Ejemplo
ASC Orden ascendente &sort=asc
DESC Orden descendente &sort=desc
saleprice Ordenar por precio de venta &order=saleprice
rent Ordenar por precio de arriendo &order=rent
administration Ordenar por precio de administración &order=administration
address Ordenar por dirección &order=address
zone Ordenar por zona &order=zone
biz Ordenar por gestión &order=biz
stratum Ordenar por estrato &order=stratum
type Ordenar por tipo de inmueble &order=type
neighborhood Ordenar por nombre de barrio &order=neighborhood
neighborhood_code Ordenar por id de barrio &order=neighborhood
area_cons Ordenar por área construida &order=area_cons
area_lot Ordenar por área lote &order=area_lot
floor_type Ordenar por tipo de piso &order=floor_type
floor Ordenar por nivel o piso &order=floor
bedrooms Ordenar por número de habitaciones &order=bedrooms
bathrooms Ordenar por número de baños &order=bathrooms
pricemin Ordenar por precio de menor a mayor &order=pricemin
pricemax Ordenar por precio de mayor a menor &order=pricemax