Perfiles

Introducción

Lista de perfiles de la inmobiliaria con sus datos generales para una lista de agentes

Ejemplo de uso

{success} GET: /administrative/profiles

use GuzzleHttp\Client;

$client = new Client();
$res = $client->request("GET", "{$endpoint}/administrative/profiles", [
    "headers" => [
        "Content-type" => "application/json",
        "Accept" => "application/json",
        "Authorization" => "TOKEN_INGRESO"
    ]
]);

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

Ejemplo de respuesta

{
    "code": 200,
    "message": "Profiles listed successfully",
    "data": {
        "total": 1,
        "data": [
            {
                "code": 1,
                "name": "Perfil",
                "email": "[email protected]",
                "document": "123456789",
                "picture": "picture.jpg",
                "language": "es_CO",
                "phone": "123456789",
                "mobile_phone": "+57123456789",
                "whatsapp_number": "+57123456789"
            }
        ]
    }
}

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
status Estado del agente, (por defecto se muestran agentes de todos los estados) &status=1
branch Sucursal del agente &branch=1
name Filtro por una parte del nombre &name=Pru
email Filtro por una parte del correo &email=Pru
phone Filtro por una parte del teléfono (sin el indicativo) &phone=123
mobile_phone Filtro por una parte del teléfono celular (sin el indicativo) &mobile_phone=456
whatsapp_number Filtro por una parte del número de whatsapp (sin el indicativo) &whatsapp_number=789

Í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
email Ordenar por correo &order=email
document Ordenar por correo &order=document
phone Ordenar por teléfono &order=phone
mobile_phone Ordenar por celular &order=mobile_phone
whatsapp_number Ordenar por número de whatsapp &order=whatsapp_number