API Reference

Paginação

Paginação

Todas as respostas de API do tipo 'Listar' retornará como primeiro item um array de dados com informações de paginação.

"pagination": {
  "total": 74,
  "perPage": 100,
  "pageCount": 1,
  "currentPage": 1
}
  • total:Total de itens encontrados na requisição. Pode variar caso seja feito algum filtro de busca.
  • perPage:Total de itens retornados por página. O padrão é 100.
  • pageCount:Total de páginas encontradas.
  • currentPage:Total de itens na página atual. Pode variar na última página.

Para selecionar a página na requisição, basta enviar o parâmetro page na url, seguido do número da página que deseja selecionar, por exemplo: https://api.webdanca.com/v1/students?page=2.

Para definir a quantidade de itens por página, basta enviar o parâmetro perPage na url, seguido do número de itens que deseja, por exemplo: https://api.webdanca.com/v1/students?perPage=20.