Interaction Web Service > Register Interaction

Ir a probar servicio

La operación Resgitrar Interacción (Register Interaction): está englobada en el Servicio Interaction Web Service que da soporte a la gestión de las interacciones que puedan surgir y que no se hayan tenido en cuenta en el sistema previamente. Esta operación se emplea con el objetivo de que el usuario pueda registrar información como crea conveniente en la B.D. más allá de la que se registrar al interactuar con el sistema de forma automática.

Este servicio es controlado por el componente IMM (módulo de Gestión de Interacción). El método acepta de entrada una estructura con el Id del usuario que tiene la sesión iniciada y con la operación realizada, estos valores son obligatorio y además no nulo. Opcionalmente se puede enviar el resto de información de interacción y del estado del modelo. La operación calcula la hora de sistema e inserta la interacción en la base de datos de interacción. Devuelve como respuesta una estructura con una variable que indica si el inicio ha tenido éxito o no y un mensaje correspondiente a la operación realizada.

registerInteraction(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.

string

newSession

Nueva sesión iniciada en el sistema, se utiliza los valores "0" y "1" cuando se registra la interaccion por el sistema.

structure

interaction

structure con los datos de interacción que puede proporcionar el usuario.

string	deviceType	Tipo de dispositivo desde el que se está accediendo (Browser,Phone,Tablet,TV).
string	interactionType	Tipo de interacción de entrada (MouseKeyboard, Voice, Gestural, Touch).
string	latitude	Latitud, información geográfica que pueda proporcionar el dispostivo.
string	longitude	Longitud, información geográfica que pueda proporcionar el dispostivo.

string

operationPerformed

La operación que se ha llevado a cabo y que se va a registrar. Parámetro obligatorio no nulo.

string

componentId

Instancia del componente.

list string

groupComponent

Lista de servicios agrupados, en el sistema se utiliza para expresar el conjunto de servicios de un componente que ha sufrido una agrupación.

list string

ungroupComponent

Lista de servicios agrupados, en el sistema se utiliza para expresar el conjunto de servicios de un componente que ha sufrido una desagrupación.

list structure

cotsget

Lista de componentes del modelo concreto para ese usuario.

string

platform

Plataforma a la que pertenece el componente.

string

componentname

Nombre del componente.

string

componentAlias

Alias de la instancia componente.

string

instanceId

Instancia del componente.

string

codeHTML

Código del iframe para componentes de plataforma "Web".

string

objectJava

Objeto serializado. Para componentes de plataforma tipo "Java".

string

jarJava

Nombre del archivo jar que contiene el objeto java. Para componentes de plataforma tipo "Java".

string

idHtml

Identificador del elemento html en el DOM.

int

posx

Posición del componente que indica en que columna está.

int

posy

Posición del componente que indica en que fila está.

int

tamanox

Tamaño del componente que indica en cuantas columnas ocupa.

int

tamanoy

Tamaño del componente que indica en cuantas filas ocupa.

string

servicio_maximizable

Indica si el componente puede ser maximizado.

string

servicio_agrupable

Indica si el componente puede agrupar servicios.

int

numero_servicios

Número de servicios agrupados en este componente.

list structure

servicios

Lista de servicios en este componente.

string	componentname	Nombre del componente al que pertenece este servicio.
string	componentAlias	Alias del componente al que pertenece este servicio.
string	instanceId	Identificador del Servicio
string	mapaKML	Mapa KML del Servicio OGC cargado.
string	capa	Capa del Servicio OGC cargado.

Valores de Salida

result

structure con los valores de salida:

boolean	registered	true si tiene éxito la inserción en la B.D. de interacció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:registerInteraction>

		 <params>

			<userId> "ejemplo de Id" </userID>

			<newSession> "ejemplo de valor de sesión o vacio" </newSession>

			<interaction>

				<deviceType> "ejemplo de dispositivo o vacio" </deviceType>

				<interactionType> "ejemplo de tipo de interacción o vacio" </interactionType>

				<latitude> "ejemplo de latitud o vacio" </latitude>

				<longitude> "ejemplo de longitud o vacio" </longitude>

			</interaction>

			<operationPerformed> "ejemplo de operacion" </operationPerformed>

			<componentId> "ejemplo de identificador de componente o vacio" </componentId>

			<groupComponent> "ejemplo de identificador de servicios en el componente agrupado o vacio" </groupComponent>

			... 

			<groupComponent> "ejemplo de identificador de servicios en el componente agrupado o vacio" </groupComponent>

			<ungroupComponent> "ejemplo de identificador de servicios en el componente desagrupado o vacio" </ungroupComponent>

			... 

			<ungroupComponent> "ejemplo de identificador de servicios en el componente desagrupado o vacio" </ungroupComponent>

			<cotsget> "<platform></platform><componentname>...<capa></capa></servicios> </cotsget>

			... 

			<cotsget> <platform></platform><componentname> ...<capa></capa></servicios> </cotsget>

			</params>

	  </ws:registerInteraction>

   </soapenv:Body>

</soapenv:Envelope>

Ejemplo Respuesta XML


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

   <soap:Body>

	  <ns2:registerInteractionResponse xmlns:ns2="http://ws.cos.acg.ual.es/">

		 <result>

			<registered> "ejemplo true o false" </registered>

			<message> "ejemplo mensaje de exito o de error" </message>

		 </result>

	  </ns2:registerInteractionResponse>

   </soap:Body>

</soap:Envelope>

Mensajes de Error
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.
Not found o Empty Operation Performed	Se produce cuando se omite este parámetro en la llamada al servicio.
PSQLException	Se producen por problemas en la conexión a la base de datos.
Error in Register Interaction	Se producen por problemas en la consulta a la base de datos de interacción.
Internal Server Error	Se producen por fallos en el servidor al buscar alguna clase necesaria para la ejecución.

Example Error Response XML


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

   <soap:Body>

      <ns2:registerInteractionResponse xmlns:ns2="http://ws.cos.acg.ual.es/">

         <result>

			<registered> false </registered>

			<message> > Not found o Empty Operation Performed </message>

         </result>

      </ns2:registerInteractionResponse>

   </soap:Body>

</soap:Envelope>

Probar el Servicio
Rellene Parámetros de Entrada: ID de usuario: New Session: Dispositivo: Tipo de Interacción: Latitud: Longitud: Operation Performed: Component ID: Lista group Component: Lista ungroup Component: Lista Cotsget:		Respuesta de Salida obtenida: Registrado: Mensaje:

WS Publicos

Session Web Service