Saltar al contenido

Códigos de respuesta

Estado HTTP

EstadoSignificadoQué hacer
200Operación concluida.—
400Parámetros incorrectos, cuerpo vacío o no válido, Content-Type distinto de application/json en las rutas de gestión, o header Authorization ausente o mal formado.Revise los campos, los headers y los valores enviados.
401Token no válido o caducado, o credenciales no aceptadas.Obtenga un nuevo token en POST /oauth/token.
403El operador no tiene el permiso exigido o acceso a la entidad; en los informes, también start/end ausentes o no enteros; en el inicio de sesión, operador bloqueado.Revise los permisos de los grupos del operador y los parámetros.
404Entidad no encontrada.Revise el identificador indicado.
415Content-Type distinto de application/x-www-form-urlencoded en la emisión del token.Envíe las credenciales como formulario.
500Error interno del servidor.Inténtelo de nuevo; si persiste, contacte al soporte.

Formato de los errores

Los errores de las rutas de la API siguen el formato:

{
  "field": "instance",
  "error": "instance error",
  "error_description": "NAME is required"
}

Los errores de validación del header Authorization (400 y 401) se responden en texto simple, como Unauthorized.

Respuestas sin registros

Los informes responden 200 con {"data": null, "next": ""} cuando no hay registros para los filtros indicados.

Códigos de mensaje

Los informes incluyen el código del mensaje en CODIGOMENSAGEM (por ejemplo, MSG0065 o MSG3100). Identifica el evento registrado por la plataforma.