Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

En este apartado se explicarán los servicios de PAU, cómo invocar, 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

Table of Contents
maxLevel3


Servicios IInfoServicePortType

...

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.

...

Método 'userByOrganismTree'

Servicio que devuelve los usuarios que pertenezcan a una rama de organismos, dados de alta con un rol determinado dentro de una aplicación. Estos usuarios con sus roles estarán dados de alta en PAU.



Expand
titleMás detalles

Signatura

ResultUserByOrganismTree userByOrganismTree(ParamUserByOrganismTree paramUserByOrganismTree)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
organismsCodeTreeString[]Lista de códigos de organismos a los que puede pertenecer el usuario
roleNameStringNombre del rol
applicationAliasStringAlias de la aplicación


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
user1242693904[]Lista de objetos User.


Códigos error



Código
Descripción
USERSORGANISMTREE_01El objeto paramUserByOrganismTree es nulo.
USERSORGANISMTREE_00Error durante el proceso de búsqueda
USERSORGANISMTREE_02La lista de organismos está vacía o es nula.
USERSORGANISMTREE_03No se ha encontrado ningún rol para esos parámetros de búsqueda.
USERSORGANISMTREE_04El alias de la aplicación es nulo
USERSORGANISMTREE_05El rol no existe en el sistema
USERSORGANISMTREE_06El nombre del rol es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
String[] organismsCodeTree = new String[2];
organismsCodeTree[0] = "ORG00007";
organismsCodeTree[1] = "ORG00012";
String roleName = "PREPARADOR-COMPULSOR";
String applicationAlias = "SCE";
ParamUserByOrganismTree param = new ParamUserByOrganismTree();
param.setOrganismsCodeTree(organismsCodeTree);
param.setApplicationAlias(applicationAlias);
param.setRoleName(roleName);
ResultUserByOrganismTree result = pauAgent.userByOrganismTree(param);


...

Método 'userByOrganismTreeExtended' @deprecated


Servicio que devuelve los usuarios que pertenezcan a a algún organismo de los indicados con alguno de los roles indicados. Estos usuarios con sus roles estarán dados de alta en PAU.


Expand
titleMás detalles

Signatura

ResultUserByOrganismTreeExtended userByOrganismTreeExtended( ParamUserByOrganismTreeExtended  paramUserByOrganismTree)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
organismsCodeTreeString[]Lista de códigos de organismos a los que puede pertenecer el usuario
roleNameString[]Nombre de roles por los que se filtrará
applicationAliasStringAlias de la aplicación


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
user1242693904[]Lista de objetos User


Códigos error


Código
Descripción
USERSORGANISMTREE_00 Error durante el proceso de búsqueda.
USERSORGANISMTREE_01 El objeto paramUserByOrganismTree es nulo.
USERSORGANISMTREE_02 No se han encontrado usuarios para este
organismo y rol.
USERSORGANISMTREE_03 El parámetro nombre de rol es nulo
USERSORGANISMTREE_04 El parámetro alias de la aplicación es nulo
USERSORGANISMTREE_05 El rol no existe en el sistema
USERSORGANISMTREE_06 No se han encontrado usuarios para esos
parámetros de búsqueda


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
String[] organismsCodeTree = new String[2];
organismsCodeTree[0] = "ORG00007";
organismsCodeTree[1] = "ORG00012";
String[] rolenName = new String[2];
rolesName[0] = "EDITOR";
rolesName[1] = "ISSUER";
ParamUserByOrganismTree param = new ParamUserByOrganismTree();
param.setOrganismsCodeTree(organismsCodeTree);
param.setApplicationAlias(“SNT”);
param.setRoleName(roleName);
ResultUserByOrganismTree result = pauAgent.userByOrganismTree(param);


...

Expand
titleMás detalles

Signatura

