Cross Segmentos - Backoffice RM - Integração - API - Paginação de requisições

Tempo aproximado para leitura: 00:01:30 min

Dúvida
Como realizar a Paginação em API do RM?

Ambiente
Cross Segmentos - Backoffice RM - Integração - Todas as versões.

Solução

A definição de como a coleção deve ser paginada é definida pelos parâmetros de url page e pageSize respeitando as seguintes regras:

• Os parâmetros da url devem ter os nomes page e pageSize;
• O valor do parâmetro page deve ser um valor numérico (maior que zero) representando a página solicitada.
• O parâmetro page é opcional e na sua ausência deve ser considerado o valor.
• O valor do parâmetro pageSize deve ser um valor numérico (maior que zero) representando o total de registros retornados na consulta.
• O parâmetro pageSize é opcional e na sua ausência deve ser usado o valor padrão definido pela linha de negócio do endpoint (20, por exemplo). Não devem ser retornados todos os registros da consulta.
• Os parâmetros de paginação devem obedecer à semântica de multiplicador, ou seja, se o cliente solicitou page=2 com um pageSize=20 deve-se retornar os registros de 21 até 40;
  A resposta de uma requisição com paginação deve retornar um campo indicando se existe uma próxima página disponível conforme descrito na mensagem de sucesso de lista e esse campo deve ter o nome hasNext.

Caso uma API de Produto da Linha RM não possua o recurso de Paginação implementada, deverá ser realizado o contato junto a equipe responsável desta API, para validações quanto esta implementação e uso do recurso.

Como exemplo segue a Paginação da API de Usuários:
API de Usuários - Paginação.

Realizando a Paginação no Postman:

Saiba Mais:
Segue mais informações sobre a Paginação em uso da API de Usuários:
API de Usuários - Paginação.