...
Parâmetro | Descrição | Valor Padrão |
---|---|---|
page | Número da página que está sendo requisitada (o valor da primeira página é 1). | 1 |
page-size | Quantidade total de registros por páginas. | 25 |
O valor padrão será assumido sempre que o parâmetro não estiver preenchido ou estiver nulo. |
---|
...
O tamanho máximo da página (
page-size
) é1000
registros para qualquer endpoint (a menos que na API esteja especificado outros valores).A instituição transmissora/detentora pode definir um tamanho máximo da página (
page-size
) inferior ao tamanho máximo permitido pela API, caso entenda necessário diminuir o limite para atender o SLA de resposta.Caso a instituição transmissora/detentora defina um tamanho máximo de página (
page-size
) inferior, se for requisitado uma quantidade de registros maior do que seu limite operacional, e desde que o valor esteja de acordo o tamanho máximo permitido pela API, esta deverá responder entregando os dados e utilizando opage-size
do seu limite operacional definido.A instituição transmissora/detentora deve realizar os ajustes de paginação antes de efetivar a consulta:
Ex: Ao solicitar a segunda pagina
1000
registros, para uma instituição que trabalha com max size800
, a transmissora deve retornar os itens de801
a1600
.A instituição transmissora/detentora pode definir um tamanho máximo da página (page-size) inferior ao tamanho máximo permitido pela API, caso entenda necessário
diminuir o limite para atender o SLA de resposta" presente na Área do Desenvolvedor > Especificações de APIs > Padrões > Paginação, conforme segue:
Para os produtos da fase 4B, o comportamento esperado da transmissora/detentora é que o page size mínimo é 25 e o máximo é 1000, exceções se aplicam a primeira página, quando for única, e a última página Exemplo: A receptora solicita 5 registros por página, entretanto, a transmissora possui 47 registros. Pelo comportamento descrito, a transmissora retornará 25 registros na primeira página de 22 registros na segunda.