Objeto de respuesta estándar

El objeto estándar de retorno tiene como objetivo garantizar la consistencia en la estructura de las respuestas de todos los endpoints de la API, proporcionando mayor claridad en la información y facilitando la integración y el consumo de los métodos por aplicaciones externas.

---

Estructura del Objeto

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    }
}

---

Descripción de los parámetros

Parámetro	Tipo	Descripción
Status	String	Indica el estado de la operación. Valores posibles: wrsSuccess: Operación realizada con éxito o wrsFailed: Ocurrió un error en la operación
ErrorCode	String	Código del error retornado cuando la operación no es exitosa. Si el campo está vacío, significa que no ocurrió ningún error
Message	String	Mensaje detallado del error presentado
Actor	String	Identificación del método/función que realizó la operación
ReturnQuestion	Object/Null	Información adicional retornada por el sistema, que puede variar según el contexto

---

❗Aviso Importante sobre HTTP Response

⚠️ Nuestra API siempre retorna el estado HTTP 200, incluso en casos de error de negocio.
Los errores deben ser tratados en el objeto de respuesta, con base en el contenido retornado.

• Solo los errores internos del servidor serán retornados como 500 - Internal Server Error.
• Se debe verificar el campo Status en el cuerpo de la respuesta para identificar posibles fallas o errores de negocio.

---

Ejemplo de Retorno Exitoso

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    }
}

---

Ejemplo de Retorno con Error

{
    "WebServiceReturn": {
        "Status": "wrsFailed",
        "ErrorCode": "WSR-004",
        "Message": "El parámetro \"GetCustomInfoParams.CustomInfoScriptName\" informado es inválido!",
        "Actor": "GetCustomInfo/GetCustomInfoCore/ValidateAndLoadQueryCustomParams",
        "ReturnQuestion": null
    },
    "CustomInfoResultList": null
}

---

Consideraciones

• Status: Es obligatorio para identificar el resultado de la operación.
• ErrorCode y Message: Deben ser utilizados para depuración y visualización de mensajes al usuario.
• Actor: Puede ser utilizado para auditoría o para identificar el punto de la API donde ocurrió el problema.
• ReturnQuestion: Es opcional y puede contener información adicional específica para el endpoint.

---