Obtener todos los clientes¶

Para obtener el listado de todos los clientes en Wasi, cuentas con la URI:

api.wasi.co/v1/client/search

Esto debería retornar un JSON similar a este:

{
    "total":2,
    "0": {
        "id_client": 1,
        "id_user": "1",
        "client_types": [
            {
                "id_client_type": 7,
                "client_type_label": "Buscando"
            }
        ],
        "id_country": "1",
        "country_label": "Colombia",
        "id_region": "26",
        "region_label": "Quindío",
        "id_city": "63",
        "city_label": "Armenia",
        "id_client_status": "1",
        "id_client_origin": 124,
        "client_origin_label": "Portal Inmobliario",
        "first_name": "Pepito",
        "last_name": "Perez",
        "birthday": "1980-12-12",
        "identification": "11111111111",
        "email": "[email protected]",
        "phone": "11111111",
        "cell_phone": "31111111111111",
        "address": "Calle 1 # 1-11",
        "query": "",
        "comment": "",
        "reference": "",
        "send_information": true,
        "created_at": "2017-02-09 09:02:40",
        "updated_at": "0000-00-00 00:00:00",
        "tag": [
            {
                "id": 20,
                    "etiqueta": "Nuevo Cliente",
                    "color": "#eee"
            }
        ],
    },
    "1": {
        "id_client": 2,
        "id_user": "1",
        "client_types": [
            {
                "id_client_type": 7,
                "client_type_label": "Buscando"
            }
        ],
        "id_country": "1",
        "country_label": "Colombia",
        "id_region": "26",
        "region_label": "Quindío",
        "id_city": "63",
        "city_label": "Armenia",
        "id_client_status": "1",
        "id_client_origin": null,
        "client_origin_label": "",
        "first_name": "John",
        "last_name": "Doe",
        "birthday": "1955-12-12",
        "identification": "21111111111",
        "email": "[email protected]",
        "phone": "21111111",
        "cell_phone": "3211111111111",
        "address": "Calle 2 # 1-11",
        "query": "",
        "comment": "",
        "reference": "",
        "send_information": true,
        "created_at": "2017-02-09 09:02:40",
        "updated_at": "0000-00-00 00:00:00",
        "tag": []
    },
    "status":"success"
}

Filtrado¶

Los filtros son opcionales, a continuación se listan los filtros exitentes para la búsqueda de clientes.

Filtro	Tipo	Detalle
query	String	Palabras claves para realizar una busqueda.
id_property	Number	Id de una propiedad a la que pertenezca el cliente.
id_client_type	Number	Id de un tipo de cliente, ver la sección Tipos de cliente
id_client_status	Number	Identificador del estado del cliente, ver la sección Estados del cliente
id_client_origin	Number	Identificador del medio de captación del cliente, ver la sección Medios de captación
id_user	Number	Identificador unico del usuario (agente o administrador) encargado.

Paginación y ordenamiento¶

Filtro	Tipo
skip	Number	Offset, indica desde donde se muestran los registros, 0 por defecto (desde el inicio, sin omitir ninguno)
take	Number	Limit, cantidad de elementos a listar, 10 por defecto (100 como máximo)
order	String	Puede tomar dos valores asc (Ascendente) y desc (Descendente), asc por omisión
order_by	String	Ordena por una criterio en específico, full_name por omisión ver order_by

order_by¶

Valor	Descripción
full_name	Ordena los clientes por nombre completo
created_at	Ordena los clientes por fecha de registro