Problema
A solicitação retornaria mais de 1000 registros e, por esse motivo, foi rejeitada pela API.
Esse limite existe para evitar consultas muito grandes, que podem comprometer o desempenho da aplicação e aumentar o tempo de resposta.
Quando esse erro ocorrer, significa que é necessário dividir a consulta em partes menores utilizando paginação ou definindo um intervalo de registros.
Dica: Sempre utilize filtros que reduzam a quantidade de registros retornados, principalmente em consultas históricas ou de grande volume.
Solucao
Existem duas formas de resolver esse problema:
- Utilizar os parâmetros
PageNumberePageSizepara realizar a paginação dos resultados. - Utilizar os parâmetros
RangeStarteRangeEndpara solicitar apenas um intervalo específico de registros.
A paginação é a abordagem recomendada para a maioria das integrações, pois permite recuperar todos os registros em múltiplas requisições, respeitando o limite máximo permitido pela API.
Exemplo
- Primeira consulta:
PageNumber = 1ePageSize = 500 - Segunda consulta:
PageNumber = 2ePageSize = 500 - Terceira consulta:
PageNumber = 3e assim sucessivamente, até que não existam mais registros.
Importante: A API permite retornar no máximo 1.000 registros por requisição. Caso a consulta ultrapasse esse limite, será retornado o status HTTP 416 - Requested Range Not Satisfiable.