Paginación

En esta guía, veremos cómo trabajar con respuestas paginadas al consultar la API de Subsidy. De forma predeterminada, todas las respuestas limitan los resultados a diez. Sin embargo, puede modificarse el límite agregando el parámetro pagination.amount a sus solicitudes. Para navegar a la siguiente o anterior página, se debe incluir el parámetro pagination.page indicando en qué pagina se encuentra (Este valor debe ser por lo menos 1).

Cuando una respuesta API devuelve una lista de objetos, sin importar la cantidad, se permite la paginación. En las respuestas paginadas, los objetos están anidados en un atributo de datos items y tienen un atributo pagination que indica la página actual, página máxima y la cantidad total de objetos. Puede usar los parámetros de consulta page, maxPage y total para identificar el estado actual de la paginación.

Ejemplo

Ejemplo simple de como realizar un pedido con paginación.

Atributos

  • Name
    pagination.page
    Type
    integer
    Description

    Página actual de la lista.

  • Name
    pagination.amount
    Type
    integer
    Description

    Cantidad de objetos a obtener por página.

Atributos de la respuesta

  • Name
    pagination.page
    Type
    integer
    Description

    Página actual de la lista.

  • Name
    pagination.amount
    Type
    integer
    Description

    Cantidad de objetos en esta página.

  • Name
    pagination.maxPage
    Type
    integer
    Description

    Página máxima posible.

  • Name
    pagination.total
    Type
    integer
    Description

    Cantidad total de objetos en la lista.

Pedido con paginación

{
  "pagination": {
    "page": 1,
    "amount": 10
  }
}

Respuesta con paginación

{
  "pagination": {
    "page": 1,
    "amount": 10,
    "maxPage": 5,
    "total": 45
  },
  "items": [
    {
      "id": "WAz8eIbvDR60rouK",
      // ...
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    },
    {
      "id": "fbwYwpi9C2ybt6Yb"
      // ...
    }
    // ...
  ]
}