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

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, 9 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
alexis_8932
ORO
informatica_13304
ORO
aj.garciolo_346
PLATA
adelantia_311
PLATA
nsat.pedidos_1235
PLATA
oscar_10546
PLATA
s3rtec_4534
PLATA
contacto_14936
PLATA
interiberica_795
PLATA
ivan.gadea_16600
PLATA
josepmp_2501
BRONCE
rexmaris_12857
BRONCE
dani.eus79_11629
BRONCE
fnusmas_5683
PRO
neorazorx_1
PRO
civernet_11724
PRO
jmoreno_2610
PRO
yopli2000_5
PRO
daniel89fg_739
Patrocinar

Amplíe sus conocimientos con los cursos oficiales

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.

303 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? 17 lecciones con 17 vídeos explicativos (más de 8 horas de vídeos) y el código fuente de los ejemplos. Novedades mensuales: Este curso se amplía cada mes con nuevas lecciones.

84 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-2022 FacturaScripts

Soporte