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
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 |
---|
|
SignaturaResultUserByOrganismTree userByOrganismTree(ParamUserByOrganismTree paramUserByOrganismTree) Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismsCodeTree | String[] | Lista de códigos de organismos a los que puede pertenecer el usuario | roleName | String | Nombre del rol | applicationAlias | String | Alias de la aplicación |
Parámetros de respuesta
Códigos error
USERSORGANISMTREE_01 | El objeto paramUserByOrganismTree es nulo. | USERSORGANISMTREE_00 | Error durante el proceso de búsqueda | USERSORGANISMTREE_02 | La lista de organismos está vacía o es nula. | USERSORGANISMTREE_03 | No se ha encontrado ningún rol para esos parámetros de búsqueda. | USERSORGANISMTREE_04 | El alias de la aplicación es nulo | USERSORGANISMTREE_05 | El rol no existe en el sistema | USERSORGANISMTREE_06 | El nombre del rol es nulo |
Ejemplo de invocación Code Block |
---|
language | java |
---|
title | Ejemplo 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 |
---|
|
SignaturaResultUserByOrganismTreeExtended userByOrganismTreeExtended( ParamUserByOrganismTreeExtended paramUserByOrganismTree)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismsCodeTree | String[] | Lista de códigos de organismos a los que puede pertenecer el usuario | roleName | String[] | Nombre de roles por los que se filtrará | applicationAlias | String | Alias de la aplicación |
Parámetros de respuestaCódigos error
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 |
---|
language | java |
---|
title | Ejemplo 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 |
---|
|
SignaturaResultProcedureList procedurePublishedList(ParamProcedureList paramProcedureList) Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | procedureSearch | 1242693904 | Objeto ProcedureSearch, campos de búsqueda para procedimientos |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | 1242693904 | Objeto ResultError | procedure | 1242693904[] | Lista de objetos Procedure |
Códigos error
PROCEDURELIST_00 | Error durante el proceso de búsqueda de procedure | PROCEDURELIST_01 | El objeto paramProcedureList es nulo | PROCEDURELIST_02 | Error que proviene del webservices | PROCEDURELIST_03 | El objeto ProcedureSearch es nulo |
Ejemplo de invocación Code Block |
---|
language | java |
---|
title | Ejemplo 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 |
---|
|
SignaturaResultGetJobsBySignature getJobsBySignature(ParamGetJobsBySignature paramGetJobsBySignature) Parámetros de invocación
applicationId | String | Aplicación que ejecuta el método. | fiscalAnagram | String | Fiscal anagram del usuario que invoca | signature | String | Signatura por la que se quiere buscar. | state | String | Estado de alta o baja. |
Parámetros de respuesta
jobCodes | List <String> | Lista de jobCodes | size | int | Tamaño del listado devuelto |
Códigos error
GET_JOBS_BY_SIGNATURE_01 | El objeto paramGetJobsBySignature es nulo | GET_JOBS_BY_SIGNATURE_02 | Los parametros signature y state son obligatorios | GET_JOBS_BY_SIGNATURE_03 | El campo state introducido no es valido. Debe ser alta o baja | GET_JOBS_BY_SIGNATURE_04 | El campo signature debe ser numerico | GET_JOBS_BY_SIGNATURE_05 | No se encuentran puestos asociados |
Ejemplo de invocación Code Block |
---|
language | java |
---|
title | Ejemplo 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 |
---|
|
SignaturaResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureList) Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que invoca al servicio | fiscalAnagram | String | Fiscal anagram del usuario | signatures | Long[] | Array de signaturas por las que se quiere buscar. | state | Boolean | TRUE para los que están dados de alta y FALSE, para bajas. |
Parámetros de respuesta
Códigos error
PROCEDUREGETASSIGNEDJOBLIST_00 | El objeto ParamProcedureGetAssignedJobList es nulo. | PROCEDUREGETASSIGNEDJOBLIST_01 | El objeto signatures es nulo | PROCEDUREGETASSIGNEDJOBLIST_02 | No hay procedimientos relacionados con estos parámetros de búsqueda | PROCEDUREGETASSIGNEDJOBLIST_03 | Ha ocurrido algún tipo de error al listar los procedimientos |
Ejemplo de invocación Code Block |
---|
language | java |
---|
title | Ejemplo 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 |
---|
|
SignaturaResultJobGetAssignedRoleList jobGetAssignedRoleList(ParamJobGetAssignedRoleList param) Parámetros de invocación
Nombre | Tipo | Descripción |
---|
jobCode | String[] | Array de códigos de puestos de SIU por los que se quiere buscar. |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
RoleJobs | List<RoleJob> | Lista de RoleJob | size | int | tamaño del listado devuelto | jobCode | String | código del puesto en SIU |
Códigos error
JOB_GET_ASSIGNED_ROLE_LIST_00 | Ha ocurrido algún tipo de error al listar los resultados | JOB_GET_ASSIGNED_ROLE_LIST_01 | El objeto de entrada es nulo. | JOB_GET_ASSIGNED_ROLE_LIST_02 | La lista de códigos de puestos en SIU es nula. | JOB_GET_ASSIGNED_ROLE_LIST_03 | La lista de códigos de puestos en SIU está vacía. |
Ejemplo de invocación Code Block |
---|
language | java |
---|
title | Ejemplo 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 |
---|
|
SignaturaResultGetAssignedProcedureListServicesAndVariants jobGetAssignedProcedureListServicesAndVariants(ParamJobGetAssignedProcedureListServicesAndVariants param) Parámetros de invocación
Nombre | Tipo | Descripción |
---|
jobCode | String[] | Array de codigos de puestos de SIU por los que se quiere buscar. | signature | Long | Parámetro opcional que nos permite filtrar por el signature | service | String | S, V o A, para filtrar por servicios o variantes (o ambas). Si no se rellena devolverá ambos, como si se hubiera rellenado A. | state | String | A o T, para filtrar por publicados o todos. | active | String | S, N o T, para filtrar si están de alta, de baja o todos. |
Parámetros de respuesta
Códigos error
JOB_GET_ASSIGNED_PROCEDURE_LIST_00 | Ha ocurrido algún tipo de error al listar los resultados | JOB_GET_ASSIGNED_PROCEDURE_LIST_01 | El objeto de entrada es nulo. | JOB_GET_ASSIGNED_PROCEDURE_LIST_02 | La lista de códigos de puestos en SIU es nula. | JOB_GET_ASSIGNED_PROCEDURE_LIST_03 | La lista de códigos de puestos en SIU está vacía. |
Ejemplo de invocación Code Block |
---|
language | java |
---|
title | Ejemplo 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 |
---|
|
SignaturaResultGetListServicesAndVariants procedureListServicesAndVariants(ParamGetListServicesAndVariants param) Parámetros de invocación
Nombre | Tipo | Descripción |
---|
signature | Long | Parámetro opcional que nos permite filtrar por el signature | service | String | S, V o A, para filtrar por servicios o variantes (o ambas). Si no se rellena devolverá ambos, como si se hubiera rellenado A. | state | String | A o T, para filtrar por publicados o todos. |
Parámetros de respuesta
Códigos error
JOB_GET_ASSIGNED_PROCEDURE_LIST_00 | Ha ocurrido algún tipo de error al listar los resultados | JOB_GET_ASSIGNED_PROCEDURE_LIST_01 | El objeto de entrada es nulo. | JOB_GET_ASSIGNED_PROCEDURE_LIST_02 | La lista de códigos de puestos en SIU es nula. | JOB_GET_ASSIGNED_PROCEDURE_LIST_03 | La lista de códigos de puestos en SIU está vacía. |
Ejemplo de invocación Code Block |
---|
language | java |
---|
title | Ejemplo 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 |
---|
|
SignaturaResultJobGetAssignedRoleList jobGetAssignedRoleList(ParamJobGetAssignedRoleList param) Parámetros de invocación
Nombre | Tipo | Descripción |
---|
jobCode | String[] | Array de codigos de puestos de SIU por los que se quiere buscar. |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
ProcedureJobs | List<ProcedureJob> | Lista de ProcedureJob | size | int | tamaño del listado devuelto | jobCode | String | código del puesto en SIU |
Códigos error
JOB_GET_ASSIGNED_PROCEDURE_LIST_00 | Ha ocurrido algún tipo de error al listar los resultados | JOB_GET_ASSIGNED_PROCEDURE_LIST_01 | El objeto de entrada es nulo. | JOB_GET_ASSIGNED_PROCEDURE_LIST_02 | La lista de códigos de puestos en SIU es nula. | JOB_GET_ASSIGNED_PROCEDURE_LIST_03 | La lista de códigos de puestos en SIU está vacía. |
Ejemplo de invocación Code Block |
---|
language | java |
---|
title | Ejemplo 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 |
---|
|
SignaturaResultRoleGetAssignedJobList roleGetAssignedJobList(ParamRoleGetAssignedJobList paramRoleGetAssignedJobList) Parámetros de invocación
Nombre | Tipo | Descripción |
---|
roleCode | String[] | Array de codigos de roles de SIU por los que se quiere buscar. | state | String | Estado de alta o baja |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
RoleJobList | List<RoleJob> | Lista de RoleJob | size | int | tamaño del listado devuelto |
Códigos error
ROLE_GET_ASSIGNED_JOB_LIST_01 | El objeto paramRoleGetAssignedJobList es nulo | ROLE_GET_ASSIGNED_JOB_LIST_02 | El objeto paramRoleGetAssignedJobList es nulo | ROLE_GET_ASSIGNED_JOB_LIST_03 | El tamaño de paramRoleGetAssignedJobList.getRoleCode() es 0 |
Ejemplo de invocación Code Block |
---|
language | java |
---|
title | Ejemplo 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 |
---|
|
SignaturaResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureGetAssignedJobList) Parámetros de invocación
Nombre | Tipo | Descripción |
---|
signature | String[] | Array de signaturas por los que se quiere buscar. | state | String | Estado de alta o baja |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
procedureJobs | List<ProcedureJobList> | Lista de PRocedureJob | size | int | Tamaño del listado devuelto |
Códigos error
PROCEDURELISTBYORGANISMROLE_00 | Error que proviene del webservices | PROCEDURELISTBYORGANISMROLE_01 | El objeto ParamProcedureGetAssignedJobList es nulo | PROCEDURELISTBYORGANISMROLE_02 | No existen procedimientos para los parametros de busqueda | PROCEDURELISTBYORGANISMROLE_03 | Error inesperado |
Ejemplo de invocación Code Block |
---|
language | java |
---|
title | Ejemplo 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 |
---|
|
SignaturaResultProcedureListByUserWithServices procedureListByUserWithServices (ParamProcedureListByUserWithServices paramProcedureListByUserWithServices) Parámetros de invocación
applicationId | String | Aplicación que invoca al servicio | fiscalAnagram | String | Fiscal anagram del usuario | signature | String | Parámetro opcional que nos permite filtrar por el signature | service | String | S, V o A, para filtrar por servicios o variantes (o ambas). Si no se rellena devolverá ambos, como si se hubiera rellenado A. | state | String | A o T, para filtrar por publicados o todos. | active | String | S para los que están dados de alta, N para bajas y T, indistinto |
Parámetros de respuesta
resultSEDAByUserWithServices | List<ResultSEDAByUserWithServices> | Lista de ResultSEDAByUserWithServices | size | int | Tamaño del listado devuelto |
Códigos error
PROCEDURELISTBYUSER_00 | Error durante el proceso de búsqueda de procedure by user. | PROCEDURELISTBYUSER_01 | El objeto paramProcedureListByUser es nulo | PROCEDURELISTBYUSER_02 | El fiscal anagrama es nulo | PROCEDURELISTBYUSER_04 | Error que proviene del Webservice | PROCEDURELISTBYUSER_07 | El tipo de consulta introducida no es válida |
Ejemplo de invocación Code Block |
---|
language | java |
---|
title | Ejemplo 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); |
|
...
...
Objeto 'RoleJob'
Nombre | Tipo | Descripción |
---|
code | Long | Código del registro - clave primaria |
roleCode | String | Código del rol |
jobCode | String | Código del puesto en SIU |
initialDate | Date | Fecha de inicio |
finalDate | Date | Fecha de Fin |
Objeto 'SearchParams'
...
sortColumn | String | Columna por la que queremos ordenar |
ascending | Boolean | Indica si el orden de ordenación es ascendente |
fromIndex | Integer | Índice desde el que queremos buscar |
toIndex | Integer | Índice hasta que el que queremos buscar |
Objeto 'User'
...
| Tipo | Descripción |
---|
fiscalAnagram | String | Anagrama fiscal del usuario |
roleOrganism | 1242693904[] | Lista de objetos RoleOrganism |
...
fiscalAnagram | String | Anagrama fiscal del usuario |
ggCode | String | Código del grupo de gestión |
admRoleCode | String | Código del rol |
ggName | String | Nombre del grupo de gestión |
admRoleName | String | Nombre del rol |
...
Objeto 'UserList'
...