Estructura de respuesta
Todos los servicios tienen una estandarización en los componentes de la respuesta, esto para facilitar el entendimiento a los clientes y permitir identificar el correcto funcionamiento de forma rápida y sencilla. Los componentes son:
- success: Tipo: Boolean. Define mediante True o False si la respuesta fue exitosa o no.
- message: Tipo: CharField. Muestra el código HTTP de la respuesta.
- data: Tipo: Json. Contiene la información que se espera obtener o resultante de ejecutar la petición.
- total: Tipo: Integer. Es la cantidad de ítems que contiene el componente data de la respuesta.
Códigos de respuesta
Los códigos de respuesta son respuestas numéricas informativas del servidor que están basadas en el protocolo HTTP. Estas respuestas cuentan con un significado estandarizado y en FRACTTAL API son los siguientes :
| Código | Descripción |
|---|---|
| 200 | Respuesta exitosa |
| 400 | El request está mal formado. La información para crear el recurso no existe o es inválida |
| 401 | Error en la autenticación. La autenticación falló o no se encontró la información necesaria para autenticar el request. |
| 403 | El usuario no tiene permisos para realizar la acción. |
| 404 | No se encontró en la aplicación el item al que se le desea realizar la acción |
| 405 | Operación no permitida. Ocurre cuando el método del request es inválido para el endpoint requerido. |
| 406 | Ocurre cuando el número de request por minuto fue excedido |
| 407 | El tiempo está fuera del rango. Cuando el ts (timestamp) está fuera del rango del servidor de FRACTTAL API. |
| 408 | El item ya existe. Ocurre cuando se intenta insertar un item ya existente |
| 500 | Ocurrió un error en la aplicación. |