Obtener un listado de elementos de un recurso

Para tener un ejemplo sencillo utilizaremos divisas, que tiene pocos elementos. Accedemos a http://localhost:8000/api/3/divisas

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:

http://localhost:8000/api/3/divisas?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 coddivisa

Obtener todos los registros con el valor ARS en coddivisa:

http://localhost:8000/api/3/divisas?filter[coddivisa]=ARS

Filtrado por coddivisa y codiso

Obtener todos los registros con el valor ARS en coddivisa y el valor 32 en codiso:

http://localhost:8000/api/3/divisas?filter[coddivisa]=ARS&filter[codiso]=32

Filtrar por tasaconv

Obtener todos los registros con un valor de tasaconv superior a 2:

http://localhost:8000/api/3/divisas?filter[tasacon_gt]=2

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

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

Iniciar sesión
neorazorx_1
neorazorx_1
3358 Puntos 8 años
Fecha de creación 14-05-2018 00:00:00
Última actualización 04-03-2019
Contador de visitas 1317
Curso básico de usuario

Con este curso aprenderá a gestionar el día a día de su negocio con FacturaScripts 2021: hacer facturas, albaranes, pedidos y presupuestos. Gestionar clientes, proveedores y tarifas. Y a realizar la regularización de impuestos (trimestre de IVA). ¿A quién va dirigido? A cualquier usuario que ya tenga FacturaScripts instalado en su PC o hosting y quiera aprender rápidamente el manejo diario del programa. ¿Qué incluye? 18 lecciones con 17 vídeos explicativos.

180 4,99 €
Curso básico de programación

Con este curso aprenderá cómo crear un plugin sencillo para FacturaScripts 2021: 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. ¿Qué incluye? 18 lecciones con 14 vídeos explicativos.

187 5,99 €
Sesiones de programación 2021

Esta es una recopilación de vídeos y documentación de pequeños desarrollos sobre FacturaScripts 2021 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? 8 lecciones con 8 vídeos explicativos (más de 4 horas de vídeos) y el código fuente de los ejemplos. Novedades mensuales: Este curso se amplía cada mes con nuevas lecciones.

17 9,99 €

Copyright (c) 2013-2021 FacturaScripts