FILTROS API NUWWE

Los filtros serán enviados por parámetros query los parámetros query son parámetros enviados al final de la URL

Serán usados para definir un conjunto de acciones , basadas en la información que está siendo pasada.

En esta guía se usará insomnia para visualizar los ejemplos:

1. Filtros parciales básicos (NOMBRE_CAMPO LIKE%VALOR%)

Los filtros parciales son útiles cuando se desea buscar dentro de una cadena de texto alguna palabra clave, estos se podrán realizar usando el nombre de la columna por la que se desea filtrar y el valor deseado

Ejemplo 1: filtro para obtener todos los inmuebles tipo venta

https://api.nuwwe.com/api/inmueble?filter%5Bcod_tipo_consignacion%5D=VEN

Este filtro aunque es parcial, será más exacto que el del segundo ejemplo ya que usa el código cod_tipo_consignacion el cual es único

Otra alternativa es usar el nombre como se muestra a continuación

Ejemplo 2: filtro para obtener todos los inmuebles tipo venta por medio del nombre

https://api.nuwwe.com/api/inmueble?filter%5Bnom_tipo_consignacion%5D=VENTA

La diferencia es que este filtro es que buscara todos los inmuebles por nom_tipo_consignacion que contenga la palabra VENTA

Se podrá combinar filtros lo que equivale a realizar filtros con la condición AND

Ejemplo 3: Filtro para obtener todos los inmuebles tipo venta de la ciudad de Bogotá.

https://api.nuwwe.com/api/inmueble?filter%5Bnom_tipo_consignacion%5D=VENTA&filter%5Bcod_ciudad%5D=11001

NOTA: recuerde que la búsqueda parcial por código será mas exacta que la búsqueda por nombre, tener presente que la búsqueda parcial busca coincidencias dentro del texto.

2. Filtros exactos básicos ( NOMBRE_CAMPO = VALOR)

Para obtener mayor exactitud en la búsqueda, se recomienda el uso de los filtros exactos los cuales harán una búsqueda más refinada. Su uso es similar a los filtros parciales solo será necesario anteponer el símbolo “=” al nombre del campo como se muestra a continuación

Ejemplo 4: Filtro exacto para obtener todos los inmuebles tipo venta de la ciudad de Bogotá

3. Ordenamiento

Si desea ordenar use la palabra sort seguido del tipo de ordenamiento y el nombre de columna

Ejemplo 5: Como se ve en la figura si desea ordenar de forma descendente agregue el signo negativo a la columna, si no lo agrega el ordenamiento por defecto será ascendente.

https://api.nuwwe.com/api/inmueble?sort=-vlr_canon 

4. Filtros de rangos

Para algunos campos es útil realizar filtros por rangos, esto será útil para campos que sean tipo fecha o numérico, los siguientes filtros estarán disponibles:

• Menor a: anteponer before al nombre del campo before_nombre_campo

• Mayor a: anteponer after al nombre del campo after_nombre_campo

• Entre: anteponer between al nombre del campo between_nombre_campo

Ejemplo 5: El siguiente filtro obtendrá todos los inmuebles con valores de canon menor o igual a 1000000 ordenamos de forma descendente

https://api.nuwwe.com/api/inmueble?sort=-vlr_canon&filter%5Bbefore_vlr_canon%5D=1000000

Ejemplo 6: El siguiente filtro obtendrá todos los inmuebles con valores de canon mayor l a 1000000 ordenamos de forma descendente.

https://api.nuwwe.com/api/inmueble?sort=-vlr_canon&filter%5Bafter_vlr_canon%5D=1000000

Ejemplo 7: El siguiente filtro obtendrá todos los inmuebles con valores de canon mayor entre 600000 y 1000000 ordenamos de forma ascendente

https://api.nuwwe.com/api/inmueble?sort=vlr_canon&filter%5Bbetween_vlr_canon%5D=600000,1000000

Nota: estos filtros aplica para los endpoints de inmueble, cliente, solicitudes, solo debemos cambiar la variable dentro del filter. Ejemplo: filter[xxxxxxxxxxxx]

https://api.nuwwe.com/api/solicitud?filter%5Bnro_solicitud%5D=519846

https://api.nuwwe.com/api/cliente?filter%5Bcod_cliente%5D=741842748