Inmuebles

• Introducción
• Ejemplo de uso
• Ejemplo de respuesta
• Parámetros que recibe
• Índices de ordenamiento

Introducción

Esta es la lista de inmuebles de Apperty, 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} Url: /api/properties

use GuzzleHttp\Client;

$client = new Client();
$res = $client->request("GET", "{$endpoint}/api/properties", [
    "headers" => [
        "Content-type" => "application/json",
        "Accept" => "application/json",
        "Authorization" => "TOKEN_INGRESO"
    ]
]);

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

Ejemplo de respuesta

{
    "total": 1,
    "per_page": 12,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1,
    "data": [
        {
            "unique_code": 1,
            "code": 1234,
            "code_text": "123456-abc",
            "biz_service": "ARRIENDO",
            "type_code": 1,
            "type": "Property Type",
            "title": "Property title",
            "description": "Property description.",
            "ubication_text": "Property location",
            "neighborhood": "Barrio",
            "latitude": "1.4910616935449887",
            "longitude": "-26.48856237014577",
            "geohash": "",
            "address": "Property address",
            "primary_area": 200,
            "bedrooms": 2,
            "bathrooms": 3,
            "parking": 1,
            "build_year": 2011,
            "stratum": 5,
            "consignment_date": "2020-01-20 00:00:00",
            "video": "https://www.youtube.com/watch?v=ExampleYoutubeCode",
            "virtual_tour": "",
            "featured": true,
            "exclusive": false,
            "separate": 1,
            "count_images": 16,
            "count_images_360": 0,
            "featured_image": "https://pictures.domus.la/featuredImage.jpg",
            "status_code": 1,
            "status_name": "Disponible",
            "tags": [
                {
                    "code": 1,
                    "name": "Tag 1",
                    "color": "'#0000",
                    "text_color": "'#fff",
                    "is_public": false
                },
                {
                    "code": 2,
                    "name": "Tag 2",
                    "color": "'#f0f0f0",
                    "text_color": "'#000",
                    "is_public": true
                }
            ],
            "prices": [
                {
                    "biz_service_id": 1,
                    "name": "Arriendo",
                    "price": 21000000,
                    "currency": "peso",
                    "currency_prefix": "$"
                },
                {
                    "biz_service_id": 3,
                    "name": "Administración",
                    "price": 600000,
                    "currency": "peso",
                    "currency_prefix": "$"
                }
            ],
            "portals": [
                {
                    "code": "12345",
                    "status": "SUCCESS",
                    "url": "url-inmueble.com",
                    "portal_code": 1,
                    "portal_name": "Portal",
                    "portal_logo": "logo-portal.png"
                },
            ],
            "branch": {
                "code": 1,
                "name": "Example Branch",
                "address": "Example address",
                "ubication_text": "Example location",
                "latitude": "1.4510678",
                "longitude": "-29.5557707",
                "phone": "123456789",
                "mobile_phone": "123456789",
                "whatsapp_number": "123456789"
            },
            "company": {
                "code": 1,
                "name": "Example company",
                "email": "[email protected]",
                "logo": "http://example/example_logo.png",
                "phone": "123456789",
                "mobile_phone": "123456789",
                "whatsapp_number": "123456789"
            },
            "promoter": {
                "code": 1,
                "name": "Monroe Konopelski",
                "email": "[email protected]",
                "picture": "https://via.placeholder.com/800x800.png/00bbaa?text=rerum",
                "phone": "123456789",
                "mobile_phone": "123456789",
                "whatsapp_number": "123456789"
            },
            "catcher": {
                "code": 1,
                "name": "Monroe Konopelski",
                "email": "[email protected]",
                "picture": "https://via.placeholder.com/800x800.png/00bbaa?text=rerum",
                "phone": "123456789",
                "mobile_phone": "123456789",
                "whatsapp_number": "123456789"
            }
        }
    ]
}

Parámetros que recibe

Por Header

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 tipo de inmueble, gestión, entre otros: "&type=1,2"

Í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)