ResultProcedureList procedurePublishedList(ParamProcedureList paramProcedureList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureSearch1242693904Objeto ProcedureSearch, campos de búsqueda para procedimientos


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
procedure1242693904[]Lista de objetos Procedure


Códigos error



Código
Descripción
PROCEDURELIST_00Error durante el proceso de búsqueda de procedure
PROCEDURELIST_01El objeto paramProcedureList es nulo
PROCEDURELIST_02Error que proviene del webservices
PROCEDURELIST_03El objeto ProcedureSearch es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureList params = new ParamProcedureList();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignature("1");
params.setProcedureSearch(procedureSearch);
ResultProcedureList result = pauAgent.procedurePublishedList(params);



Método 'getJobsBySignature'

Servicio que devuelve los puestos que tienen asociada una signature.


Expand
titleMás detalles

Signatura

ResultGetJobsBySignature getJobsBySignature(ParamGetJobsBySignature paramGetJobsBySignature)

Parámetros de invocación


Nombre
Tipo
Descripción
applicationIdStringAplicación que ejecuta el método.
fiscalAnagramStringFiscal anagram del usuario que invoca
signatureStringSignatura por la que se quiere buscar.
stateStringEstado de alta o baja.


Parámetros de respuesta



Nombre
Tipo
Descripción
jobCodesList <String>Lista de jobCodes
sizeintTamaño del listado devuelto


Códigos error


Código
Descripción
GET_JOBS_BY_SIGNATURE_01El objeto paramGetJobsBySignature es nulo
GET_JOBS_BY_SIGNATURE_02Los parametros signature y state son obligatorios
GET_JOBS_BY_SIGNATURE_03El campo state introducido no es valido. Debe ser alta o baja
GET_JOBS_BY_SIGNATURE_04El campo signature debe ser numerico
GET_JOBS_BY_SIGNATURE_05No se encuentran puestos asociados


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGetJobsBySignature params = new ParamGetJobsBySignature();
params.setFiscalAnagram(TestConstants.DEFAULT_FISCAL_ANAGRAM);
params.setApplicationId(TestConstants.DEFAULT_ENTITY_ID);
params.setSignature("466");
params.setState("alta");
ResultGetJobsBySignature result = testClient.getJobsBySignature(params);






Método 'procedureGetAssignedJobList'

Servicio que devuelve los puestos asociados a un procedimiento.

Expand
titleMás detalles

Signatura

ResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que invoca al servicio
fiscalAnagramStringFiscal anagram del usuario
signaturesLong[]Array de signaturas por las que se quiere buscar.
stateBoolean TRUE para los que están dados de alta y FALSE, para bajas.


Parámetros de respuesta



NombreTipoDescripción
procedureJobsList<ProcedureJobList>Lista de objetos PAU v3.8 - Manual de integración - servicios para integradores#ProcedureJobList
sizeint tamaño del listado devuelto


Códigos error



Código
Descripción
PROCEDUREGETASSIGNEDJOBLIST_00El objeto ParamProcedureGetAssignedJobList es nulo.
PROCEDUREGETASSIGNEDJOBLIST_01El objeto signatures es nulo
PROCEDUREGETASSIGNEDJOBLIST_02No hay procedimientos relacionados con estos parámetros de búsqueda
PROCEDUREGETASSIGNEDJOBLIST_03Ha ocurrido algún tipo de error al listar los procedimientos


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureGetAssignedJobList param = new ParamProcedureGetAssignedJobList();
Long[] signatures = new Long[1];
signatures[0] = Long.parseLong(signature);
param.setSignatures(signatures);
param.setState(true);
ResultProceduresGetAssignedJobList resultProcedureJobList = pauAgent.procedureGetAssignedJobList(param);


...

Servicio que devuelve los roles asociados a uno o varios puestos de SIU.


Expand
titleMás detalles

Signatura

ResultJobGetAssignedRoleList jobGetAssignedRoleList(ParamJobGetAssignedRoleList param)

Parámetros de invocación


NombreTipoDescripción
jobCodeString[]Array de códigos de puestos de SIU por los que se quiere buscar.


Parámetros de respuesta



NombreTipoDescripción
RoleJobsList<RoleJob>Lista de RoleJob
sizeint tamaño del listado devuelto
jobCodeStringcódigo del puesto en SIU


Códigos error



Código
Descripción
JOB_GET_ASSIGNED_ROLE_LIST_00Ha ocurrido algún tipo de error al listar los resultados
JOB_GET_ASSIGNED_ROLE_LIST_01El objeto de entrada es nulo.
JOB_GET_ASSIGNED_ROLE_LIST_02La lista de códigos de puestos en SIU es nula.
JOB_GET_ASSIGNED_ROLE_LIST_03La lista de códigos de puestos en SIU está vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamJobGetAssignedRoleList param = new ParamJobGetAssignedRoleList();
param.setJobCode(new String[] { "JOB_0001", "JOB_0002" });
ResultJobGetAssignedRoleList result = testClient.jobGetAssignedRoleList(param);


...

Servicio que consultan los procedimientos asociados a los usuarios en PAU con la nueva estructura derivada del cambio de servicio/variante.

*El parentSignature del servicio se mantendrá vacío, este campo se rellenará con la signature original del mismo en los casos especiales de servicio-variante “Estandar”. Esto sucede en el caso de existir variantes sin denominación, se devolverá como denominación de cada variante la de su servicio correspondiente; y la signature del servicio pasa a ser la de esta variante “Estandar”. De este modo es más fácil indentificar en la respuesta cuando se trata esta casuística.


Expand
titleMás detalles

Signatura

ResultGetAssignedProcedureListServicesAndVariants jobGetAssignedProcedureListServicesAndVariants(ParamJobGetAssignedProcedureListServicesAndVariants param)

Parámetros de invocación


NombreTipoDescripción
jobCodeString[]Array de codigos de puestos de SIU por los que se quiere buscar.
signatureLongParámetro opcional que nos permite filtrar por el signature
serviceStringS, V o A, para filtrar por servicios o variantes (o ambas). Si no se rellena devolverá ambos, como si se hubiera rellenado A.
stateStringA o T, para filtrar por publicados o todos.
activeStringS, N o T, para filtrar si están de alta, de baja o todos.


Parámetros de respuesta



NombreTipoDescripción
resultSEDAServicesList<PAU v3.10 - Manual de integración - servicios para integradores#ResultSEDAService>Lista de ResultSEDAService
sizeint tamaño del listado devuelto



Códigos error



Código
Descripción
JOB_GET_ASSIGNED_PROCEDURE_LIST_00Ha ocurrido algún tipo de error al listar los resultados
JOB_GET_ASSIGNED_PROCEDURE_LIST_01El objeto de entrada es nulo.
JOB_GET_ASSIGNED_PROCEDURE_LIST_02La lista de códigos de puestos en SIU es nula.
JOB_GET_ASSIGNED_PROCEDURE_LIST_03La lista de códigos de puestos en SIU está vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamJobGetAssignedProcedureList param = new ParamJobGetAssignedProcedureList();
param.setJobCode(new String[] { "JOB_0001", "JOB_0002" });
ResultJobGetAssignedRoleList result = testClient.jobGetAssignedRoleList(param);


...

Servicio que consultan los procedimientos asociados a los usuarios en PAU con la nueva estructura derivada del cambio de servicio/variante.

*El parentSignature del servicio se mantendrá vacío, este campo se rellenará con la signature original del mismo en los casos especiales de servicio-variante “Estandar”. Esto sucede en el caso de existir variantes sin denominación, se devolverá como denominación de cada variante la de su servicio correspondiente; y la signature del servicio pasa a ser la de esta variante “Estandar”. De este modo es más fácil indentificar en la respuesta cuando se trata esta casuística.


Expand
titleMás detalles

Signatura

ResultGetListServicesAndVariants procedureListServicesAndVariants(ParamGetListServicesAndVariants param)

Parámetros de invocación


NombreTipoDescripción
signatureLongParámetro opcional que nos permite filtrar por el signature
serviceStringS, V o A, para filtrar por servicios o variantes (o ambas). Si no se rellena devolverá ambos, como si se hubiera rellenado A.
stateStringA o T, para filtrar por publicados o todos.


Parámetros de respuesta



NombreTipoDescripción
resultSEDAServicesList<PAU v3.10 - Manual de integración - servicios para integradores#ResultSEDAServiceSimple>Lista de ResultSEDAServiceSimple
sizeint tamaño del listado devuelto



Códigos error



Código
Descripción
JOB_GET_ASSIGNED_PROCEDURE_LIST_00Ha ocurrido algún tipo de error al listar los resultados
JOB_GET_ASSIGNED_PROCEDURE_LIST_01El objeto de entrada es nulo.
JOB_GET_ASSIGNED_PROCEDURE_LIST_02La lista de códigos de puestos en SIU es nula.
JOB_GET_ASSIGNED_PROCEDURE_LIST_03La lista de códigos de puestos en SIU está vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGetListServicesAndVariants param = new ParamGetListServicesAndVariants();
param.setService(ServiceEnum.ALL.getValue());
param.setSignature(null);//opcional
param.setState(StatusEnum.ALL.getValue());
ResultGetListServicesAndVariants result = testClient.procedureListServicesAndVariants(param);


...

Servicio que devuelve los procedimientos asociados a uno o varios puestos de SIU.


Expand
titleMás detalles

Signatura

ResultJobGetAssignedRoleList jobGetAssignedRoleList(ParamJobGetAssignedRoleList param)

Parámetros de invocación


NombreTipoDescripción
jobCodeString[]Array de codigos de puestos de SIU por los que se quiere buscar.


Parámetros de respuesta



NombreTipoDescripción
ProcedureJobsList<ProcedureJob>Lista de ProcedureJob
sizeint tamaño del listado devuelto
jobCodeStringcódigo del puesto en SIU


Códigos error



Código
Descripción
JOB_GET_ASSIGNED_PROCEDURE_LIST_00Ha ocurrido algún tipo de error al listar los resultados
JOB_GET_ASSIGNED_PROCEDURE_LIST_01El objeto de entrada es nulo.
JOB_GET_ASSIGNED_PROCEDURE_LIST_02La lista de códigos de puestos en SIU es nula.
JOB_GET_ASSIGNED_PROCEDURE_LIST_03La lista de códigos de puestos en SIU está vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamJobGetAssignedProcedureList param = new ParamJobGetAssignedProcedureList();
param.setJobCode(new String[] { "JOB_0001", "JOB_0002" });
ResultJobGetAssignedRoleList result = testClient.jobGetAssignedRoleList(param);


...

Servicio que devuelve los puestos asociados a uno o varios roles de SIU.


Expand
titleMás detalles

Signatura

ResultRoleGetAssignedJobList roleGetAssignedJobList(ParamRoleGetAssignedJobList paramRoleGetAssignedJobList)

Parámetros de invocación


NombreTipoDescripción
roleCodeString[]Array de codigos de roles de SIU por los que se quiere buscar.
stateStringEstado de alta o baja


Parámetros de respuesta



NombreTipoDescripción
RoleJobListList<RoleJob>Lista de RoleJob
sizeint tamaño del listado devuelto


Códigos error



Código
Descripción
ROLE_GET_ASSIGNED_JOB_LIST_01El objeto paramRoleGetAssignedJobList es nulo
ROLE_GET_ASSIGNED_JOB_LIST_02El objeto paramRoleGetAssignedJobList es nulo
ROLE_GET_ASSIGNED_JOB_LIST_03El tamaño de paramRoleGetAssignedJobList.getRoleCode() es 0


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamRoleGetAssignedJobList param = new ParamRoleGetAssignedJobList();
param.setRoleCode(new String[] { "ROLE0001", "ROLE0002" });
ResultRoleGetAssignedJobList result = testClient.roleGetAssignedJobList(param);


...

Servicio que devuelve los puestos asociados a uno o varios ptocedimientos.


Expand
titleMás detalles

Signatura

ResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureGetAssignedJobList)

