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.

...

  • Ao referenciar uma entidade na URL ela deve estar no plural. Ex. /users ao invés de /user;
  • Evite caminhos com mais de 3 parâmetros (além da versão da API), pois isso dificulta a leitura e normalmente indica um problema arquitetural;
  • O caminho deve apontar para um recurso e não para uma ação sobre a entidade, use os verbos HTTP para representar uma ação. Nos casos onde não exista um verbo apropriado a ação pode ser informada como parâmetro no caminho da URL ou na URL.

...

Todos as transações de informação que suportam campos de do tipo data/hora, tanto no corpo das mensagens quanto nas urls, devem usar o formato definido formato de data UTC extendido.

 

Informações
titleiso

Detalhes sobre a definição do formato podem ser encontrados no documento ISO-8601

 

 

  no formato EXTENDIDO.

Coleções

Ordenação

Todos os endpoints de coleção devem suportar ordenação. A definição de como a lista deve ser ordenada é definida no parâmetro de url order respeitando as seguintes regras:

...