Ciudades

Introducción

Este método es similar al método general de ciudades, sin embargo, al igual que todos los métodos bajo este paraguas (búsqueda), solo muestra las opciones en que la inmobiliaria o la sucursal cuenta con inmuebles. También es posible hacerle filtros, de manera que, se puedan mostrar filtros dinámicos.

Ejemplo de uso

{success} GET: /search/cities

use GuzzleHttp\Client;

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

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

Ejemplo de respuesta

{
    "data" : [
        {
            "code": 11001,
            "name": "Bogotá",
            "state_code": 11,
            "state_name": "Bogota",
            "latitude": "4.657540387454442",
            "longitude": "-74.09613990783691"
        }
    ]
}

Parámetros que recibe

Por Header

Parámetro Descripción Ejemplo
Authorization Token de ingreso e identificador de la inmobiliaria (obligatorio) "Authorization" => "TOKEN_INGRESO"
Inmobiliaria Permite mostrar todas las gestiones en que la inmobiliaria tiene inmuebles si se envía el valor 1 (por defecto 0 y solo se muestran inmuebles de la sucursal adscrita al token) "Inmobiliaria" => 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
type Buscar por tipos de inmueble &type=1
address Buscar por direccion  &address=25
zone Buscar por zona &zone=3
stratum Buscar por estrato &stratum=4
biz Buscar por gestión de inmueble &biz=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 parqueos &minparking=2&maxparking=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

Í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

Parámetro Descripción Ejemplo
ASC Orden ascendente &sort=asc
DESC Orden descendente &sort=desc
name Ordenar por nombre &order=name
code Ordenar por código &order=code