4.- Servicios de PAU

4.- Servicios de PAU

En este apartado se explicarán los servicios de PAU, cómo invocar, parámetros que devuelve y un ejemplo de invocación de cada servicio

 

ÍNDICE DE SERVICIOS

 

Servicios IInfoServicePortType

Búsquedas y consultas de aplicaciones

Método 'applicationList'

Servicio que devuelve una lista de aplicaciones definidas en la aplicación PAU, en función de la información que se pasa como parámetro en el objeto ParamApplicationList.

La información devuelta de cada aplicación incluye, el alias de la aplicación, el nombre de la aplicación, las Ips asignadas o los métodos que tiene asociados.

 

Signatura

ResultApplicationList applicationList(ParamApplicationList paramApplicationList)

Parámetros de invocación

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

applicationId

String

Aplicación que ejecuta el método

fiscalAnagram

String

Anagrama fiscal

applicationSearch

ApplicationSearch

Objeto ApplicationSearch

Parámetros de respuesta

 

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

resultError

ResultError

Objeto ResultError

applications

Application[]

Lista de objetos Application

size

int

Tamaño de la lista applications devuelta

Códigos error

 

Código

Descripción

Código

Descripción

APPLICATIONLIST_00

Error durante el proceso de búsqueda de aplicaciones.

APPLICATIONLIST_01

El objeto ParamApplicationList es nulo.

APPLICATIONLIST_02

No se han encontrado aplicaciones para estos parámetros de búsqueda.

APPLICATIONLIST_03

Ha ocurrido algún error al realizar la búsqueda.

APPLICATIONLIST_04

Error de paginación al realizar la búsqueda.

Ejemplo de invocación

Ejemplo de invocación
ParamApplicationList params = new ParamApplicationList(); ApplicationSearch appSearch = new ApplicationSearch(); appSearch.setAlias("PAU"); params.setApplicationSearch(appSearch); ResultApplicationList result = pauAgent.applicationList(params);

Método 'applicationRelationList'

Servicio que devuelve una lista con las relaciones de acceso existentes entre dos aplicaciones, dada de alta en PAU, en función de la información pasada como parámetro en el objeto paramApplicationRelationList

Esta relación es la que permite que una aplicación utilice servicios de otra aplicación.

Signatura

ResultApplicationRelationList applicationRelationList (ParamApplicationRelationList paramApplicationRelationList)

Parámetros de invocación

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

applicationId

String

Aplicación que ejecuta el método

fiscalAnagram

String

Anagrama fiscal

applicationRelationSearch

ApplicationRelationSearch

Objeto ApplicationRelationSearch

Parámetros de respuesta

 

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

resultError

ResultError

Objeto ResultError

applicationRelations

ApplicationRelation[]

Lista de objetos ApplicationRelation

size

int

Tamaño de la lista applicationRelations devuelta

Códigos error

 

Código

Descripción

Código

Descripción

APPLICATIONRELATIONLIST_00

Error durante el proceso de búsqueda de relaciones entre aplicaciones

APPLICATIONRELATIONLIST_01

El objeto ParamApplicationRelationList es nulo

APPLICATIONRELATIONLIST_02

No se han encontrado relaciones entre aplicaciones para estos parámetros de búsqueda

APPLICATIONRELATIONLIST_03

Ha ocurrido algún error al realizar la búsqueda.

Ejemplo de invocación

Ejemplo de invocación
ParamApplicationRelationList params = new ParamApplicationRelationList(); ApplicationRelationSearch appSearch = new ApplicationRelationSearch(); appSearch.setApplicationAliasA("SVCD"); params.setApplicationRelationSearch(appSearch); ResultApplicationRelationList result = pauAgent.applicationRelationList(params);

Método 'authorizeApplication'

Servicio que comprueba si una aplicación tiene autorización sobre otra para acceder a un determinado método. Se comprueba también si la ip desde la que accede es una de las permitidas para dicha aplicación.

La relación entre la aplicación invocante y los servicios de la aplicación invocada debe estar dada de alta en PAU. La Ip tambien debe estar dada de alta en PAU.

Signatura

ResultAuthorizeApplication authorizeApplication(ParamAuthorizeApplication paramAuthorizeApplication)

Parámetros de invocación

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

applicationId

String

Aplicación que ejecuta el método

fiscalAnagram

String

Anagrama fiscal

applicationAliasA

String

Alias aplicación A

applicationAliasB

String

Alias aplicación B

methodCode

String

Código del método

ip

String

Dirección Ip

Parámetros de respuesta

 

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

resultError

ResultError

Objeto ResultError

Códigos error

 

Código

Descripción

Código

Descripción

AUTHORIZEAPPLICATION_00

Error durante el proceso de autorización.

AUTHORIZEAPPLICATION_01

El parámetro alias de la aplicación la aplicación A es nulo.

AUTHORIZEAPPLICATION_02

El parámetro alias de la aplicación B es nulo.

AUTHORIZEAPPLICATION_03

El parámetro methodCode es nulo.

AUTHORIZEAPPLICATION_04

El parámetro Ip es nulo.

AUTHORIZEAPPLICATION_05

No existe una relación entre aplicaciones.

AUTHORIZEAPPLICATION_06

La ip xxx no está en la lista de ip's permitidas.

Ejemplo de invocación

Ejemplo de invocación
ParamAuthorizeApplication paramAuthorizeApplication = new ParamAuthorizeApplication(); paramAuthorizeApplication.setApplicationAliasA("App A"); paramAuthorizeApplication.setApplicationAliasB("App B"); // ha de ser ip desde la que accede appA paramAuthorizeApplication.setIp("127.0.0.3"); paramAuthorizeApplication.setMethodCode("MET00296"); ResultAuthorizeApplication result = pauAgent.authorizeApplication(paramAuthorizeApplication);

