La operación Cerrar sesión (Logout): está englobada en el Servicio Session Web Service que da soporte a la gestión de las sesiones. Esta operación se emplea con el objetivo eliminar las variables de sesión,
ósea destruir los módulos de sesión inicializados por el usuario.
Este servicio es controlado por el componente COSSessionMM (módulo de Gestión de Sesiones del COSCore).
El método acepta de entrada una estructura con el Id del usuario que tiene la sesión iniciada, este valor es obligatorio y además no nulo. La operación elimina los módulos asociados a la sesión de ese usuario y devuelve como respuesta una estructura con una variable que indica si el borrado ha tenido éxito o no y un mensaje correspondiente a la operación realizada.
logout(structure params);
Parámetros de Entrada |
params |
structure con los parámetros de entrada y el orden a seguir:
string |
userId |
Id de usuario con una sesión iniciada en el sistema. Parámetro obligatorio no nulo. |
|
Valores de Salida |
result |
structure con los valores de salida:
boolean |
deleted |
true si tiene éxito el borrado de los módulos de sesión, false si no. |
string |
message |
Mensaje de éxito o de error y su tipo. |
|
Ejemplo Petición XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.cos.acg.ual.es/">
<soapenv:Header/>
<soapenv:Body>
<ws:logout>
<params>
<userId> "ejemplo de Id" </userID>
</params>
</ws:logout>
</soapenv:Body>
</soapenv:Envelope>
Ejemplo Respuesta XML
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:logoutResponse xmlns:ns2="http://ws.cos.acg.ual.es/">
<result>
<deleted> "ejemplo true o false" </deleted>
<message> "ejemplo mensaje de exito o de error" </message>
</result>
</ns2:logoutResponse>
</soap:Body>
</soap:Envelope>
Mensajes de Error |
Internal Server Error
|
Se producen por fallos en el servidor al buscar alguna clase necesaria para la ejecución.
|
Not found o Empty userId Error
|
Se produce cuando se omite este parámetro en la llamada al servicio o no se proporciona un valor.
|
Error Delete Modules
|
Se produce cuando se intenta realizar un logout sobre una sesión no inicializada, al no estar la sesión iniciada no se encuentran los módulos asociados a ese usuario.
|
Example Error Response XML
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:logoutResponse xmlns:ns2="http://ws.cos.acg.ual.es/">
<result>
<deleted> false </deleted>
<message> > Error Delete Modules </message>
</result>
</ns2:logoutResponse>
</soap:Body>
</soap:Envelope>
>