Listar, filtrar y ordenar registros desde la API

Para tener un ejemplo sencillo utilizaremos impuestos, que tiene pocos elementos. Para ello haz una consulta de tipo GET a la url http://localhost:8000/api/3/impuestos

listado api facturascripts

Este listado viene por defecto limitado a 50 elementos y empieza por el primer elemento. Por tanto, sería equivalente a añadir como parámetros ?limit=50&offset=0. Hay que tener esto en cuenta, porque puede que para su aplicación sea conveniente leer más o menos registros de golpe.

Paginación

Para obtener más resultados será necesario indicar a partir de qué elemento queremos seguir recibiendo datos. Para este ejemplo seguiremos a partir del 1, es decir, obtenermos 50 elementos a partir del 1 (nos saltamos el primero, que es el 0):

http://localhost:8000/api/3/impuestos?offset=1

paginar listado api facturascripts

Más ejemplos de paginación:

Partiendo de los parámetros offset y limit, podemos montar la paginación de la forma que sea más conveniente:

Para un limit de 3 (3 elementos por página):

  • Página 1: ?offset=0&limit=3: devolverá los elementos 0, 1, 2.
  • Página 2: ?offset=3&limit=3: devolverá los elementos 3, 4, 5.
  • Página 3: ?offset=6&limit=3: devolverá los elementos 6, 7, 8.

Filtros

Podemos aplicar distintos filtros al listado para obtener solamente aquellos resultados que concuerden con los filtros. Para ello simplemente debemos añadir el parámetro filter[nombre_columna]=valor

Filtrado por codimpuesto

Obtener todos los registros con el valor IVA21 en coddivisa:

http://localhost:8000/api/3/impuestos?filter[codimpuesto]=IVA21

Filtrado por codimpuesto y tipo

Obtener todos los registros con el valor IVA21 en codimpuesto y el valor 1 en tipo:

http://localhost:8000/api/3/impuestos?filter[codimpuesto]=IVA21&filter[tipo]=1

Filtrar por iva

Obtener todos los registros con un valor de iva superior a 8:

http://localhost:8000/api/3/impuestos?filter[iva_gt]=8

Operadores

Los filtros por defecto aplican el operador "=", pero es posible aplicar otros operadores añadiendo un sufijo al nombre de la columna. Ejemplos:

  • filter[tasaconv_gt]=2 -> tasaconv mayor que 2.
  • filter[tasaconv_gte]=2 -> tasaconv mayor o igual que 2.
  • filter[tasaconv_lt]=2 -> tasaconv menor que 2.
  • filter[tasaconv_lte]=2 -> tasaconv menor o igual que 2.
  • filter[tasaconv_neq]=2 -> tasaconv distinto de 2.
  • filter[descripcion_like]=PESO -> descripción contiene PESO.

Operación al aplicar los filtros

Por defecto cada filtro se aplica con una operación AND, es decir, se aplican todos los filtros a los resultados, pero podemos hacer que la operación sea OR. Por ejemplo para obtener el listado de todas las divisas que contengan PESO en su descripción O QUE su tasaconv sea mayor que 2.

http://localhost:8000/api/3/divisas?filter[descripcion_like]=PESO&filter[tasaconv_gt]=2&operation[tasaconv_gt]=OR

Ordenación

Obtener todos los registros que en descripcion contengan PESOS y ordenados por coddivisa de forma descendente:

http://localhost:8000/api/3/divisas?filter[descripcion_like]=PESOS&sort[coddivisa]=DESC

Count o Total de registros

En la respuesta de la API, en el campo X-Total-Count de la cabecera recibimos el número total de registros de la consulta, sin aplicar limit ni offset, es decir:

  • Si estamos consultamos productos, ahí tendremos el número total de productos.
  • Si estamos consultando todos los productos de la familia X, lo que tendremos es el número total de productos de la familia X.

Siguiente

Necesita identificarse para continuar con esta acción. Haga clic en iniciar sesión o cree una cuenta.

Iniciar sesión
PRO
neorazorx_1
neorazorx_1

España, 11 años, nivel 100

La API REST de FacturaScripts

Patrocinadores

FacturaScripts avanza más rápido gracias al apoyo financiero de los patrocinadores, que contribuyen a que podamos dedicar más tiempo al desarrollo, testeo y documentación. Usted también puede poner su granito de arena y convertirse en patrocinador ;-)

ORO
elurk_3992
ORO
manel_11440
ORO
soporte.fs_10883
ORO
aliksi_1525
ORO
alejandro_8931
ORO
interiberica_795
PLATA
rexmaris_12857
PLATA
acaselles_13670
PLATA
jlgonzalezdiaz_12316
PLATA
oguimera_10015
PLATA
atimicroson_10546
PLATA
luis_12743
PLATA
alexis_8932
PLATA
isdpesac_783
PLATA
damien.mathe_13423
PLATA
jesusc_10713
BRONCE
fnusmas_5683
BRONCE
abanpinde.sl_22536
BRONCE
creaccion_12795
PRO
neorazorx_1
PRO
mariano_6807
PRO
jmoreno_2610
Patrocinar

Amplíe sus conocimientos con los cursos oficiales

Curso básico de PHP

¡Aprende a programar en PHP de manera fácil y divertida con nuestro curso básico! En este curso, te enseñaremos los conceptos fundamentales de la programación en PHP, incluyendo la sintaxis básica, el manejo de variables, estructuras de control de flujo y mucho más. Al terminar estarás listo para comenzar con el curso de creación de plugins para FacturaScripts.

29 9,99 €
Curso básico de programación

Con este curso aprenderá cómo crear un plugin sencillo para FacturaScripts: añadir nuevas páginas, tablas y columnas. Para entender este curso no se necesita mucha experiencia en programación, le enseñaremos los básico para modelar problemas sencillos. ¿A quién va dirigido? A cualquier persona con unos conocimientos muy básicos de programación o que ya han completado el curso de PHP. ¿Qué incluye? 18 lecciones con 14 vídeos explicativos.

355 9,99 €
Sesiones de programación

Esta es una recopilación de vídeos y documentación de pequeños desarrollos sobre FacturaScripts y sus plugins. Perfecto para expandir tus conocimientos de programación. ¿A quién va dirigido? A personas que ya hayan superado el curso básico de programación y busquen ampliar sus conocimientos. ¿Qué incluye? 22 lecciones con 22 vídeos explicativos (más de 11 horas de vídeos) y el código fuente de los ejemplos.

130 19,99 €
Cookies
Usamos cookies en nuestro sitio web para brindarte la experiencia más relevante recordando tus preferencias y visitas repetidas. Al hacer clic en "Aceptar", aceptas el uso de TODAS las cookies necesarias.
Copyright (c) 2013-2024 FacturaScripts
0.26698s

Soporte