Lista de asesores

Introducción

Un inmueble debe asociarse con un asesor. Este método permite obtener todos los asesores con diferentes usos incluyendo su integración en la página web.

Ejemplo de uso

{success} GET: /administrative/brokers

use GuzzleHttp\Client;

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

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

Ejemplo de respuesta

{
    "data" : [
        {
            "code": 1,
            "id_number": 1234567,
            "name": "Nombre",
            "last_name": "Apellidos",
            "phone": "1234567",
            "mobile_phone": "1234567890",
            "email": "[email protected]",
            "picture": "http://pictures.domus.la/picture.png",
            "address": "Dirección de prueba",
            "order": 1,
            "biz_code": 1,
            "department": "Administrativo",
            "description": "Asesor de prueba",
            "city_code": 11001,
            "city": "Bogota"
        }
    ]
}

Parámetros que recibe

Por Header

Parámetro Descripción Ejemplo
Authorization Token de ingreso e identificador de la inmobiliaria (obligatorio) "Authorization" => "TOKEN_INGRESO"
Inmobiliaria Mostrar todos los asesores de la inmobiliaria si se envía el valor uno (1) "Inmobiliaria" => "1"

Por URL

Parámetro Descripción Ejemplo
branch Sucursal a la que pertenece el asesor (una o más) &branch=10,11
city Ciudad a la que pertenece el asesor (una o más) &city=11001,5001
name Nombre completo o porción del nombre del asesor &name=Prueb...
phone Teléfono o parte del teléfono o celular del asesor &phone=123...

Í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
last_name Ordenar por apellido &order=last_name
code Ordenar por código &order=code