Objeto de respuesta estándar

Descripción

El objetivo del objeto estándar de retorno es garantizar consistencia en la estructura de las respuestas de todos los endpoints de la API. Este estándar define campos como status, data, message y errors, proporcionando más claridad en la información y facilitando la integración y el consumo de los servicios 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 wrsError: 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 usuario o sistema que realizó la operación
ReturnQuestion	Object/Null	Información adicional retornada por el sistema, pudiendo variar de acuerdo con el contexto

---

❗Aviso Importante sobre HTTP Response

⚠️ Nuestra API siempre retorna el status HTTP 200, incluso en casos de error de negocio.
Los errores deben ser tratados en el objeto de respuesta, basándose en el contenido retornado.

• Solamente 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 fallos o errores de negocio.

---

Ejemplo de Retorno Exitoso

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

---

Ejemplo de Retorno con Error

{
    "WebServiceReturn": {
        "Status": "wrsError",
        "ErrorCode": "WSR-004",
        "Message": "Provided \"GetCustomInfoParams.CustomInfoScriptName\" information is invalid!",
        "Actor": "GetCustomInfo/GetCustomInfoCore/ValidateAndLoadQueryCustomParams",
        "ReturnQuestion": null
    }
}

---

Consideraciones

• Status: Es obligatorio para identificar el resultado de la operación.
• ErrorCode y Message: Deben ser utilizados para depuración y exhibición de mensajes al usuario.
• Actor: Puede ser utilizado para auditoría o identificación de en qué estado la API encontró el problema.
• ReturnQuestion: Es opcional y puede contener informaciones adicionales específicas para el endpoint.

---