La operación Consultar usuario (queryUser): está englobada en el Servicio User Web Service que da soporte a la gestión de usuarios. Esta operación se emplea con el objetivo de comprobar la existencia de
un usuario en el sistema.
Este servicio es controlado por el componente UIM (módulo de Información de Usuarios).
El método acepta de entrada una estructura con los valores nuevo nombre de usuario y password, estos valores son obligatorios y además no nulos. Encripta el password y consulta en la BD si el usuario y su password existe.
Devuelve como respuesta una estructura con una variable que indica si existe el usuario y su password, otra con su identificador en la BD y un mensaje correspondiente a la operación realizada.
queryUser(structure params, string privatekey);
| Parámetros de Entrada |
|---|
| params |
structure con los parámetros de entrada y el orden a seguir:
|
string |
userName |
Nombre de usuario a consultar en el sistema. Parámetro obligatorio no nulo. |
|
string |
userPassword |
Password para ese usuario, se encriptará y se comprueba con el de la BD. Parámetro obligatorio no nulo. |
|
| privatekey |
string clave para poder acceder al servicio privado. Parámetro obligatorio no nulo.
|
| Valores de Salida |
|---|
| result |
structure con los valores de salida:
|
boolean |
validation |
true si tiene éxito en la consulta en la BD y la validación del password, false si no. |
|
int |
iduser |
Identificador de usuario en la BD, devuelve -1 si no encuentra o autentifica al usuario. |
|
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:queryUser>
<params>
<userName> "ejemplo nombre" </userName>
<userPassword> "ejemplo password" </userPassword>
</params>
<privatekey>"ejemplo clave"</privatekey>
</ws:queryUser>
</soapenv:Body>
</soapenv:Envelope>
Ejemplo Respuesta XML
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:queryUserResponse xmlns:ns2="http://ws.cos.acg.ual.es/">
<result>
<validation> "ejemplo true o false" </validation>
<iduser> "ejemplo número con el ID o -1" </iduser>
<message> "ejemplo mensaje de exito o de error" </message>
</result>
</ns2:queryUserResponse>
</soap:Body>
</soap:Envelope>
| Mensajes de Error |
|---|
|
Internal Server Error
|
Se producen por fallos en el servidor al aplicar algoritmos de encriptación o al buscar alguna clase necesaria para la ejecución.
|
|
Private key Error
|
Se produce por clave privada incorrecta. El servicio es Privado y se necesita una clave para acceder a él.
|
|
Not found o Empty username Error
|
Se produce cuando se omite este parámetro en la llamada al servicio o no se proporciona un valor.
|
|
Not found o Empty userpassword Error
|
Se produce cuando se omite este parámetro en la llamada al servicio o no se proporciona un valor.
|
|
Validation Error user o password incorrect
|
Se produce cuando el usuario no existe en la BD o el password es incorrecto.
|
|
PSQLException
|
Se producen por problemas en la conexión a la base de datos.
|
Example Error Response XML
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:queryUserResponse xmlns:ns2="http://ws.cos.acg.ual.es/">
<result>
<validation> false </validation>
<iduser> -1 </iduser>
<message> > Validation Error user o password incorrect </message>
</result>
</ns2:queryUserResponse>
</soap:Body>
</soap:Envelope>
>