En este 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); |
|
...
Servicio que devuelve los atributos de un procedimiento del catálogo de la DGA en función de la información pasada como parámetro en el objeto ParamGetProcedureAttributes.
Estos atributos se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultGetProcedureAttributes getProcedureAttributes(ParamGetProcedureAttributes paramGetProcedureAttributes) Parámetros de invocación
| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | signature | String | Signature o código del procedimiento | | idEntity | String | Código de identificación de entidad. |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedureAttributes | 1242693904[] | Listado de atributos del procedimento buscado |
Códigos error
| PROCEDUREATTRIBUTES_00 | Error que proviene del webservices. | | PROCEDUREATTRIBUTES_01 | El objeto paramGetProcedureAttributes es nulo. | | PROCEDUREATTRIBUTES_02 | La signatura es nula. | | PROCEDUREATTRIBUTES_03 | El idEntity es nulo. |
Ejemplo de invocación| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| ParamGetProcedureAttributes params = new ParamGetProcedureAttributes();
params.setSignature("474");
params.setIdEntity("0");
ResultGetProcedureAttributes result = client.getProcedureAttributes(params); |
|
...
Servicio que devuelve el detalle de un procedimiento de catálogo de la DGA dado en función de la información pasada como parámetro en el objeto ParamProcedureDetail.
Los datos del procedimiento se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultProcedureDetail procedureDetail(ParamProcedureDetail paramProcedureDetail) Parámetros de invocación
| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | signature | String | Signature o código del procedimiento |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedure | 1242693904 | Objeto Procedure, con los datos del procedimiento |
Códigos error
| PROCEDUREDETAIL_00 | Error durante el proceso de búsqueda de procedure detail | | PROCEDUREDETAIL_01 | El objeto paramProcedureDetail es nulo | | PROCEDUREDETAIL_02 | No existe un procedimiento para esa signature | | PROCEDUREDETAIL_03 | La Signature es nula |
Ejemplo de invocación| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| ParamProcedureDetail params = new ParamProcedureDetail();
//se va a detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400");
ResultProcedureDetail result = pauAgent.procedureDetail(params); |
|
...
Los datos del procedimiento se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultProcedureDetail procedureDetail (ParamProcedureDetailByIdEntity paramProcedureDetailByIdEntity) Parámetros de invocación
| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | idEntity | String | Código de la entidad asociada | | signature | String | Signature o código del procedimiento |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedure | 1242693904 | Objeto Procedure, con los datos del procedimiento |
Códigos error
| PROCEDUREDETAILBYIDENTITY_00 | Error durante el proceso de búsqueda de
procedure detail. | | PROCEDUREDETAILBYIDENTITY_01 | El objeto paramProcedureDetailByIdEntity es
nulo. | | PROCEDUREDETAILBYIDENTITY_02 | La signatura es nula. | | PROCEDUREDETAILBYIDENTITY_03 | La entidad es nula. | | PROCEDUREDETAILBYIDENTITY_04 | Error que proviene del webservices |
Ejemplo de invocación| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| ParamProcedureDetailByIdEntity params = new
ParamProcedureDetailByIdEntity();
//se va a detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400");
params.setIdEntity("0");
ResultProcedureDetail result = pauAgent.procedureDetail(params); |
|
...
Los datos del procedimiento se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultProcedureDetailSIA procedureDetailBySIACod(ParamProcedureDetailBySIACod paramProcedureDetailBySIACod) Parámetros de invocación
| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | codSIA | String | Código SIA asociado |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedureSIA | 1242693904 | Objeto ProcedureSIA, con los datos del procedimiento |
Códigos error
| PROCEDUREDETAILBYSIA_00 | Error durante el proceso de búsqueda de procedureDetailBySIACod | | PROCEDUREDETAILBYSIA_01 | El objeto ParamProcedureDetailBySIACod es nulo | | PROCEDUREDETAILBYSIA_02 | No existe un procedimiento para ese código SIA | | PROCEDUREDETAILBYSIA_03 | El código SIA es nulo |
Ejemplo de invocación| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| ParamProcedureDetailBySIACod params = new ParamProcedureDetailBySIACod();
params.applicationId("PAU");
params.setCodSIA("213285");
ResultProcedureDetailSIA result = pauAgent.procedureDetailBySIACod(params); |
|
...
Los datos de los procedimientos se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)
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. Contiene criterios de búsqueda de Procedure, así como los parámetros de paginación y ordenación. |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedures | 1242693904[] | Listado de procedimientos encontrados |
Códigos error
| PROCEDUREDETAILLIST_00 | Error en el proceso de búsqueda de listado de procedimientos | | PROCEDUREDETAILLIST_01 | El objeto paramProcedureDetailList es nulo. | | PROCEDUREDETAILLIST_02 | No existen procedimientos para los parámetros de búsqueda. | | PROCEDUREDETAILLIST_03 | El id de la entidad es nulo |
Ejemplo de invocación| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| ParamProcedureDetailList params = new ParamProcedureDetailList();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setIdEntidad("0");
procedureSearch.setDenomination("registro oficial");
params.setProcedureSearch(procedureSearch);
ResultProcedureDetailList
result=pauAgent.procedureDetailList(params); |
|
...
Los datos de los procedimientos se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)
Parámetros de invocación
| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | signatures | String[] | Códigos de los procedimiento de los que se quiere obtener el detalle | | idEntity | String | Código de la entidad asociada |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedures | 1242693904[] | Listado de procedimientos encontrados junto a sus órganos gestores. |
Códigos error
| PROCEDURELIST_01 | El objeto ParamSignaturesAndIdEntity es nulo | | PROCEDURELIST_03 | El objeto signatures es nulo | | PROCEDURELIST_05 | El objeto signatures está vacío | | PROCEDURELIST_06 | No se han encontrado procedimientos para los parámetros de búsqueda. |
Ejemplo de invocación| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| GestionGroup gestionGroup = new GestionGroup();
gestionGroup.setName("nombre GG");
gestionGroup.setDescription("descripción GG");
Procedure procedure1 = new Procedure();
procedure1.setSignature("1");
procedure1.setDenomination("den1"); |
|
...
Los datos de los procedimientos se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultProcedureDetailSIA procedureDetailWithSIA(ParamProcedureDetailByIdEntity paramProcedureDetail) Parámetros de invocación
| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | idEntity | String | Código de la entidad asociada | | signature | String | Código del procedimiento que se quiere obtener el detalle |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedureSIA | 1242693904 | Objeto ProcedureSIA, con los datos del procedimiento |
Códigos error
| PROCEDUREDETAILSIA_00 | Error durante el proceso de búsqueda de procedure detail | | PROCEDUREDETAILSIA_01 | El objeto paramProcedureDetail es nulo | | PROCEDUREDETAILSIA_02 | No existe un procedimiento para esa signature | | PROCEDUREDETAILSIA_03 | La Signature es nula | | PROCEDUREDETAILSIA_04 | La Entidad es nula |
Ejemplo de invocación| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| ParamProcedureDetailByIdEntity params = new ParamProcedureDetailByIdEntity();
params.applicationId("PAU");
params.setfiscalAnagram("11111111H");
params.setSignature("400");
params.setIdEntity("0");
ResultProcedureDetailSIA result = pauAgent.procedureDetailWithSIA(params); |
|
...
Servicio que devuelve un listado de procedimientos publicados y despublicados del catálogo por la DGA en función de la información pasada como parámetro en el objeto ParamProcedureList.
Los datos de los procedimientos se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultProcedureList procedureList(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("");
procedureSearch.setVersion("");
procedureSearch.setIdOrgano("");
params.setProcedureSearch(procedureSearch);
ResultProcedureList result = pauAgent.procedureList(params); |
|
...
Servicio que devuelve un listado de procedimientos dados de alta en catálogo por la DGA en función de la información pasada como parámetro en el objeto ParamProcedureListByUser. Es similar al servicio referenciado en el punto 6.3.1.2, siendo obligatorio introducir el campo “idEntidad”.
Los datos de los procedimientos se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultProcedureList procedureList(ParamProcedureListAndEntity paramProcedureListAndEntity)
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 | | PROCEDURELIST_04 | El parámetro idEntidad es nulo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| ParamProcedureListAndIdEntity params = new ParamProcedureListAndIdEntity();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignature("");
procedureSearch.setVersion("");
procedureSearch.setIdOrgano("");
procedureSearch.setIdEntidad("0");
params.setProcedureSearch(procedureSearch);
ResultProcedureList result = pauAgent.procedureList(params); |
|
...
Estos procedimientos no se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaVResultProcedureRoleList procedureListByAplicationAndIdEntity(VParamProcedureRoleList vparamProcedureRoleList)
Parámetros de invocación
| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | procedureSearchBean | 1242693904 | Objeto VProcedureRoleSearchBean, campos de búsqueda para procedimientos |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedureRoles | 1242693904 | Lista de objetos VProcedureRole | | size | int | Tamaño de la lista de procedimientos recuperados |
Códigos error
| PROCEDURELISTBYAPLICATIONANDIDENTITY_00 | Error durante el proceso de búsqueda | | PROCEDURELISTBYAPLICATIONANDIDENTITY_01 | El objeto ParamAssignedProcedureRoleList es nulo | | PROCEDURELISTBYAPLICATIONANDIDENTITY_02 | No hay procedimientos relacionados con estos parámetros de búsqueda | | PROCEDURELISTBYAPLICATIONANDIDENTITY_03 | Ha ocurrido algún tipo de error al listar los procedimientos | | PROCEDURELISTBYAPLICATIONANDIDENTITY_04 | El objeto procedureSearchBean es nulo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| VParamProcedureRoleList params = new VParamProcedureRoleList();
params.setApplicationId("SFE");
params.setFiscalAnagram("00000000T");
VProcedureRoleSearchBean procedureSearchBean= new VProcedureRoleSearchBean();
procedureSearchBean.setAppAlias("SFE");
procedureSearchBean.setEntity("0");
params.setProcedureSearchBean(procedureSearchBean);
VResultProcedureRoleList result = client.procedureListByAplicationAndIdEntity(params); |
|
...
Servicio que devuelve la lista de procedimientos de Catálogo de la DGA cuyo organismo productor sea el indicado en el objeto ParamProcedureListByOrganism. Además de los procedimientos correspondientes al organismo productor indicado, también se devuelven los procedimientos horizontales.
Los datos de los procedimientos se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultProcedureListByOrganism procedureListByOrganism(ParamProcedureListByOrganism paramProcedureListByOrganism)
Parámetros de invocación
| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método. | | fiscalAnagram | String | Anagrama fiscal. | | organismCode | String | Código de organismo del que se quieren obtener sus procedimientos asociados. | | idEntity | String | Código de identificación de entidad. |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedures | 1242693904[] | Lista de objetos Procedure | | size | int | Tamaño de la lista de procedimientos |
Códigos error
| PROCEDURELISTBYORGANISM_00 | Error durante el proceso de búsqueda de procedure by organism. | | PROCEDURELISTBYORGANISM_01 | El objeto paramProcedureListByOrganism es nulo. | | PROCEDURELISTBYORGANISM_02 | El organismCode es nulo. | | PROCEDURELISTBYORGANISM_03 | El idEntity es nulo. | | PROCEDURELISTBYORGANISM_04 | El organismo no tiene procedimientos asociados. |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| ParamProcedureListByOrganism params = new
ParamProcedureListByOrganism();
//se van a listar, por ejemplo, los procedimientos del organismo “ORG04174” y la entidad “0”
params.setOrganismCode("ORG04174");
params.setIdEntity("0");
ResultProcedureListByOrganism result =
client.procedureListByOrganism(params); |
|
...
Servicio que devuelve los procedimientos de catálogo a los que un usuario puede acceder en función del grupo de gestión al que esté asignado.
Los datos de los procedimientos se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultProcedureListByUser procedureListByUser(ParamProcedureListByUser paramProcedureListByUser) Parámetros de invocación
| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedure | 1242693904[] | Lista de objetos Procedure |
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_03 | El usuario no existe en la base de datos | | PROCEDURELISTBYUSER_04 | Error que proviene del webservices |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| ParamProcedureListByUser params = new ParamProcedureListByUser();
params.setFiscalAnagram("anagrama fiscal");
ResultProcedureListByUser result = pauAgent.procedureListByUser(params); |
|
...
Servicio que devuelve los procedimientos de catálogo a los que un usuario puede acceder en función del grupo de gestión al que esté asignado y a su entidad correspondiente. Es similar al servicio procedureListByUser, pero en este es último es solamente necesario el anagrama fiscal como parámetro de búsqueda.
Los datos de los procedimientos se consultan en DESFORSEDA.
| Expand |
|---|
|
SignaturaResultProcedureListByUser procedureListByUser(ParamProcedureListByUserAndEntity paramProcedureListByUserAndEntity) Parámetros de invocación
| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | idEntity | String | Código de la entidad asociada |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedure | 1242693904[] | Lista de objetos Procedure |
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_03 | El usuario no existe en la base de datos | | PROCEDURELISTBYUSER_04 | Error que proviene del webservices | | PROCEDURELISTBYUSER_05 | El id de la entidad es nulo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| title | Ejemplo de invocación |
|---|
| ParamProcedureListByUserAndEntity params = new ParamProcedureListByUserAndEntity();
params.setFiscalAnagram("72979986C");
params.setIdEntity("0");
ResultProcedureListByUser result = pauAgent.procedureListByUser(params); |
|
Método '
...
procedurePublishedList'
Servicio que devuelve la lista un listado de procedimientos de Catálogo de publicados en el catálogo por la DGA del grupo de gestión pasado en función de la información pasada como parámetro en el objeto ParamGGList. Además de los procedimientos correspondientes al grupo de gestión indicado, también se devuelven los procedimientos horizontales.ParamProcedureList.
Los datos de los procedimientos se consultan en DESFOR. Los grupos de gestión se consultan en PAUSEDA.
| Expand |
|---|
|
SignaturaResultProcedureDetailList proceduresByGestionGroup(ParamGGList paramGGListResultProcedureList 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 | | ggSearchprocedureSearch | 1242693904 | Objeto Objeto ProcedureSearch, campos de búsqueda del grupo de gestiónpara procedimientos |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| resultError | 1242693904 | Objeto ResultError | | procedure | 1242693904[] | Lista de objetos Procedure | size | int | Tamaño de la lista de procedimientos |
Códigos error
| GESTIONGROUPLISTPROCEDURELIST_00 | Error en la operación. Error durante el proceso de búsqueda .de procedure | | GESTIONGROUPLISTPROCEDURELIST_01 | El objeto ParamGGList paramProcedureList es nulo. | | GESTIONGROUPLISTPROCEDURELIST_04Error en la operación. No se han encontrado grupos de gestión para estos parámetros de búsqueda.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 |
|---|
| ParamGGListParamProcedureList params = new ParamGGListParamProcedureList();
GGSearchProcedureSearch ggSearchprocedureSearch = new GGSearchProcedureSearch();
ggSearchprocedureSearch.setGgCodesetSignature("CODE011");
params.setGgSearchsetProcedureSearch(ggSearchprocedureSearch);
ResultProcedureDetailListResultProcedureList result = pauAgent.proceduresByGestionGroup procedurePublishedList(params); |
|
Método '
...
getJobsBySignature'
Servicio que devuelve
...
los puestos que tienen asociada una signature.
| Expand |
|---|
|
SignaturaResultProcedureList procedurePublishedList(ParamProcedureList paramProcedureListResultGetJobsBySignature 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 |
Anagrama fiscal | procedureSearch | 1242693904 | Objeto ProcedureSearch, campos de búsqueda para procedimientos| Signatura por la que se quiere buscar. | | state | String | Estado de alta o baja. |
Parámetros de respuesta
resultErrorprocedure | 1242693904[] | Lista de objetos Procedure1242693904 | Objeto ResultError | | List <String> | Lista de jobCodes | | size | int | Tamaño del listado devuelto |
Códigos error
PROCEDURELIST| PROCEDURELIST_00 | Error durante el proceso de búsqueda de procedure | | GET_JOBS_BY_SIGNATURE_01 | El objeto |
| paramGetJobsBySignature es nulo |
Error que proviene del webservices | | 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 |
|---|
| ParamProcedureListParamGetJobsBySignature params = new ParamProcedureListParamGetJobsBySignature();
ProcedureSearch procedureSearch = new ProcedureSearch(params.setFiscalAnagram(TestConstants.DEFAULT_FISCAL_ANAGRAM);
params.setApplicationId(TestConstants.DEFAULT_ENTITY_ID);
procedureSearchparams.setSignature("1466");
params.setProcedureSearchsetState(procedureSearch"alta");
ResultProcedureListResultGetJobsBySignature result = pauAgenttestClient.procedurePublishedListgetJobsBySignature(params); |
|
Método 'procedureGetAssignedJobList'
...
| 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); |
|
...
| 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); |
|
...
| 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); |
|
...
| 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); |
|
...
| 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'
...