Lista de propietarios

Introducción

Esta es la lista de propietarios que tiene la inmobiliaria y su participación en los inmuebles.

Ejemplo de uso

{success} GET: /owners

use GuzzleHttp\Client;

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

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

Ejemplo de respuesta

{
    "total": 40368,
    "per_page": 10,
    "current_page": 1,
    "last_page": 4037,
    "from": 1,
    "to": 10,
    "total": 40368,
    "per_page": 10,
    "current_page": 1,
    "last_page": 4037,
    "from": 1,
    "to": 10,
    "data":[
        {
            "code": 123,
            "document": 12345678,
            "document_type": "Cedula",
            "name": "Prueba",
            "last_name": "Prueba",
            "email": "[email protected]",
            "city": "CALI ",
            "city_code": 76001,
            "neighborhood": "xxxx",
            "description": "Descripción del propietario",
            "phones":[
                {
                    "type_name": "Movil",
                    "type_code": 3,
                    "number": "123456"
                }
            ]
        }
    ]
}

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 propietarios 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 propietario &branch=10
city Ciudad a la que pertenece el propietario (una o más) &city=11001,5001
name Nombre completo o porción del nombre del propietario &name=Prueb...
phone Teléfono o parte del teléfono o celular del propietario &phone=123...
email Correo o parte del correo del propietario &email=pru...
document Documento o parte del documento de identificación del propietario &document=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