Parámetros de invocación


NombreTipoDescripción
signatureString[]Array de signaturas por los que se quiere buscar.
stateStringEstado de alta o baja


Parámetros de respuesta



NombreTipoDescripción
procedureJobsList<ProcedureJobList>Lista de PRocedureJob
sizeint Tamaño del listado devuelto


Códigos error



Código
Descripción
PROCEDURELISTBYORGANISMROLE_00Error que proviene del webservices
PROCEDURELISTBYORGANISMROLE_01El objeto ParamProcedureGetAssignedJobList es nulo
PROCEDURELISTBYORGANISMROLE_02No existen procedimientos para los parametros de busqueda
PROCEDURELISTBYORGANISMROLE_03Error inesperado


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureGetAssignedJobList param = new ParamProcedureGetAssignedJobList();
param.setSignature(new String[] { "595", "1011" });
ResultProceduresGetAssignedJobList result = testClient.procedureGetAssignedJobList(param);


...

*El parentSignature del servicio se mantendrá vacío, este campo se rellenará con la signature original del mismo en los casos especiales de servicio-variante “Estandar”. Esto sucede en el caso de existir variantes sin denominación, se devolverá como denominación de cada variante la de su servicio correspondiente; y la signature del servicio pasa a ser la de esta variante “Estandar”. De este modo es más fácil indentificar en la respuesta cuando se trata de esta casuística.