Método 'methodApplicationList'

Servicio que devuelve dentro del objeto ResultMethodApplicationList un vector de IPs y un vector de Métodos asociados con la aplicación que se pasa como parámetro en el objeto ParamMethodApplicationList

La lista de métodos y de Ips relacionadas con una aplicación, deben estar dadas de alta en PAU.

Signatura

ResultMethodApplicationList methodApplicationList (ParamMethodApplicationList paramMethodApplicationList)

Parámetros de invocación

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

applicationId

String

Aplicación que ejecuta el método

fiscalAnagram

String

Anagrama fiscal

applicationAlias

String

Alias de la aplicación

Parámetros de respuesta

 

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

resultError

ResultError

Objeto ResultError

methods

Method[]

Lista de objetos Method, métodos de la aplicación

ips

Ip[]

Lista de objetos Ip, Ips de la aplicación

Códigos error

 

Código

Descripción

Código

Descripción

METHODAPPLICATIONLIST_00

Error durante el proceso de búsqueda

METHODAPPLICATIONLIST_01

El objeto ParamMethodApplicationList es nulo

METHODAPPLICATIONLIST_02

No hay Ips ni métodos asociados a la aplicación

METHODAPPLICATIONLIST_03

Ha ocurrido algún error al realizar la búsqueda

METHODAPPLICATIONLIST_04

El Alias de la Aplicación es nulo

Ejemplo de invocación

Ejemplo de invocación
ParamMethodApplicationList params = new ParamMethodApplicationList(); params.setApplicationAlias("SIU"); ResultMethodApplicationList result = pauAgent.methodList(params);

Búsquedas y consultas de acciones

Método 'actionList'

Servicio que devuelve una lista de acciones en función de la información pasada como parámetro en el objeto ParamActionList

Estas acciones deben estar dadas de alta en PAU. Se puede buscar la acción mediante su código, el alias de la aplicación, el nombre de la aplicación.

Signatura

ResultActionList actionList(ParamActionList paramActionList)

Parámetros de invocación

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

applicationId

String

Aplicación que ejecuta el método

fiscalAnagram

String

Anagrama fiscal

actionSearch

ActionSearch

Objeto ActionSearch

Parámetros de respuesta

 

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

resultError

ResultError

Objeto ResultError

actions

Action[]

Lista de objetos Action

size

int

Tamaño de la lista actions devuelta

Códigos error

 

Código

Descripción

Código

Descripción

ACTIONLIST_00

Ha ocurrido algún error al realizar la búsqueda

ACTIONLIST_01

El objeto paramActionList es nulo

ACTIONLIST_02

No se han encontrado acciones con los parámetros de búsqueda indicados

Ejemplo de invocación

Ejemplo de invocación
ParamActionList params = new ParamActionList(); ActionSearch search = new ActionSearch(); search.setAlias("INSERTAR_SELLOS"); params.setActionSearch(search); ResultActionList result = pauAgent.actionList(params);

Búsquedas y consultas de usuarios

 

Método 'admRoleList'

Servicio que devuelve el listado de perfiles administrativos con el que se puede crear una asignación de un grupo de gestión a un usuario, dados de alta en PAU.
Al dar de alta a un usuario, se le asignan grupos de gestión, para lo que es necesario conocer los perfiles administrativos disponibles.

 

Signatura

ResultAdmRoleList admRoleList(ParamAdmRoleList paramAdmRoleList)

Parámetros de invocación

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

applicationId

String

Aplicación que ejecuta el método

fiscalAnagram

String

Anagrama fiscal

admRoleSearch

AdmRoleSearch

Objeto AdmRoleSearch con campos de búsqueda

Parámetros de respuesta

 

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

resultError

ResultError

Objeto ResultError

admRole

AdmRole[]

Lista de objetos AdmRole, con los datos de los roles

size

int

Tamaño de la lista admRole devuelta

Códigos error

 

Código

Descripción

Código

Descripción

ADMROLELIST_00

Error durante el proceso de búsqueda

ADMROLELIST_01

El objeto ParamAdmRoleList es nulo

ADMROLELIST_02

No existe ningún administrador de rol para esos parámetros de búsqueda

ADMROLELIST_03

Ha ocurrido algún tipo de error al buscar el rol en la base de datos

Ejemplo de invocación

Ejemplo de invocación
ParamAdmRoleList params = new ParamAdmRoleList; AdmRoleSearch admRoleSearch = new AdmRoleList(); admRoleSearch.setname("nombre del perfil"); params.setAdmRoleSearch(admRoleSearch); ResultAdmRoleList result = pauAgent.admRoleList(params);

Método 'assignedRoleList'

Servicio que devuelve una lista de roles asignados a un usuario en función de la información pasada como parámetro en el objeto ParamAssignedRoleList.

Se puede buscar los roles asignados buscando por el fiscal anagram del usuario, el código de organismo, el alias de la aplicación o un código de rol específico.

Signatura

ResultAssignedRoleList assignedRoleList(ParamAssignedRoleList paramAssignedRoleList)

Parámetros de invocación

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

applicationId

String

Aplicación que ejecuta el método

fiscalAnagram

String

Anagrama fiscal

assignedRoleSearch

AssignedRoleSearch

Objeto AssignedRoleSearch con campos de búsqueda

Parámetros de respuesta

 

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

resultError