Departamentos

Introducción

Todos los inmuebles están ubicados en algún municipio o ciudad; en Domus existen varias ciudades posibles para un inmueble; éste método permite agrupar todas las ciudades pertenecientes a un departamento/estado de un país

Ejemplo de uso

{success} GET: /general/states

use GuzzleHttp\Client;

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

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

Ejemplo de respuesta

{
    "data" : [
        {
            "code": 11,
            "name": "Bogotá",
            "country_code": 1,
            "country_name": "Colombia",
        }
    ]
}

Parámetros que recibe

Por Header

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

Por URL

Parámetro Descripción Ejemplo
country País de la ciudad ?country=1

Í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