A pesquisa de registros é realizando com o método HTTP GET.

Paginação

O recurso de paginação permite pesquisar um volume grande de registros em objetos de negócio. Afim de reduzir o tamanho do response, os registros são divididos em páginas.

Para obter todos os registros de uma pesquisa com um volume grande de registros recomenda-se:

  1. Realizar GET sem usar pageNum
  2. Verificar no response o valor de pageTotal
  3. Realizar laço de GETs, variando de pageNum=2 até pageTotal

Consulta Incremental

O recurso de consulta incremental permite obter apenas os registros que foram criados e/ou atualizados após determinada data/hora.

Para cadastros base, que necessitam de carga de dados no golive da integração, recomenda-se que:

  1. Seja realizada uma única vez a carga full, sem utilizar updatedAt (e usando de paginação caso necessário)
  2. Sejam realizadas periodicamente cargas incrementais, utilizando updatedAt preenchido com a data/hora da última pesquisa realizada (total ou incremental)