Captaciones Domus V2


Introducción

Esta es la lista de captaciones de Domus V2 de la inmobiliaria.

Ejemplo de uso

{success} GET: /captures-v2

use GuzzleHttp\Client;

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

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

Ejemplo de respuesta

{
    "code": 200,
    "message": "Captures retrieved successfully",
    "total": 2,
    "per_page": 3,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 2,
    "data": [
        {
            "unique_code": 1,
            "code": 1,
            "property_id": 10,
            "property_code": 100,
            "biz_service_code": 1,
            "biz_service_name": "ARRIENDO",
            "type_code": 2,
            "type_name": "CASA",
            "value": 10000,
            "formatted_value": "10.000",
            "administration": 20000,
            "formatted_administration": "20.000",
            "area": 56,
            "bedrooms": 65,
            "bathrooms": 56,
            "address": "Dirección",
            "neighborhood": "Barrio",
            "latitude": "1.23456789",
            "longitude": "2.3456789",
            "city_code": 11001,
            "city_name": "Bogotá",
            "description": "Descripción",
            "broker": 1,
            "crm_contact": 1,
            "branch_office_code": 1,
            "branch_office_name": "Prueba",
            "real_state_code": 10,
            "real_state_name": "Inmobiliaria_ejemplo",
            "real_state_logo": "logo.png"
        },
    ]
}

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

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
city Buscar por ciudad &city=11001
branch Filtrar por sucursal en caso que la inmobiliaria tenga mas de una &branch=601
neighborhood Buscar por barrio &neighborhood=colina
biz Buscar por tipo de negocio &biz=2
stratum Buscar por estrato &stratum=4
type Buscar por tipo de inmueble &type=5
minarea - maxarea Filtrar por rango de area en m² &minarea=45&maxarea=65
price_min - price_max Filtrar por rango de valor &price_min=800000 &price_max=1100000
administration_min - administration_max Filtrar por rango de administración &administration_min=800000 &administration_max=1100000
administration_min - administration_max Filtrar por rango de administración &administration_min=800000 &administration_max=1100000
minbed - maxbed Filtrar por rango de habitaciones &minbed=2&maxbed=4
minbath - maxbath Filtrar por rango de baños &minbath=2&maxbath=3
broker Filtrar por id asesor &broker=1256
contact Filtrar por id del contacto en CRM Domus &contact=1256

Í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
unique_code Ordenar por código único automático &order=unique_code
code Ordenar por código asignado &order=code
type_code Ordenar por código de tipo de inmueble &order=type_code
city_code Ordenar por código de ciudad &order=city_code
neighborhood Ordenar por nombre del barrio &order=neighborhood
stratum Ordenar por estrato &order=stratum
area Ordenar por área &order=area
bedrooms Ordenar por habitaciones &order=bedrooms
bathrooms Ordenar por baños &order=bathrooms
price Ordenar por precio &order=price
administration Ordenar por valor de administración &order=administration