Centros poblados


Introducción

Se entiende por centros poblados a lugares que quedan dentro de una ciudad y son más grandes que los barrios, por ejemplo las veredas. Este método muestra esos centros poblados y pueden utilizarse cuando sea necesario.

Ejemplo de uso

{success} GET: /general/populated-centers

use GuzzleHttp\Client;

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

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

Ejemplo de respuesta

{
    "data" : [
        {
            "code": 3420,
            "registry_code": 11001000,
            "name": "BOGOTÁ, DISTRITO CAPITAL"
        }
    ]
}

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

Los parámetros marcados con negrilla son obligatorios

Parámetro Descripción Ejemplo
city Obtener los centros poblados de una ciudad ?city=11001

Í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