...

Mensagens de sucesso (código http 2xxdevem 2xx devem) devem retornar diretamente a entidade que representa o objeto resultado da operação do endpoint. Ex:

...

O cliente chamou um endpoint para subir um documento mas não havia espaço em disco no servidor. Deve retornar o código 507 - Insufficiente Storage.

Filtro de campos da resposta

A APIs devem permitir ao cliente filtrar os campos retornados nas entidades. Para isso ele deve passar o parâmetro de query com nome fields que consiste de uma lista com o nome das propriedades JSON que serão retornadas. Os campos omitidos serão removidos do retorno (mesmo que o cliente tenha solicitado expandi-los).

Omitir o campo fields fara com que todos os campos sejam retornados.

Por exemplo, o cliente faz uma requisição para retornar os dados do cliente com id 10:

GET http://totvs.com.br/api/users/10

{
  _expandables: ["permissions"],
  name: "John",
  sobrenome: "Doe",
  age: 18,
  country: US,
  permissions: {}
}

Caso os únicos campos interessantes para o cliente sejam o "name" e "age" ele pode reduzir a quantidade de dados usando o parâmetro fields. Ex:

GET http://totvs.com.br/api/users/10?fields=name,age

{
  name: "John",
  age: 18
}

Parâmetros expansíveis

Todos os endpoints devem respeitar e suportar os campos expansíveis. E devem retornar os campos retraídos a menos que especificado na requisição através do parâmetro de url expand.

...