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.

...

Nos casos em que o resultado da operação do endpoint represente uma coleção, os itens devem estar agrupados em um objeto com as propriedades hasNext, indicando se existe uma próxima página com mais registros para aquela coleção e itens items que representam a lista de itens retornados.

Bloco de código
languagejs
{
  hasNext: true,
  items: [
    {},
    {},
    ...
  ]
}

Além destes campos obrigatórios é possível retornar campos opcionais e para diferenciá-los deve-se usar o prefixo totvs_. Ex.Está é a estrutura mínima esperada para respostas de coleção, porém, pode-se retornar mais campos se for necessário desde que está estrutura básica se mantenha. Ex:

Bloco de código
languagejs
{
  totvs_totaltransaction_id: 1,
  total: 100,
  hasNext: true,
  items: [
    {},
    {},
    ...
  ]
}

...