Expand
titleMás detalles

Signatura

ResultProcedureListByUserWithServices procedureListByUserWithServices (ParamProcedureListByUserWithServices paramProcedureListByUserWithServices)

Parámetros de invocación


Nombre
Tipo
Descripción
applicationIdStringAplicación que invoca al servicio
fiscalAnagramStringFiscal anagram del usuario
signatureStringParámetro opcional que nos permite filtrar por el signature
serviceStringS, V o A, para filtrar por servicios o variantes (o ambas). Si no se rellena devolverá ambos, como si se hubiera rellenado A.
stateStringA o T, para filtrar por publicados o todos.
activeStringS para los que están dados de alta, N para bajas y T, indistinto


Parámetros de respuesta


Nombre
Tipo
Descripción
resultSEDAByUserWithServicesList<ResultSEDAByUserWithServices>Lista de ResultSEDAByUserWithServices
sizeintTamaño del listado devuelto


Códigos error


Código
Descripción
PROCEDURELISTBYUSER_00Error durante el proceso de búsqueda de
procedure by user.
PROCEDURELISTBYUSER_01El objeto paramProcedureListByUser es nulo
PROCEDURELISTBYUSER_02El fiscal anagrama es nulo
PROCEDURELISTBYUSER_04Error que proviene del Webservice
PROCEDURELISTBYUSER_07El tipo de consulta introducida no es válida


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListByUserWithServices param = new ParamProcedureListByUserWithServices();
param.setFiscalAnagram("99999999R");//Obligatorio
param.setService(ServiceEnum.ALL.getValue());//A
param.setSignature(null);//opcional
param.setState(StatusEnum.ALL.getValue());//T
//Si no le pasamos active como parametro, por defecto T
//param.setActive(StatusProcEnum.ALL.getValue());
ResultProcedureListByUserWithServices result = testClient.procedureListByUserWithServices(param);


