Estrutura de resposta
Todos os serviços têm componentes de resposta padronizados para facilitar a compreensão dos clientes e a identificação do funcionamento correto de forma rápida e fácil. Os componentes são:
- Success: Tipo: Booleano. Define por True (verdadeiro) ou False (falso) se a resposta foi bem-sucedida ou não.
- message: Tipo: CharField. Exibe o código HTTP da resposta.
- data: Tipo: Json. Contém as informações esperadas ou resultantes da execução da solicitação.
- total: Tipo: Integer. Esse é o número de itens contidos no componente de dados da resposta.
Códigos de resposta
Os códigos de resposta são respostas numéricas informativas do servidor que se baseiam no protocolo HTTP. Essas respostas têm um significado padronizado e, na API FRACTTAL, são as seguintes:
| Código | Descrição |
|---|---|
| 200 | Resposta bem sucedida |
| 400 | O pedido (request) está mal formado. As informações para criar o recurso não existem ou são inválidas |
| 401 | A autenticação falhou ou as informações necessárias para autenticar a solicitação não foram encontradas. |
| 403 | O usuário não tem permissões para realizar a ação. |
| 404 | O item que você deseja realizar a ação não foi encontrado no aplicativo |
| 405 | Operação não é permitida. Ocorre quando o método de solicitação é inválido para o ponto final necessário. |
| 406 | Ocorre quando o número de solicitação por minuto foi excedido |
| 407 | O tempo está fora de alcance. Quando o ts (timestamp) estiver fora do alcance do servidor API FRACTTAL. |
| 408 | O item já existe. Ocorre quando você tenta inserir um item existente |
| 500 | Ocorreu um erro na aplicação. |