Páginas filhas
  • Guia de implementacao das APIs TOTVS

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  • 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 1;
  • 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 considerado o valor 20;
  • Os parâmetros de paginação DEVEM obedecer a 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 (linkar) e esse campo DEVE ter o nome hasNext.

...

Bloco de código
languagejs
{
  content: {}
}

Âncora
ApiSuccessMsgColl
ApiSuccessMsgColl
Mensagens de sucesso para coleções

Nos casos em que o resultado da operação do endpoint represente uma coleção além do campo content deve ser retornado o campo hasNext indicando se existe uma próxima página com mais registros para aquela coleção.

...