...

Nombre
Tipo
Descripción
gestionGroup

1242693904

Objeto GestionGroup
params1242693904Objeto SearchParams

...

Objeto 'RoleJob
Anchor
RoleJob
RoleJob


NombreTipoDescripción
codeLongCódigo del registro - clave primaria
roleCodeStringCódigo del rol
jobCodeStringCódigo del puesto en SIU

initialDate

DateFecha de inicio
finalDateDateFecha de Fin


Objeto 'SearchParams
Anchor
SearchParams
SearchParams

...

Nombre
Tipo
Descripción
sortColumnStringColumna por la que queremos ordenar
ascendingBooleanIndica si el orden de ordenación es ascendente
fromIndexIntegerÍndice desde el que queremos buscar
toIndexIntegerÍndice hasta que el que queremos buscar


Objeto 'User
Anchor
User
User

...

Nombre
TipoDescripción
fiscalAnagramStringAnagrama fiscal del usuario
roleOrganism1242693904[]Lista de objetos RoleOrganism

...

Nombre
Tipo
Descripción
fiscalAnagramStringAnagrama fiscal del usuario
ggCodeStringCódigo del grupo de gestión
admRoleCodeStringCódigo del rol
ggNameStringNombre del grupo de gestión
admRoleNameStringNombre del rol

...

Nombre
Tipo
Descripción
userGG1242693904Objeto UserGG
searchParams1242693904Objeto SearchParams


Objeto 'UserList
Anchor
UserList
UserList

...