Convenções das Responses

Veja como funcionam as responses da API do My Turn.

Convenções das Responses

Todas as responses de listagem da API do My Turn seguem o mesmo padrão e retornam um objeto JSON com três chaves principais:

  • data -> contém a coleção de registros retornados.
  • links -> inclui os links de paginação, como next, prev, etc.
  • included -> inclui os registros associados incluídos, por exemplo o vendedor de um atendimento.
  • meta -> traz informações adicionais sobre a paginação, como page, total-pages e total-items.

Sobre as responses de registro único:

As responses de obtenção de um registro, como /sellers/:ID, retornam o mesmo objeto JSON, porém apenas com a chave data.

As responses de obtenção de um único registro (por exemplo, GET /sellers/:id) retornam o mesmo formato JSON, mas apenas com a chave data, que representa o recurso solicitado.