Saltar al contenido principal

Paginación

Parámetros paginación​

Para hacer uso de la paginación en la API de Idukay, se deben utilizar los siguientes parámetros de consulta:

  • __page: especifica la página de resultados a devolver.
  • __per_page: especifica el número de registros a devolver en una solicitud.

Sintaxis paginación​

Los valores para ambos parámetros deben ser enteros positivos. El valor de __page debe ser mayor o igual a 1.

Estructura de paginación
GET /api/students?__page=<page_number>&__per_page=<records_per_page>

Parámetro de conteo de registros​

Para obtener el número total de registros en la respuesta, puedes agregar el parámetro de consulta __include_totals como ?include_totals=true.

Sintaxis __include_totals​

Este parámetro requiere un valor booleano true.

GET /api/students?__include_totals=true

Ejemplo uso __include_totals​

En este caso, la API devolverá el número total de estudiantes en la respuesta.
GET /api/students?__include_totals=true HTTP/1.1

{
  "response": {
    "results": [
      {
        "_id": "60bc56500000000000000000",
        "name": "John Doe"
      },
      {
        "_id": "60bc56500000000000000001",
        "name": "Peter Parker"
      }
    ],
    "total": 22,
    "actual_total": 22,
    "active": 0,
    "inactive": 22
  },
  "errors": []
}