• Antes de empezar a programar +
  • ¿Qué versión de Symfony utiliza FacturaScripts?
  • Sistema de Prioridades de Plugins en FacturaScripts
  • Diagramas de tablas
• Creación de Plugins +
  • El archivo facturascripts.ini
  • El archivo Init.php
  • Los Controladores +
    • Controladores extendidos +
      • ListController +
        • addFilterAutocomplete()
        • addFilterCheckbox()
        • addFilterDatePicker()
        • addFilterNumber()
        • addFilterPeriod()
        • addFilterSelect()
        • addFilterSelectWhere()
      • EditController
      • PanelController +
        • addHtmlView()
        • addEditView()
        • addEditListView()
        • addListView()
      • Personalizando con Settings
      • disableColumn()
      • Interactuar con las Vistas
    • Obtener parámetros de la URL, formularios o cookies
    • Guardar una cookie
    • Consultar el usuarios y sus permisos
    • Formularios de edición de facturas, albaranes, etc
  • Añadir un endpoint a la API
  • Los modelos +
    • Operaciones comunes con modelos
    • La definición de la estructura de la tabla
    • ModelOnChangeClass
    • Modelos de más de una tabla
    • Modelos especiales
    • Cómo crear una factura, albarán, pedido o presupuesto
    • Herencia de modelos
    • $modelo->install()
    • $modelo->all()
    • $modelo->clear()
    • $modelo->count()
    • $modelo->delete()
    • $modelo->exists()
    • $modelo->loadFromData()
    • $modelo->get()
    • $modelo->getModelFields()
    • $modelo->loadFromCode()
    • $modelo->primaryColumnValue()
    • $modelo->primaryColumn()
    • $modelo->newCode()
    • $modelo->tableName()
    • $modelo->save()
    • $modelo->primaryDescription()
    • $modelo->primaryDescriptionColumn()
    • $modelo->url()
    • $modelo->test()
  • Las vistas HTML +
    • Iconos disponibles
    • Herencia de plantillas
  • Las vistas XML (XMLView) +
    • Columns (XMLView)
    • Rows (XMLView) +
      • Row status (XMLView)
      • Row statistics
      • Row actions
      • Row header y footer
    • Modals (XMLView)
    • Group (XMLView)
    • Column (XMLView)
    • Widget (XMLView) +
      • Widget Autocomplete
      • Widget Bytes
      • Widget Checkbox
      • Widget Color
      • Widget Datalist
      • Widget Date
      • Widget Datetime
      • Widget File
      • Widget Library
      • Widget Link
      • Widget Money
      • Widget Number
      • Widget Password
      • Widget Select
      • Widget Stars
      • Widget Text
      • Widget Textarea
      • Widget Time
      • Widget Radio
      • Widget Variante
  • Las traducciones en Plugins
  • Las extensiones +
    • Extensiones de controladores
    • Extensiones de modelos
    • Extensiones de tablas
    • Extensiones de XMLView
    • Extensiones de Vistas HTML
  • Mostrar mensajes, errores y alertas
  • Acceso a la base de datos +
    • DbQuery
    • Where
    • DataBaseWhere
  • Settings: opciones del panel de control +
    • Cómo crear preferencias de aplicación para su plugin
  • Generación de PDF y Excel
  • AssetManager
  • El archivo Cron.php
  • Cómo publicar plugins en facturascripts.com
• Profundizando en el CORE +
  • Enrutado
  • Gestión de errores
  • Gestión de Plugins
  • Uso de la caché
  • La cola de trabajos
  • Descargar archivos de MyFiles
  • Cliente de API de OpenAI
  • Cliente HTTP
  • Validar emails, string, urls, etc...
  • Enviar emails con NewMail
• Testeo de plugins
• Migración de plugins antiguos +
  • Row Business (Obsoleto)
  • Migrar los XML de las tablas de 2017
  • Migrar los modelos de 2017
  • addGridView() - (obsoleto)
• Guía de la API REST de FacturaScripts
  • Listado de recursos (modelos)
  • Listar, filtrar y ordenar registros desde la API
  • Obtener un registro concreto desde la API
  • Crear o añadir registros desde la API
  • Cómo crear facturas desde API
  • Obtener el PDF de una factura desde la API
  • Modificar registros desde la API
  • Eliminar registros desde la API

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

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

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.