Padrões e Retorno

A estrutura da API é baseada em REST (Representational State Transfer) no formato JSON (JavaScript Object Notation) com retorno padronizado.

Retorno de Entidade Única

{
  "code": 200,
  "message": "string",
  "data": {
    // ...
  },
  "error": "string"
}

Campo	Tipo	Descrição
code	Number	200 (sucesso), -400 (erro cliente), -500 (erro servidor)
message	String	Mensagem de retorno
data	Object	Dados de retorno da entidade solicitada
error	String	Dados sobre o erro gerado

Retorno de Coleções

{
  "code": 200,
  "message": "string",
  "count": 0,
  "totalPages": 0,
  "pagingLimit": 0,
  "pagingIndex": 0,
  "data": [
    {
      // ...
    }
  ],
  "error": "string"
}

Campo	Tipo	Descrição
code	Number	200 (sucesso), -400 (erro cliente), -500 (erro servidor)
message	String	Mensagem de retorno
count	Number	Quantidade de registros
totalPages	Number	Total de páginas
pagingLimit	Number	Quantidade de itens por página
pagingIndex	Number	Página atual da coleção dos dados
data	Collection	Coleção de dados de retorno da entidade solicitada
error	String	Dados sobre o erro gerado