Crear asesores


Introducción

Este método tiene como propósito la creación de perfiles de asesores en el sistema desde API. Recuerde por favor enviar los parámetro desde form_params o similar, no envíe parámetros en la url a menos que el método sea de consulta.

Ejemplo de uso

{success} POST: /administrative/brokers

use GuzzleHttp\Client;

$client = new Client();
$res = $client->request("POST", "{$endpoint}/administrative/brokers", [
    "headers" => [
        "Authorization" => "TOKEN_INGRESO"
    ],
    "form_params" => [
        "name" => "Nombre del asesor",
        "last_name" => "Apellido del asesor",
        "document" => 123
    ]
]);

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

Ejemplo de respuesta

{
    "code": 200,
    "message": "The broker was created successfully",
    "broker": {
        "code": 123,
        "name": "Nombre",
        "last_name": "Apellido",
        "document": 12345789
    }
}

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 Body (Form params)

Los parámetros en negrilla son obligatorios y los marcados en cursiva son obligatorios en diferentes circunstancias.

Parámetro Descripción Ejemplo
name Nombres del asesor &name=Prueba
last_name Apellidos del asesor &last_name=Prueba
document Documento de identificación del asesor &document=123456
verification_digit Dígito de verificación del documento (si es nit o existe dígito) &verification_digit=1
phone Número de teléfono fijo del asesor (obligatorio si no se envía "mobile_phone") &phone=123...
mobile_phone Número de celular del asesor (obligatorio si no se envía "phone") &phone=123...
address Dirección de la oficina del asesor &address=Calle...
email Correo electŕonico del asesor &email=prueba@...
alternative_email Correo electrónico alternativo del asesor &alternative_email=prueba@...
picture_url Fotografía del asesor &picture_url=https://...
order Orden de aparición del asesor (especialmente para páginas web) &order=1
department Departamento en que desenvuelve el asesor en la empresa &department=Ventas
description Perfil del asesor &description=Trabaja en...
mls_biz Gestión de inmuebles asignada al asesor &mls_biz=1