Lista de propietarios

Introducción

Ésta es la lista de propietarios de los inmuebles que existen en Apperty

Ejemplo de uso

{success} GET /api/owners

use GuzzleHttp\Client;

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

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

Ejemplo de respuesta

{
    "code": 200,
    "message": "Owners retrieved successfully",
    "total": 1,
    "from": 1,
    "to": 1,
    "current_page": 1,
    "last_page": 1,
    "per_page": 10,
    "data": [
        {
            "code": 1,
            "identification": "12345678",
            "name": "Propietario de prueba 1",
            "email": "[email protected]",
            "birthday": "1999-01-01 00:00:00",
            "phones": [
                {
                    "code": 1,
                    "number": "123456789",
                    "phone_type_code": 1,
                    "phone_type_name": "Telefono",
                    "phone_code": 1,
                    "phone_code_name": "+57"
                }
            ]
        }
    ]
}

Parámetros que recibe

Por Header

Parámetro Descripción Ejemplo
Authorization Token de ingreso e identificador de la inmobiliaria (obligatorio) "Authorization" => "TOKEN_INGRESO"
Perpage Cantidad de inmuebles a mostrar por página (por defecto 10) "Perpage" => 12

Por URL

En general la mayoría de parámetros que no se trate de rangos o campos de texto se pueden buscar con valores múltiples, por ejemplo tipo de inmueble, gestión, entre otros: "&type=1,2"

Parámetro Descripción Ejemplo
page Numero de la pagina que desea ver &page=3
name Éste parámetro filtra por nombre, identificación, email y teléfonos &name=Prueba
branch Filtro por sucursal &branch=12
property Busca por el campo "code" del inmueble &property=498572

Í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"

Parámetro Descripción Ejemplo
ASC Orden ascendente &sort=asc
DESC Orden descendente &sort=desc
code Ordenar por código de creación &order=code
name Ordenar por nombre &order=name
identification Ordenar por número de identificación &order=identification