Sucursales

Introducción

Todos los inmuebles están ubicados en alguna zona (punto cardinal); en Domus existen varias zonas posibles para un inmueble; cada una tiene un código asignado que se utiliza en diferentes circunstancias y en este caso, para insertar un inmueble. Es importante tener en cuenta que en este caso zona se refiere principalmente a un punto cardinal que a una zona independiente de cada ciudad o municipio.

Ejemplo de uso

{success} GET: /administrative/branches

use GuzzleHttp\Client;

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

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

Ejemplo de respuesta

{
    "data" : [
        {
            "code": 1,
            "name": "Inmobiliaria ejemplo",
            "address": "Dirección de ejemplo",
            "neighborhood": "Barrio de ejemplo",
            "phone": "123456789",
            "city_code": 11001,
            "city_name": "Bogotá",
            "company_name": "Inmobiliaria ejemplo",
            "company_slogan": "Slogan",
            "company_logo": "logo.png",
            "company_phones": "PBX:12345679,828282828",
            "company_emails": "[email protected]"
        }
    ]
}

Parámetros que recibe

Por Header

Parámetro Descripción Ejemplo
Authorization Token de ingreso e identificador de la inmobiliaria (obligatorio) "Authorization" => "TOKEN_INGRESO"

Í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