Listar Propiedades

Parámetros de consulta (query string):

Nota:Comportamiento de los filtros de fecha 
Para los parámetros de tipo fecha que se compongancomponen de un rango,rango como(por ejemplo listing_start_date y listing_end_date,):
— seSi debeenvías tener en cuenta que si se envía solo el start_date,: se retornarán registros dondecon lafecha condición es “>= (mayor o igual)”.igual (>=) a la indicada.
— Si envías solo se envía el end_date,: se retornarán registros dondecon fecha menor o igual (<=) a la condiciónindicada.
— esSi “<=envías (menos o igual)”, y si se envían ambas, entoncesambos: se retornarán registros dentro de ese rango de fechas.fechas (BETWEEN).
— La fecha de inicio no puede ser mayor que la fecha de fin; de lo contrario se devolverá un error de validación.

Ejemplos de peticionespeticiones:

GET https://{{instancia}}.arrendasoft.co//service/v2/public/properties

GET https://{{instancia}}.arrendasoft.co/service/v2/public/properties/

https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10

GET https://{{instancia}}.arrendasoft.co//service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-26

GET https://{{instancia}}.arrendasoft.co//service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-2601&listing_end_date=2024-03-2631

GET https://{{instancia}}/service/v2/public/properties?page=2&limit=20&created_start_date=2024-01-01&created_end_date=2024-06-30

3. La Respuesta (¿Qué te entregaremos?)

ListaEl sistema te devolverá una lista con las propiedades que coincidan con los filtros aplicados. Cada propiedad incluye datos generales, ubicación, valores económicos, características, propietarios, imágenes, videos y códigos de elementos,portales dondeinmobiliarios. cadaLa elementorespuesta contienese laverá informaciónsimilar dea cada una de las propiedades.esta:

[
    {
        "codigo": "137",
        "titulo": "Apartamento cercaamplio delcon estadiovista yal laparque cuarta brigada"central",
        "clase_id": "1247",
        "clase_inmueble": "Apartamento",
        "tipo_servicio_id": "arriendo",
        "tipo_servicio": "Arriendo",
        "estrato": "1258",
        "estrato_texto": "Cuatro",
        "fecha_consignacion": "2024-04-26",
        "asesor_id": "5",
        "asesor": "InterServicios"María López Ramírez",
        "pais_id": "1",
        "pais": "COLOMBIA",
        "departamento_id": "5",
        "departamento": "Antioquia",
        "municipio_id": "1",
        "municipio": "Medellin",
        "barrio_id": "3",
        "barrio": "Estadio"Los Rosales",
        "direccion": "CALLE 5045 # 7432 - 12"18",
        "coordenadas": "6.21505012838972:24830000000000:-75.57529436962885"56120000000000",
        "valor_arriendo1": "1600000",
        "valor_arriendo2": "0",
        "valor_venta1": "0",
        "valor_venta2": "0",
        "valor_administracion": "0",
        "avaluo_catastral": "0",
        "impuesto_predial": "0.00",
        "area": "75.00",
        "observaciones": null,
        "propiedad_destacada": "No",
        "llaves_en": "oficina",
        "llaves_otro": null,
        "paga_cuota_sost": "propietario",
        "folio_matricula": null,
        "referencia_catastral": null,
        "edificio_unidad": "urbanizacion",
        "estado": "1",
        "estado_texto": "Activa",
        "cantidad_images": "3",
        "cantidad_videos": "1",
        "fecha_creacion": "2024-04-26 10:30:00",
        "ultima_fecha_modificacion": "2024-05-15 14:22:00",
        "caracteristicas": [
            {
                "id": "1",
                "descripcion": "Nº De Habitaciones",
                "tipo_campo": "numeric",
                "orden": "1",
                "grupo": "Características del inmueble",
                "valor": "4"
            },
            {
                "id": "2",
                "descripcion": "Nº De Baños",
                "tipo_campo": "numeric",
                "orden": "2",
                "grupo": "Características del inmueble",
                "valor": "3"
            },
            {
                "id": "5",
                "descripcion": "Nº De Piso",
                "tipo_campo": "numeric",
                "orden": "3",
                "grupo": "Características del inmueble",
                "valor": "1"
            },
            {
                "id": "4",
                "descripcion": " Antigüedad del Inmueble",
                "tipo_campo": "numeric",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "3"
            },
            {
                "id": "14",
                "descripcion": "Cocina Integral",
                "tipo_campo": "checkbox",
                "orden": "5",
                "grupo": "Características Internas",
                "valor": "1"
            },
            {
                "id": "34",
                "descripcion": "Sala",
                "tipo_campo": "checkbox",
                "orden": "6",
                "grupo": "Características del Inmueble",
                "valor": "1"
            },
            {
                "id": "31",
                "descripcion": "Red de gas",
                "tipo_campo": "select",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "si",
                "valor_texto": "Si"
            },
            {
                "id": "63"14",
                "descripcion": "Garaje"Cocina Integral",
                "tipo_campo": "checkbox",
                "orden": "10"5",
                "grupo": "Características Internas",
                "valor": "1"
            }
        ],
        "propietarios": [
            {
                "id": "272",
                "documento": "4207050496"1020304050",
                "nombres": "CRISTINAANA GUERRERO"MARÍA",
                "apellidos": ""PÉREZ RODRÍGUEZ"
            }
        ],
        "imagenes": [
            {
                "posicion": "1",
                "size": "19201080",
                "img": "img/fotos/1920x1080_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6.jpeg",
                "imagen": "https://qa.arrendasoft.co/mi-inmobiliaria.nuby.app/img/fotos/1920x1080_66ae4cfba9aa891473fe8f78a0c7e6f6.1920x1080_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6.jpeg"
            },
            {
                "posicion": "2",
                "size": "19201080",
                "imagen"img": "https://qa.arrendasoft.co/img/fotos/1920x1080_660ae9fb29a0ff3c0e47cf13cde4740e.1920x1080_f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3.jpeg"
            },
            {
                "posicion": "3",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/mi-inmobiliaria.nuby.app/img/fotos/1920x1080_83883a0f75ddae325f41eafce4066631.1920x1080_f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3.jpeg"
            }
        ],
        "videos": [
            {
                "url": "608AV8w6gL0"dQw4w9WgXcQ",
                "tipo": "youtube",
                "descripcion": null,
                "posicion": "1"
            }
        ],
        },"codigos_portales": [
            {
                "codigo"nombre_portal": "136"metrocuadrado",
                "titulo"id_portal": "FINCA",
        "clase_id": "1254",
        "clase_inmueble": "Finca",
        "tipo_servicio_id": "venta y arriendo"MC-12345",
                "tipo_servicio": "Venta y Arriendo",
        "estrato": "1258",
        "estrato_texto": "Cuatro",
        "fecha_consignacion": "2021-04-16",
        "asesor_id": "6",
        "asesor": "KAREN CANO",
        "pais_id": "1",
        "pais": "COLOMBIA",
        "departamento_id": "11",
        "departamento": "Bogota D.c.",
        "municipio_id": "150",
        "municipio": "Bogota",
        "barrio_id": "838",
        "barrio": "Bosa",
        "direccion": "CR 145 # 85 - 9",
        "coordenadas": "4.875468815048683:-73.62556445019526",
        "valor_arriendo1": "6050000",
        "valor_arriendo2": "0",
        "valor_venta1": "500000000",
        "valor_venta2": "0",
        "valor_administracion": "0",
        "avaluo_catastral": "0",
        "impuesto_predial": "0.00",
        "area": "1200.00",
        "observaciones": "Esta finca ofrece una experiencia rural única con comodidades modernas. La espaciosa casa principal cuenta con encantadoras habitaciones, cuenta con una reluciente piscina y áreas verdes bien cuidadas.",
        "propiedad_destacada": "No",
        "llaves_en": "oficina",
        "llaves_otro": null,
        "paga_cuota_sost": null,
        "folio_matricula": "0",
        "referencia_catastral": "0",
        "edificio_unidad": "urbanizacion",
        "estado": "1",
        "estado_texto": "Activa",
        "cantidad_images": "2",
        "cantidad_videos": "0",
        "caracteristicas": [
            {
                "id": "1",
                "descripcion": "Nº De Habitaciones",
                "tipo_campo": "numeric",
                "orden": "1",
                "grupo": "Características del inmueble",
                "valor": "9"
            },
            {
                "id": "2",
                "descripcion": "Nº De Baños",
                "tipo_campo": "numeric",
                "orden": "2",
                "grupo": "Características del inmueble",
                "valor": "4"
            },
            {
                "id": "11",
                "descripcion": "Zona de lavandería",
                "tipo_campo": "checkbox",
                "orden": "14",
                "grupo": "Características del inmueble",
                "valor": "1"
            },
            {
                "id": "9",
                "descripcion": "Cuarto de servicio",
                "tipo_campo": "checkbox",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "1"
            },
            {
                "id": "26",
                "descripcion": "Sauna / Turco / Jacuzzi",
                "tipo_campo": "checkbox",
                "orden": "6",
                "grupo": "Características del Inmueble",
                "valor": "1"arriendo"
            }
        ],
        "propietarios": [
            {
                "id": "83",
                "documento": "2830863285",
                "nombres": "LILIA MARLEN",
                "apellidos": "LOPEZ CASTELLANOS"
            }
        ],
        "imagenes": [
            {
                "posicion": "1",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_431b70772304a609c280036305f66ac4.jpeg"
            },
            {
                "posicion": "2",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_209e299b845c8bdf9479f5fb055461fe.jpeg"
            }
        ],
        "videos": []
    }
]

ClavesCampos y Descripciones del JSONprincipales de Propiedadesla propiedad

Esta tabla enumera las claves presentes en el JSON de unacada propiedad y proporciona una breve descripción de cada una, explicando su propósito y el tipo de información que contienen.una:

Características

Cada elemento dentro de la lista caracteristicas tienecontiene lasla siguientesinformación claves:de una característica del inmueble y su valor asignado:

Propietarios

Cada elemento dentro de la lista propietarios tienecontiene lasla siguientesinformación claves:de un propietario del inmueble:

Imágenes

Cada elemento dentro de la lista imagenes tienecontiene lasla siguientesinformación claves:de una fotografía del inmueble:

Videos

Cada elemento dentro de la lista videos tienecontiene lasla siguientesinformación claves:de un video asociado al inmueble:

Códigos de Portales

Cada elemento dentro de la lista codigos_portales contiene la información de publicación del inmueble en un portal inmobiliario externo:

Ejemplos4. Seguridad y Posibles Errores

Si alguno de los parámetros enviados no cumple con las validaciones, el sistema devolverá un error 400 con la descripción del problema. Por ejemplo:

{
    "error": [
        "El límite debe ser un número y no mayor a 50"
    ]
}

Posibles errores de validación:

5. Ejemplos de integración

Aquí tienes ejemplos de código listos para que tus desarrolladores los adapten a tu plataforma:

# Listar propiedades con paginación
curl -X GET "https://{{instancia}}.arrendasoft.co//service/v2/public/properties?page=1&limit=10" \
-H "Content-Type: application/json"

# Filtrar por rango de fecha de consignación
curl -X GET "https://{{instancia}}/service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-01&listing_end_date=2024-03-31" \
-H "Content-Type: application/json"

# Filtrar por fecha de creación
curl -X GET "https://{{instancia}}/service/v2/public/properties?page=1&limit=20&created_start_date=2024-01-01" \
-H "Authorization:Content-Type: Bearer YOUR_AUTHENTICATION_TOKEN"application/json"

<?php

$instance = 'your_instance'tu_instancia'; // ReplaceReemplaza withcon yourtu actualinstancia instance
$token = 'YOUR_AUTHENTICATION_TOKEN';real

// ReplaceParámetros withde the token obtained from the login service

// Example parameters for listing propertiesconsulta
$page = 1;
$limit = 10;
$listingStartDate = '2024-03-01';
$listingEndDate = '2024-03-31';

$url = "https://{$instance}.arrendasoft.co/service/v2/public/properties?";
$queryParams = http_build_query([
    'page' => $page,
    'limit' => $limit,
    'listing_start_date' => $listingStartDate,
    'listing_end_date' => $listingEndDate
]);

$url .= http_build_query("https://{$queryParams)instance}/service/v2/public/properties?{$queryParams}";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $token
]);

