Esta web utiliza cookies propias y de terceros para su funcionamiento. ¿Aceptas? Leer más
La API REST de FacturaScripts

Obtener un listado de elementos de un recurso

Para tener un ejemplo corto, utilizaremos divisas que tiene pocos atributos, accediendo a http://localhost:8000/api/3/divisas

listado api facturascripts

Este listado por defecto viene 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 la siguiente página de 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 partiendo del siguiente ejemplo:

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 1: offset = limit * 0 (3 * 0 = 0)
  • Página 2: ?offset=3&limit=3: devolverá los elementos 3, 4, 5
    • Página 2: offset = limit * 1 (3 * 1 = 3)
  • Página 3: ?offset=6&limit=3: devolverá los elementos 6, 7, 8
    • Página 3: offset = limit * 2 (3 * 2 = 6)

Paginar 3 elementos desde offset 0 (http://localhost:8000/api/3/divisas?offset=0&limit=3)

Paginar 3 elementos desde offset 3 (http://localhost:8000/api/3/divisas?offset=3&limit=3)

Realizar una búsqueda

Filtrado por descripción

Obtener todos los registros que en descripcion contengan PESOS (http://localhost:8000/api/3/divisas?filter[descripcion]=PESOS):

Filtrado por descripción y codiso

Obtener todos los registros que en descripcion contengan PESOS y en codiso contengan 2 (http://localhost:8000/api/3/divisas?filter[descripcion]=PESOS&filter[codiso]=2):

Ordenación

Obtener todos los registros que en descripcion contengan PESOS y ordenados por coddivisa de forma descendiente (http://localhost:8000/api/3/divisas?filter[descripcion]=PESOS&sort[coddivisa]=DESC):