La operación Borrar usuario (deleteUser): 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 borrar un usuario del 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 el valor del ID de usuario, este valor es obligatorios y además no nulos. La operación realiza el borrado en la BD.
Devuelve como respuesta una estructura con una variable que indica si el borrado a tenido éxito o no y su mensaje correspondiente.
deleteUser(structure params, string privatekey);
| Parámetros de Entrada |
|---|
| params |
structure con los parámetros de entrada y el orden a seguir:
|
string |
userId |
Identificador de usuario, se requiere que exista en el sistema. 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 |
deleted |
true si tiene éxito el borrado en la BD, 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:deleteUser>
<params>
<userId> "ejemplo identificador" </userId>
</params>
<privatekey>"ejemplo clave"</privatekey>
</ws:deleteUser>
</soapenv:Body>
</soapenv:Envelope>
Ejemplo Respuesta XML
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:deleteUserResponse 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:deleteUserResponse>
</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.
|
|
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 userid Error
|
Se produce cuando se omite este parámetro en la llamada al servicio o no se proporciona un valor.
|
|
PSQLException
|
Se producen por problemas en la conexión a la base de datos.
El error más común se produce por intentar registrar un usuario nuevo con un nombre ya existente en la BD, siendo este el mensaje de error:
> org.postgresql.util.PSQLException: ERROR: llave duplicada viola restricción de unicidad «unique_username»
|
Example Error Response XML
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:deleteUserResponse xmlns:ns2="http://ws.cos.acg.ual.es/">
<result>
<deleted> false </deleted>
<message> > Not found o Empty userid Error </message>
</result>
</ns2:deleteUserResponse>
</soap:Body>
</soap:Envelope>
>