$response = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if (curl_errno($ch)) {
    echo 'Error: ' . curl_error($ch);
} else {
    echo "HTTPCódigo Statusde Code:estado HTTP: " . $http_code . "\n";

    echoif "Response:($http_code "=== .200) {
        $response . "\n";
    
    // You can further process the JSON response here
    $propertiespropiedades = json_decode($response, true);
        if ($http_code == 200 && !empty($properties)) {
        echo "SuccessfullyPropiedades retrievedencontradas: " . count($properties)propiedades) . " properties.\n";
        // Example: print the title of the first property
        ifforeach (isset($properties[0]['titulo']))propiedades as $propiedad) {
            echo "First  property[{$propiedad['codigo']}] title: " . {$properties[0][propiedad['titulo']} .- "{$propiedad['estado_texto']}\n";
        }
    } else {
        echo "FailedError toal retrieveconsultar propertieslas orpropiedades.\n";
        noecho properties$response found.. "\n";
    }
}
curl_close($ch);

?>

import requests

# 1. Configura tus datos de acceso
instancia = 'mi-inmobiliaria.nuby.app' # Reemplaza con tu dirección web completa

# 2. Prepara la dirección y los parámetros
url = f"https://{instancia}/service/v2/public/properties"

params = {
    "page": 1,
    "limit": 10,
    "listing_start_date": "2024-03-01",
    "listing_end_date": "2024-03-31"
}

