Respuestas y Errores

Las dos familias de servicios tienen formatos de respuesta distintos. Conocerlos te permite manejar el éxito y el error de forma consistente.

Respuestas Optimus

Cada respuesta incluye:

• ContadorErrores — número de errores. 0 significa éxito.
• Mensajes — arreglo con el detalle de cada mensaje (informativo o de error).
• Un arreglo con los datos del servicio (por ejemplo, Portafolios, Basicos, Resultado), presente cuando la operación fue exitosa.

Algunos servicios de creación agregan ContadorAdvertencias y Advertencias: son avisos que no impiden la operación pero señalan datos incompletos.

Estructura de un mensaje

Cada elemento de Mensajes trae:

• IdInterno — correlativo que asocia el mensaje con el ítem de entrada correspondiente.
• TipoMensaje — INFO o ERROR.
• Codigo — código del mensaje (por ejemplo, OPERACION_OK).
• Mensaje — texto descriptivo.

Cómo manejarlo

Revisa siempre ContadorErrores antes de leer los datos. Si es mayor a 0, recorre Mensajes filtrando por TipoMensaje = ERROR y usa Codigo para tu lógica de manejo y Mensaje para mostrar o registrar el detalle. El IdInterno te dice a qué ítem de tu envío corresponde el error, útil cuando envías lotes.

{
  "ContadorErrores": 1,
  "Mensajes": [
    {
      "IdInterno": 1,
      "TipoMensaje": "ERROR",
      "Codigo": "CLIENTE_NO_EXISTE",
      "Mensaje": "No se encontró el cliente indicado."
    }
  ]
}

Respuestas FX Spot

Los servicios /v1/ usan un envoltorio con success y response:

{
  "success": true,
  "response": { }
}

Cuando success es true, los datos están en response. Los errores se comunican además con códigos de estado HTTP:

• 200 — consulta exitosa.
• 201 — recurso creado (orden ingresada).
• 400 — solicitud inválida o errores de validación.
• 403 — no autorizado a operar por ese cliente.
• 404 — recurso o cliente no encontrado.

Buenas prácticas

Trata ContadorErrores (Optimus) y el par success + código HTTP (FX) como tu primera verificación. Registra Codigo/Mensaje para diagnóstico, y no asumas la presencia de los arreglos de datos sin antes confirmar el éxito. Para envíos por lote, apóyate en IdInterno para mapear cada resultado a su entrada.