headers = {
    "Content-Type": "application/json"
}

# 3. Envía la petición GET y procesa la respuesta
try:
    response = requests.get(url, params=params, headers=headers)

    print(f"Código de estado HTTP: {response.status_code}")

    if response.status_code == 200:
        propiedades = response.json()
        print(f"Propiedades encontradas: {len(propiedades)}")
        for prop in propiedades:
            print(f"  [{prop['codigo']}] {prop['titulo']} - {prop['estado_texto']}")
    else:
        print("Error al consultar las propiedades.")
        print(f"Detalle del error: {response.text}")

except Exception as e:
    print(f"Ocurrió un error de conexión: {e}")

// 1. Configura tus datos de acceso
const instancia = 'mi-inmobiliaria.nuby.app'; // Reemplaza con tu dirección web completa

// 2. Prepara la dirección con parámetros
const params = new URLSearchParams({
    page: 1,
    limit: 10,
    listing_start_date: '2024-03-01',
    listing_end_date: '2024-03-31'
});

const url = `https://${instancia}/service/v2/public/properties?${params}`;

// 3. Función para consultar las propiedades
async function consultarPropiedades() {
    try {
        const response = await fetch(url, {
            method: 'GET',
            headers: {
                'Content-Type': 'application/json'
            }
        });

        console.log(`Código de estado HTTP: ${response.status}`);

        if (response.ok) {
            const propiedades = await response.json();
            console.log(`Propiedades encontradas: ${propiedades.length}`);
            propiedades.forEach(prop => {
                console.log(`  [${prop.codigo}] ${prop.titulo} - ${prop.estado_texto}`);
            });
        } else {
            console.log('Error al consultar las propiedades.');
            const errorData = await response.text();
            console.log(`Detalle del error: ${errorData}`);
        }
    } catch (error) {
        console.error(`Ocurrió un error de conexión: ${error}`);
    }
}

// 4. Ejecutamos la función
consultarPropiedades();

let
    // 1. Configura tus datos de acceso
    instancia = "mi-inmobiliaria.nuby.app", // Reemplaza con tu dirección web completa

    // 2. Prepara la dirección de la petición con parámetros
    url = "https://" & instancia & "/service/v2/public/properties?page=1&limit=50",

    // 3. Envía la petición GET
    response = Web.Contents(url, [
        Headers = [
            #"Content-Type" = "application/json"
        ]
    ]),

    // 4. Decodifica la respuesta JSON y conviértela en tabla
    jsonResponse = Json.Document(response),
    tabla = Table.FromList(jsonResponse, Splitter.SplitByNothing(), null, null, ExtraValues.Error),
    expandido = Table.ExpandRecordColumn(tabla, "Column1",
        {"codigo", "titulo", "clase_inmueble", "tipo_servicio", "estado_texto", "direccion", "municipio", "departamento", "area", "valor_arriendo1", "valor_venta1", "fecha_consignacion"},
        {"Codigo", "Titulo", "ClaseInmueble", "TipoServicio", "Estado", "Direccion", "Municipio", "Departamento", "Area", "ValorArriendo", "ValorVenta", "FechaConsignacion"})
in
    expandido