A continuación se describen todos los servicios de SIU junto con los parámetros de invocación, resultado de cada servicio y código java de ejemplo de integración de cada servicio.
...
Método 'ancestralOrganismByUserList'
...
Servicio que devuelve una lista de organismos ancestros a los que pertenece un usuario a partir de un token.
Un organismo ancestro es aquel que tiene la identidad fiscal a 1.
| Expand |
|---|
|
SignaturaResultAncestralOrganismByUserList ancestralOrganismByUserList(ParamAncestralOrganismByUserList paramAncestralOrganismByUserList). Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | token | String | Valor del token cifrado | | originalToken | String | Valor del token a cifrar |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismList | Lista de organismos | | organism | Organismo (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ANCESTRALORGANISMBYUSERLIST_07 | El objeto paramAncestralOrganismByUserList es nulo | | ANCESTRALORGANISMBYUSERLIST_08 | El parámetro de entrada token original es nulo | | ANCESTRALORGANISMBYUSERLIST_01 | El parámetro de entrada token es nulo | | ANCESTRALORGANISMBYUSERLIST_03 | El funcionario no existe en la bd | | ANCESTRALORGANISMBYUSERLIST_04 | El funcionario ha sido dado de baja de la bd | | ANCESTRALORGANISMBYUSERLIST_05 | El funcionario no esta asignado a ningún organismo | | ANCESTRALORGANISMBYUSERLIST_02 | Ha ocurrido algún error al verificar la firma | | ANCESTRALORGANISMBYUSERLIST_00 | Error durante la consulta de los datos de organismos | | ANCESTRALORGANISMBYUSERLIST_06 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocaciónEl ejemplo devuelve un error | Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamAncestralOrganismByUserList param = new ParamAncestralOrganismByUserList();
param.setApplicationId("SIU");
param.setOriginalToken("T");
param.setToken("T");
ResultAncestralOrganismByUserList result = client.ancestralOrganismByUserList(param); |
|
Método 'ancestralOrganismWithAllTree'
...
Servicio que devuelve un listado con la información de TODOS los ancestros de un organismo (tanto de alta como de baja). Recorrerá la rama hacia arriba, hasta localizar su raíz.
| Expand |
|---|
|
SignaturaResultAncestralOrganismWithAllTree ancestralOrganismWithAllTree(ParamAncestralOrganismWithAllTree paramAncestralOrganismWithAllTree) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | orgCode | String | Código de organismo del que se extraerán los de su árbol |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismList | Lista de organismos |
Códigos error
| Código | Descripción |
|---|
| ANCESTRAL_ORGANISM_WITH_ALL_TREE_01 | El objeto paramAncestralOrganismWithAllTree es nulo | | ANCESTRAL_ORGANISM_TREE_03 | Ha ocurrido algún tipo de error al realizar la búsqueda | | ANCESTRAL_ORGANISM_WITH_ALL_TREE_00 | Ha ocurrido algún error inesperado |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamAncestralOrganismWithAllTree param = new ParamAncestralOrganismWithAllTree();
param.setApplicationId("SIU");
param.setOrgCode("ORG15138");
ResultAncestralOrganismWithAllTree result = client.ancestralOrganismWithAllTree(param); |
|
Método 'ancestralOrganismTree' #Deprecated
...
Servicio que devuelve un listado con la información de los ancestros de un organismo, el organismo buscado y los que tienen el mismo padre que el organismo buscado.
| Expand |
|---|
|
SignaturaResultAncestralOrganismTree ancestralOrganismTree(ParamAncestralOrganismTree paramAncestralOrganismTree) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | orgCode | String | Código de organismo del que se extraerán los de su árbol | | organismSearch | Bean de búsqueda de organismos | | organism | Campos del objeto Organism (ver detalle de campos en el apartado de objetos comunes) | | pagingCriteria | Campos del objeto PagingCriteria (ver detalle de campos en el apartado de objetos comunes) | | sortingCriteria | Campos del objeto SortingCriteria (ver detalle de campos en el apartado de objetos comunes) | | params | Campos del objeto SearchParams (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismList | Lista de organismos | | organism | Organismo (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ANCESTRAL_ORGANISM_TREE_01 | El objeto paramAncestralOrganismTree es nulo | | ANCESTRAL_ORGANISM_TREE_04 | El código de organismo no puede ser nulo | | ANCESTRAL_ORGANISM_TREE_02 | No se han encontrado organismos con esos parámetros de búsqueda | | ANCESTRAL_ORGANISM_TREE_03 | Ha ocurrido algún tipo de error al realizar la búsqueda | | ANCESTRAL_ORGANISM_TREE_00 | Ha ocurrido algún error inesperado |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamAncestralOrganismTree param = new ParamAncestralOrganismTree();
param.setApplicationId("SIU");
param.setOrgCode("ORG07458");
ResultAncestralOrganismTree result = client.ancestralOrganismTree(param); |
|
...
De cada organismo devuelve el campo oldCode en caso de que esté este informado.
| Expand |
|---|
|
SignaturaResultAncestralOrganismTreeWithOldCode ancestralOrganismTreeExtendedWithOldCode(ParamAncestralOrganismTree paramAncestralOrganismTree) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | orgCode | String | Código de organismo del que se extraerán los de su árbol | | organismSearch | Bean de búsqueda de organismos | | organism | Campos del objeto Organismo (ver detalle de campos en el apartado de objetos comunes) | | pagingCriteria | Campos del objeto PagingCriteria (ver detalle de campos en el apartado de objetos comunes) | | sortingCriteria | Campos del objeto SortingCriteria (ver detalle de campos en el apartado de objetos comunes) | | params | Campos del objeto SearchParams (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismList | Lista de organismos | | organism | Organismo (ver detalle de campos en el apartado de objetos comunes) | | oldCode | String | Antiguo identificador del organismo |
Códigos error
| Código | Descripción |
|---|
| ANCESTRAL_ORGANISM_TREE_01 | El objeto paramAncestralOrganismTree es nulo | | ANCESTRAL_ORGANISM_TREE_04 | El código de organismo no puede ser nulo | | ANCESTRAL_ORGANISM_TREE_02 | No se han encontrado organismos con esos parámetros de búsqueda | | ANCESTRAL_ORGANISM_TREE_03 | Ha ocurrido algún tipo de error al realizar la búsqueda | | ANCESTRAL_ORGANISM_TREE_00 | Ha ocurrido algún error inesperado |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamAncestralOrganismTree param = new ParamAncestralOrganismTree();
param.setApplicationId("SIU");
param.setOrgCode("ORG08881");
ResultAncestralOrganismTreeWithOldCode result = client.ancestralOrganismTreeExtended(param); |
|
...
Permite filtrar además por otros datos como dirección, cif, ciudad, país, email...
Devuelve el listado de organismos ordenado por código de organismo.
| Expand |
|---|
|
SignaturaResultAscendantOrganismBranchTree ascendantOrganismBranchTree(ParamAscendantOrganismBranchTree paramAscendentOrganismBranchTree) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | orgCode | String | Código de organismo | | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de organismos | | organism | Organismo (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ASCENDENT_ORGANISM_BRANCH_LIST_01 | El objeto paramAscendantOrganimsBranchTree es nulo | | ORGANISMLIST_00 | Error durante la consulta de los datos de organismos | | ORGANISMLIST_01 | El objeto paramOrganismList es nulo | | ORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | ORGANISMLIST_04 | No existe el organismo de entrada | | ORGANISMLIST_03 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamAscendantOrganismBranchTree param = new ParamAscendantOrganismBranchTree();
param.setApplicationId("SIU");
param.setOrgCode("ORG07810");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07810");
param.setOrganismSearch(organismSearch);
ResultAscendantOrganismBranchTree result = client.ascendantOrganismBranchTree(param); |
|
...
Permite filtrar además por otros datos como dirección, cif, ciudad, país, email, si es emisor, si es externo, el código del organismo padre, la fecha de baja, por la identidad fiscal, la fecha de alta, el nombre, el newCode, el código del organismo, el código postal, la provincia, si es receptor, el NIF del jefe del servicio, el nombre corto, el teléfono, el código sirhga o el código sirhga del organismo padre.
| Expand |
|---|
|
SignaturaResultDescendentOrganismList descendentOrganismList(ParamDescendentOrganismList paramDescendentOrganismList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de organismos | | organism | Organismo (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| DESCENDENTORGANISMLIST_00 | Error durante la consulta de los datos de organismos | | DESCENDENTORGANISMLIST_01 | El objeto paramDescendentOrganismList es nulo | | DESCENDENTORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | DESCENDENTORGANISMLIST_03 | El código de organismo es nulo | | DESCENDENTORGANISMLIST_04 | El organismo no existe en la base de datos | | DESCENDENTORGANISMLIST_05 | El organismo esta dado de baja en la base de datos | | DESCENDENTORGANISMLIST_06 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamDescendentOrganismList param = new ParamDescendentOrganismList();
param.setApplicationId("SIU");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07839");
param.setOrganismSearch(organismSearch);
ResultDescendentOrganismList result = client.descendentOrganismList(param); |
|
...
Permite filtrar además por otros datos como dirección, cif, ciudad, país, email, si es emisor, si es externo, el código del organismo padre, la fecha de baja, por la identidad fiscal, la fecha de alta, el nombre, el newCode, el código del organismo, el código postal, la provincia, si es receptor, el NIF del jefe del servicio, el nombre corto, el teléfono, el código sirhga o el código sirhga del organismo padre.
| Expand |
|---|
|
SignaturaResultDescendentOrganismListWithCode descendentOrganismList(ParamDescendentOrganismList paramDescendentOrganismList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de organismos | | organism | OrganismoWithCode (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| DESCENDENTORGANISMLIST_00 | Error durante la consulta de los datos de organismos | | DESCENDENTORGANISMLIST_01 | El objeto paramDescendentOrganismList es nulo | | DESCENDENTORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | DESCENDENTORGANISMLIST_03 | El código de organismo es nulo | | DESCENDENTORGANISMLIST_04 | El organismo no existe en la base de datos | | DESCENDENTORGANISMLIST_05 | El organismo esta dado de baja en la base de datos | | DESCENDENTORGANISMLIST_06 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamDescendentOrganismListWithCode param = new ParamDescendentOrganismList();
param.setApplicationId("SIU");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07839");
param.setOrganismSearch(organismSearch);
ResultDescendentOrganismList result = client.descendentOrganismList(param); |
|
...
Servicio que devuelve la lista de Organismos Administrativos en la rama del organismo con el que se ha logueado el usuario, pasado como parámetro, hasta el primer organismo con FISCAL_IDENTITY=1 en esa rama. Devuelve la lista ordenada por cercanía al organismo del usuario, es decir, primero el organismo con el código mayor.
| Expand |
|---|
|
SignaturaResultAdministrativeOrganismList getAdministrativeOrganismList(ParamAdministrativeOrganismList paramAdministrativeOrganismList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | userOrganismCode | String | Código del organismo con el que se ha logueado el usuario |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | dataList | Lista de organismos administradores | | name | String | Nombre del organismo administradores | | organismCode | String | Código del organismo administradores |
Códigos error
| Código | Descripción |
|---|
| ADMINISTRATIVE_ORGAN_00 | El parámetro de búsqueda no puede ser nulo | | ADMINISTRATIVE_ORGAN_01 | Los campos del parámetro de búsqueda no pueden ser nulos | | ADMINISTRATIVE_ORGAN_02 | No hay códigos de organismos administradores en la rama a la que pertenece el organismo con el que se ha logueado el usuario |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamAdministrativeOrganismList param = new ParamAdministrativeOrganismList();
param.setApplicationId("SIU");
param.setUserOrganismCode("ORG16671");
ResultAdministrativeOrganismList response = client.getAdministrativeOrganismList(param);
|
|
...
Servicio que devuelve la lista de los organismos tramitadores que coinciden entre los pasados como parámetro y la rama del organismo con el que se ha logueado el usuario, pasado también como parámetro, hasta el primer organismo con FISCAL_IDENTITY=1 en esa rama. Devuelve la lista ordenada por cercanía al organismo del usuario, es decir, primero el organismo con el código mayor.
| Expand |
|---|
|
SignaturaResultProcessUnitList getClosestProcessUnitList(ParamGetProcessUnitList requestParam) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | organismCodes | List<String> | Listado de códigos de organismos | | userOrganismCode | String | Código del organismo con el que se ha logueado el usuario |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | dataList | Lista de organismos tramitadores que coinciden | | name | String | Nombre del organismo tramitador | | organismCode | String | Código del organismo tramitador |
Códigos error
| Código | Descripción |
|---|
| GETPROCESSUNIT_00 | El parámetro de búsqueda no puede ser nulo | | GETPROCESSUNIT_01 | Los campos del parámetro de búsqueda no pueden ser nulos | | GETPROCESSUNIT_02 | No hay códigos de organismos coincidentes entre la lista recibida y la rama a la que pertenece el organismo con el que se ha logueado el usuario |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamGetProcessUnitList param = new ParamGetProcessUnitList();
param.setApplicationId("SIU");
param.setUserOrganismCode("ORG11896");
param.setOrganismCodes(new String[] { "ORG11896", "ORG14166", "ORG11882", "ORG15137", "ORG11652", "ORG11904", "ORG11964" });
ResultProcessUnitList response = client.getInfoServices().getClosestProcessUnitList(param);
|
|
...
Servicio que devuelve los organismos SIU correspondientes a un listado de códigos dir3.
| Expand |
|---|
|
SignaturaResultGetDir3CodeList getDir3CodeList(ParamOrganismWithCodeDir3List paramOrganismWithCodeDir3List) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismDir3CodeList | List<String> | Listado de códigos dir3 |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismDir3CodeList | Lista de organismos con código DIR3 | | organism | Organismo (ver detalle de campos en el apartado de objetos comunes) | | organismDir3Code | Código DIR3 del organismo |
Códigos error
| Código | Descripción |
|---|
| GETDIR3CODELIST_00 | Código de error general para este servicio | | GETDIR3CODELIST_01 | El objeto ParamOrganismWithCodeDir3List es nulo | | GETDIR3CODELIST_02 | La lista de organismos DIR3 está vacía | | GETDIR3CODELIST_03 | No se han encontrado organismos para estos parámetros de búsqueda | | GETDIR3CODELIST_04 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismWithCodeDir3List param = new ParamOrganismWithCodeDir3List();
param.setApplicationId("SIU");
List<String> lstDirCode = new ArrayList<String>();
lstDirCode.add("A02003454");
param.setOrganismDir3CodeList(lstDirCode);
ResultGetDir3CodeList result = client.getDir3CodeList(param);
|
|
...
Permite filtrar por dirección, cif, ciudad, pais, email, si es emisor, código del organismo padre, código sirhga del organismo padre, fecha de baja, identidad fiscal, fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, NIF del jefe del servicio, nombre corto, código sirhga del organismo y teléfono.
| Expand |
|---|
|
SignaturaResultOrganismAdditionalData getOrganismAdditionalData(ParamOrganismAdditionalData paramOrganismAdditionalData) 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 | | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismAdditionalData | Objeto OrganismAdditionalData (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISM_ADDITIONAL_DATA_00 | Código de error general para este servicio | | ORGANISM_ADDITIONAL_DATA_01 | El objeto paramOrganismAdditionalData es nulo | | ORGANISM_ADDITIONAL_DATA_02 | No se han encontrado organismos para estos parámetros de búsqueda | | ORGANISM_ADDITIONAL_DATA_03 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismAdditionalData param = new ParamOrganismAdditionalData();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
OrganismSearch organismSearch = new OrganismSearch();
param.setOrganismSearch(organismSearch);
ResultOrganismAdditionalData result = client.getOrganismAdditionalData(param);
|
|
...
Servicio para obtener un histórico de organismos partiendo de un organismo pasado como parámetro. Devuelve un listado de organismos.
| Expand |
|---|
|
SignaturaResultGetOrganismHistoricalInformation getOrganismHistoricalInformation(ParamGetOrganismHistoricalInformation paramGetOrganismHistoricalInformation) 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 del organismo a buscar | | chronologicalOrder | String | Orden cronológico, las opciones admitidas son PRESENT y PREVIOUS, por defecto se utiliza PREVIOUS |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismList | Lista de organismos | | organism | Objeto Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| GET_ORGANISM_HISTORICAL_INFORMATION_00 | Error durante la consulta de organismos cronológicos | | GET_ORGANISM_HISTORICAL_INFORMATION_01 | El objeto ParamGetOrganismHistoricalInformation es nulo | | GET_ORGANISM_HISTORICAL_INFORMATION_02 | El código de organismo es nulo | | GET_ORGANISM_HISTORICAL_INFORMATION_03 | No se han encontrado organismos para estos parámetros de búsqueda | | GET_ORGANISM_HISTORICAL_INFORMATION_04 | Error con el parámetro de orden cronológico | | GET_ORGANISM_HISTORICAL_INFORMATION_05 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamGetOrganismHistoricalInformation params = new ParamGetOrganismHistoricalInformation();
params.setApplicationId("SIU");
params.setOrganismCode("ORG04302");
params.setChronologicalOrder("PREVIOUS");
ResultGetOrganismHistoricalInformation result = client.getOrganismHistoricalInformation(params);
|
|
...
Servicio que devuelve una lista de organismos original y productor de una lista de organismos pasada como parámetro.
| Expand |
|---|
|
SignaturaResultOrganismWithFiscalIdentityList getOrganismWithFiscalIdentity(ParamOrganismWithFiscalIdentityList paramOrganismWithFiscalIdentityList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismList | List<String> | Listado de códigos de organismo |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismWithFiscalIdentity | Lista de organismos, objeto OrganismWithFiscalIdentity (ver detalle en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| GETORGANISMWIDTHFISCALIDENTITYLIST_00 | Código de error general para este servicio | | GETORGANISMWIDTHFISCALIDENTITYLIST_01 | El objeto ParamOrganismWithFiscalIdentityList es nulo | | GETORGANISMWIDTHFISCALIDENTITYLIST_02 | La lista de organismos está vacía | | GETORGANISMWIDTHFISCALIDENTITYLIST_03 | No se han encontrado organismos para estos parámetros de búsqueda | | GETORGANISMWIDTHFISCALIDENTITYLIST_04 | Ha ocurrido algún error al realizar la búsqueda | | GETORGANISMWIDTHFISCALIDENTITYLIST_05 | La lista de resultados está vacía | | GETORGANISMWIDTHFISCALIDENTITYLIST_06 | El organismo productor es nulo o está vacío | | GETORGANISMWIDTHFISCALIDENTITYLIST_07 | Error al realizar la búsqueda del organismo productor | | GETORGANISMWIDTHFISCALIDENTITYLIST_08 | El organismo original no existe | | GETORGANISMWIDTHFISCALIDENTITYLIST_09 | Alguno de los organismo informados está dado de baja | | GETORGANISMWIDTHFISCALIDENTITYLIST_10 | El organismo productor esta dado de baja |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismWithFiscalIdentityList param = new ParamOrganismWithFiscalIdentityList();
param.setApplicationId("SIU");
param.setFiscalAnagram("");
List<String> organismList = new ArrayList<String>();
organismList.add("ORG07810");
param.setOrganismList(organismList);
ResultOrganismWithFiscalIdentityList result = client.getOrganismWithFiscalIdentity(param);
|
|
...
Servicio que devuelve la lista de los organismos tramitadores que coinciden entre los pasados como parámetro y las ramas de los organismos a consultar, pasados también como parámetro, hasta el primer organismo con FISCAL_IDENTITY=1 en cada una de esas ramas. Devuelve la lista con las listas ordenadas por cercanía al organismo consultado, es decir, primero el organismo con el código mayor.
| Expand |
|---|
|
SignaturaResultProccesingUnitsListByOrganimsList getProccesingUnitsListByOrganimsList(ParamProccesingUnitsListByOrganimsList paramProccesingUnitsListByOrganimsList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | organismCodes | List<String> | Listado de códigos de organismos a consultar | | organismCodesProcc | List<String> | Listado de códigos de organismos del procedimiento |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista processingList devuelta | | processingList | Lista de listas de organismos tramitadores que coinciden | | organismCodeOrigin | String | Código del organismo cuya rama se ha consultado | | size | int | Tamaño de la lista dataList devuelta | | dataList | Lista de organismos tramitadores que coinciden | | name | String | Nombre del organismo tramitador | | organismCode | String | Código del organismo tramitador |
Códigos error
| Código | Descripción |
|---|
| GETPROCESSUNIT_00 | El parámetro de búsqueda no puede ser nulo | | GETPROCESSUNIT_01 | Los campos del parámetro de búsqueda no pueden ser nulos | | GETPROCESSUNIT_02 | No hay códigos de organismos coincidentes entre la lista recibida de códigos del procedimiento y las ramas a la que pertenecen los organismos consultados |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| String[] userOrganismCode = new String[] { "ORG14392" };
String[] processUnitCodes = new String[] { "ORG14392", "ORG14391", "ORG14390", "ORG14367", "ORG12841", "ORG15560", "ORG16806", "ORG14123" };
ParamProccesingUnitsListByOrganimsList param = new ParamProccesingUnitsListByOrganimsList();
param.setApplicationId("SIU");
param.setOrganismCodes(userOrganismCode);
param.setOrganismCodesProcc(processUnitCodes);
ResultProccesingUnitsListByOrganimsList response = client.getProccesingUnitsListByOrganimsList(param);
|
|
...
Servicio que devuelve un listado de organismos descendientes directos de otro organismo pasado como parámetro pudiendo filtrar por fecha.
| Expand |
|---|
|
SignaturaResultHistoricalOrganismDirectDescendentList historicalOrganismDirectDescendentList(ParamHistoricalOrganismDirectDescendentList paramHistoricalOrganismDirectDescendentList) 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 | | date | Date | Hasta la fecha de cambio de estructura, si viene vacía es el árbol ACTUAL | | since | Date | Fecha del cambio de estructura anterior, si viene vacía es el árbol ORIGINAL hasta la fecha |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismFather | Objeto Organism (ver detalle en el apartado de objetos comunes), organismo padre | | organismList | Lista de objetos Organism (ver detalle en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| HISTORICAL_ORGANISM_DIRECT_DESCENDENT_LIST_00 | Error durante la consulta de organismos históricos | | HISTORICAL_ORGANISM_DIRECT_DESCENDENT_LIST_01 | El objeto paramHistoricalOrganismDirectDescendentList es nulo | | HISTORICAL_ORGANISM_DIRECT_DESCENDENT_LIST_02 | El código de organismo es nulo | | HISTORICAL_ORGANISM_DIRECT_DESCENDENT_LIST_03 | No se han encontrado organismos históricos para estos parámetros de búsqueda | | HISTORICAL_ORGANISM_DIRECT_DESCENDENT_LIST_04 | Ha ocurrido algún error al realizar la búsqueda | | HISTORICAL_ORGANISM_DIRECT_DESCENDENT_LIST_05 | Nunca ha existido un organismo con ese código | | HISTORICAL_ORGANISM_DIRECT_DESCENDENT_LIST_06 | El organismo aún no se había creado en la fecha indicada | | HISTORICAL_ORGANISM_DIRECT_DESCENDENT_LIST_07 | El organismo no existía en el árbol en la fecha indicada |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamHistoricalOrganismDirectDescendentList param = new ParamHistoricalOrganismDirectDescendentList();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07839");
ResultHistoricalOrganismDirectDescendentList result = client.historicalOrganismDirectDescendentList(param);
|
|
...
El listado devuelto se ordena por código de organismo.
| Expand |
|---|
|
SignaturaResultHistoricalOrganismTreeList historicalOrganismTreeList(ParamHistoricalOrganismTreeList paramHistoricalOrganismTreeList) 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 |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de objetos OrganismDir3CodeWithOldCode (ver detalle en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| HISTORICAL_ORGANISM_TREE_LIST_00 | Error durante la consulta de organismos históricos | | HISTORICAL_ORGANISM_TREE_LIST_01 | El objeto paramHistoricalOrganismTreeList es nulo | | HISTORICAL_ORGANISM_TREE_LIST_02 | El código de organismo es nulo | | HISTORICAL_ORGANISM_TREE_LIST_03 | El organismo no existe en la base de datos | | HISTORICAL_ORGANISM_TREE_LIST_04 | El organismo esta dado de baja en la base de datos |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamHistoricalOrganismTreeList param = new ParamHistoricalOrganismTreeList();
param.setApplicationId("SIU");
param.setOrganismCode("ORG15551");
ResultHistoricalOrganismTreeList result = client.historicalOrganismTreeList(param);
|
|
...
Además de los datos de los organismos devueltos en la lista, devuelve el código del organismo buscado.
| Expand |
|---|
|
SignaturaResultHistoricalParent historicalParent(ParamHistoricalParent paramHistoricalParent) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismList | String[] | Lista de organismos a buscar |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | historicalParentListObject | Lista de objetos HistoricalParentListObject (ver detalle campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| HISTORICAL_PARENT_00 | Error durante la consulta de los datos | | HISTORICAL_PARENT_01 | El objeto paramAscendentOrganismBranchTree es nulo | | HISTORICAL_PARENT_02 | La lista de organismos de entrada está vacía |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamHistoricalParent param = new ParamHistoricalParent();
param.setApplicationId("SIU");
String[] organismList = { "ORG00002" };
param.setOrganismList(organismList);
ResultHistoricalParent result = client.historicalParent(param);
|
|
...
Además de los datos de los organismos devueltos en la lista, devuelve el código del organismo buscado.
| Expand |
|---|
|
SignaturaResultHistoricalTree historicalTree(ParamHistoricalTree paramHistoricalTree) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismList | String[] | Lista de organismos a buscar |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | historicalTreeListObject | Lista de objetos HistoricalTreeListObject (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| HISTORICAL_TREE_00 | Error durante la consulta de los datos | | HISTORICAL_TREE_01 | El objeto paramAscendentOrganismBranchTree es nulo | | HISTORICAL_TREE_02 | La lista de organismos de entrada está vacía |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamHistoricalTree param = new ParamHistoricalTree();
param.setApplicationId("SIU");
String[] organismList = { "ORG00002" };
param.setOrganismList(organismList);
ResultHistoricalTree result = client.historicalTree(param);
|
|
...
Servicio que devuelve dado un listado de nif, si existen o no en siu.
| Expand |
|---|
|
SignaturaResultUserExist getListUserExist(ParamUserExist paramUserExist); Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | listFiscalAnagram | HashSet<String> | Listado de nifs | | listNrpt | HashSet<String> | Listado de nrpts (identificadores del puesto en SIRHGA) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | listUserExist | List<UserExist> | Listado de UserExist |
Códigos error
| Código | Descripción |
|---|
| GET_LIST_USER_EXIST_00 | Error al consultar la existencia de usuarios en SIU. | | GET_LIST_USER_EXIST_01 | El listado de nif no puede ser nulo o vacío | | GET_LIST_USER_EXIST_02 | El listado de nrpt no puede ser nulo o vacío |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| HashSet<String> listNifs = new HashSet<String>();
HashSet<String> listNrpts = new HashSet<String>();
ParamUserExist paramUserExist = new ParamUserExist();
paramUserExist.setApplicationId("SIU");
paramUserExist.setListFiscalAnagram(listNifs);
paramUserExist.setListNrpt(listNrpts);
// Consultamos la lista de nifs y nrpts en SIU
ResultUserExist result = client.getListUserExist(paramUserExist);
|
|
...
Permite filtrar por email, anagrama fiscal, nombre, nif, estado y apellidos.
| Expand |
|---|
|
SignaturaResultLoginOrganismListByUser loginOrganismListByUser(ParamLoginOrganismListByUser paramLoginOrganismListByUser) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | userSearch | Objeto UserSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | loginOrganismByUser | Lista de objetos LoginOrganismByUser (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| LOGINORGANISMLISTBYUSER_00 | Código de error general para este servicio | | LOGINORGANISMLISTBYUSER_01 | El objeto paramLoginOrganismListByUser es nulo | | LOGINORGANISMLISTBYUSER_02 | No existen usuarios dados de alta con los parámetros de búsqueda establecidos |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamLoginOrganismListByUser param = new ParamLoginOrganismListByUser();
param.setApplicationId("SIU");
UserSearch userSearch = new UserSearch();
userSearch.setNif("00000000T");
param.setUserSearch(userSearch);
ResultLoginOrganismListByUser result = client.loginOrganismListByUser(param);
|
|
...
Servicio que a partir de un código de un organismo activo, devuelve los datos de ese organismo.
| Expand |
|---|
|
SignaturaResultOrganismActive organismActive(ParamOrganismActive paramOrganismActive) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismActive | String | Código de organismo |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organism | Objeto Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISMACTIVE_00 | Error durante la consulta de los datos de organismos | | ORGANISMACTIVE_01 | El objeto paramOrganismActive es nulo | | ORGANISMACTIVE_02 | No existe el organismo de entrada | | ORGANISMACTIVE_03 | Ha ocurrido algún error al realizar la búsqueda | | ORGANISMACTIVE_04 | El código de organismo es nulo | | ORGANISMACTIVE_05 | No existe organismo Activo para este código |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismActive param = new ParamOrganismActive();
param.setApplicationId("SIU");
param.setOrganismActive("ORG07839");
ResultOrganismActive result = client.organismActive(param);
|
|
...
De cada organismo devuelto, devuelve: si es emisor, una lista con datos extendidos, si es externo, el código del organismo padre, la identidad fiscal, la fecha de alta, el nombre, el código del organismo, si es receptor y el nombre corto.
| Expand |
|---|
|
SignaturaResultOrganismActiveList organismActiveList(ParamOrganismActiveList paramOrganismActiveList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismActiveList | String[] | Lista de organismos activos |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismActiveListObject | Lista de objetos OrganismActiveListObject |
Códigos error
| Código | Descripción |
|---|
| ORGANISMACTIVELIST_00 | Error durante la consulta de los datos | | ORGANISMACTIVELIST_01 | El objeto paramOrganismActiveList es nulo | | ORGANISMACTIVELIST_02 | La lista de organismos de entrada está vacía |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismActiveList param = new ParamOrganismActiveList();
param.setApplicationId("SIU");
String[] organismActiveList = { "ORG07839" };
param.setOrganismActiveList(organismActiveList);
ResultOrganismActiveList result = client.organismActiveList(param);
|
|
...
De cada organismo devuelto, devuelve: dirección, ciudad, país, si es emisor, una lista con datos extendidos, si es externo, el código del organismo padre, la identidad fiscal, la fecha de alta, el nombre, el código del organismo, el código postal, la provincia, si es receptor, el nombre corto y el teléfono.
| Expand |
|---|
|
SignaturaResultOrganismDataAndFirstLevelOfDescendentList organismDataAndFirstLevelOfDescendentList(ParamOrganismDataAndFirstLevelOfDescendentList paramOrganismDataAndFirstLevelOfDescendentList) 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 | | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de objetos Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| DIRECTDESCENDENTORGANISMLIST_00 | Código de error general para este servicio | | DIRECTDESCENDENTORGANISMLIST_01 | El objeto paramOrganismDataAndFirstLevelOfDescendentList es nulo | | DESCENDENTORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | DIRECTDESCENDENTORGANISMLIST_03 | El código de organismo es nulo | | DIRECTDESCENDENTORGANISMLIST_04 | El organismo no existe en la base de datos | | DIRECTDESCENDENTORGANISMLIST_05 | El organismo esta dado de baja en la base de datos | | DIRECTDESCENDENTORGANISMLIST_06 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismDataAndFirstLevelOfDescendentList param = new ParamOrganismDataAndFirstLevelOfDescendentList();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07839");
OrganismSearch organismSearch = new OrganismSearch();
param.setOrganismSearch(organismSearch);
ResultOrganismDataAndFirstLevelOfDescendentList result = client.organismDataAndFirstLevelOfDescendentList(param);
|
|
...
De cada organismo devuelto, devuelve: dirección, ciudad, país, si es emisor, una lista con datos extendidos, si es externo, el código del organismo padre, la identidad fiscal, la fecha de alta, el nombre, el código del organismo, el código postal, la provincia, si es receptor, el nombre corto y el teléfono.
| Expand |
|---|
|
SignaturaResultOrganismDataAndFirstLevelOfDescendentListWithCode organismDataAndFirstLevelOfDescendentList(ParamOrganismDataAndFirstLevelOfDescendentList paramOrganismDataAndFirstLevelOfDescendentList) 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 | | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de objetos OrganismWithCode (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| DIRECTDESCENDENTORGANISMLIST_00 | Código de error general para este servicio | | DIRECTDESCENDENTORGANISMLIST_01 | El objeto paramOrganismDataAndFirstLevelOfDescendentList es nulo | | DESCENDENTORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | DIRECTDESCENDENTORGANISMLIST_03 | El código de organismo es nulo | | DIRECTDESCENDENTORGANISMLIST_04 | El organismo no existe en la base de datos | | DIRECTDESCENDENTORGANISMLIST_05 | El organismo esta dado de baja en la base de datos | | DIRECTDESCENDENTORGANISMLIST_06 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismDataAndFirstLevelOfDescendentList param = new ParamOrganismDataAndFirstLevelOfDescendentList();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07839");
OrganismSearch organismSearch = new OrganismSearch();
param.setOrganismSearch(organismSearch);
ResultOrganismDataAndFirstLevelOfDescendentList result = client.organismDataAndFirstLevelOfDescendentList(param);
|
|
...
De cada organismo devuelto, devuelve: dirección, ciudad, país, si es emisor, una lista con datos extendidos, si es externo, el código del organismo padre, la identidad fiscal, la fecha de alta, el nombre, el código del organismo, el código postal, la provincia, si es receptor, el nombre corto, el teléfono y la lista de tipificaciones asociadas ordenadas por nivel.
| Expand |
|---|
|
SignaturaResultOrganismDataAndFirstLevelOfDescendentListWithTypes organismDataAndFirstLevelOfDescendentListWithTypes(ParamOrganismDataAndFirstLevelOfDescendentList params) 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 | | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de objetos OrganismWithTypesOrdered (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| DIRECTDESCENDENTORGANISMLIST_00 | Código de error general para este servicio | | DIRECTDESCENDENTORGANISMLIST_01 | El objeto paramOrganismDataAndFirstLevelOfDescendentList es nulo | | DESCENDENTORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | DIRECTDESCENDENTORGANISMLIST_03 | El código de organismo es nulo | | DIRECTDESCENDENTORGANISMLIST_04 | El organismo no existe en la base de datos | | DIRECTDESCENDENTORGANISMLIST_05 | El organismo esta dado de baja en la base de datos | | DIRECTDESCENDENTORGANISMLIST_06 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismDataAndFirstLevelOfDescendentList param = new ParamOrganismDataAndFirstLevelOfDescendentList();
param.setApplicationId("SIU");
param.setOrganismCode("ORG11625");
ResultOrganismDataAndFirstLevelOfDescendentListWithTypes result = client.organismDataAndFirstLevelOfDescendentListWithTypes(param);
|
|
...
Para cada organismo devuelto, devolverá los datos de ese organismo, más los datos de tipificación asociada, en caso de que tenga. Devolverá solo los organismos activos.
| Expand |
|---|
|
SignaturaResultOrganismDescendListByType organismDescendListByType(ParamOrganismDescendListByType params) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método (obligatorio) | typeId | String | Código de tipificación (obligatorio) | | organismCode | String | Código de organismo (opcional) | | directSearch | String | (valores S o N, opcional en caso de rellenar organismCode, sino se rellena organismCode, el servicio no utilizará este campo) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de objetos OrganismWithTypesOrdered (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISMDESCENDLISTBYTYPE_00 | Código de error general para este servicio | | ORGANISMDESCENDLISTBYTYPE_01 | El objeto ParamOrganismDescendListByType es nulo | | ORGANISMDESCENDLISTBYTYPE_02 | El parámetro typeId es nulo | | ORGANISMDESCENDLISTBYTYPE_03 | La tipificación especificada no esta definida. | | ORGANISMDESCENDLISTBYTYPE_04 | El código de organismo es nulo | | ORGANISMDESCENDLISTBYTYPE_05 | El organismo no existe en la base de datos | | ORGANISMDESCENDLISTBYTYPE_06 | El organismo no existe en la base de datos | | ORGANISMDESCENDLISTBYTYPE_07 | No se han encontrado organismos para estos parámetros de búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismDescendListByType param = new ParamOrganismDescendListByType();
param.setApplicationId("SIU");
param.setTypeId(1);
ResultOrganismDescendListByType result = client.organismDescendListByType(param);
|
|
...
De cada organismo devuelto, devuelve: si es emisor, una lista con datos extendidos, si es externo, el código del organismo padre, la identidad fiscal, la fecha de alta, el nombre, el código del organismo, si es receptor y el nombre corto.
| Expand |
|---|
|
SignaturaResultOrganismList organismList(ParamOrganismList paramOrganismList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de objetos Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISMLIST_00 | Error durante la consulta de los datos de organismos | | ORGANISMLIST_01 | El objeto paramOrganismList es nulo | | ORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | ORGANISMLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | ORGANISMLIST_04 | No existe el organismo de entrada |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismList param = new ParamOrganismList();
param.setApplicationId("SIU");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07839");
param.setOrganismSearch(organismSearch);
ResultOrganismList result = client.organismList(param);
|
|
...
De cada organismo devuelto, devuelve: si es emisor, una lista con datos extendidos, si es externo, el código del organismo padre, la identidad fiscal, la fecha de alta, el nombre, el código del organismo, si es receptor y el nombre corto.
| Expand |
|---|
|
SignaturaResultOrganismList organismList(ParamOrganismList paramOrganismList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de objetos OrganismWithCode(ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISMLIST_00 | Error durante la consulta de los datos de organismos | | ORGANISMLIST_01 | El objeto paramOrganismList es nulo | | ORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | ORGANISMLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | ORGANISMLIST_04 | No existe el organismo de entrada |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismList param = new ParamOrganismList();
param.setApplicationId("SIU");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07839");
param.setOrganismSearch(organismSearch);
ResultOrganismListWithCode result = client.organismList(param);
|
|
...
De cada organismo devuelto, devuelve: si es emisor, una lista con datos extendidos, si es externo, el código del organismo padre, la identidad fiscal, la fecha de alta, el nombre, el código del organismo, si es receptor y el nombre corto.
| Expand |
|---|
|
SignaturaResultOrganismList organismList(ParamOrganismListWithComplexity paramOrganismListWithComplexity) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismSearch | Objeto OrganismSearchWithComplexity (ver detalle de campos en el apartado de objetos comunes) | | organismModeSearch | Objeto OrganismModeSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de objetos Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISMLIST_00 | Error durante la consulta de los datos de organismos | | ORGANISMLIST_01 | El objeto paramOrganismList es nulo | | ORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | ORGANISMLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | ORGANISMLIST_04 | No existe el organismo de entrada |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismListWithComplexity param = new ParamOrganismListWithComplexity();
param.setApplicationId("SIU");
OrganismSearchWithComplexity organismSearch = new OrganismSearchWithComplexity();
organismSearch.setOrganismCode("ORG07839");
param.setOrganismSearch(organismSearch);
ResultOrganismList result = client.organismList(param);
|
|
...
Si se informa el parámetro organismCode, que es opcional, busca el organismo raíz del árbol del organismo informado en organismCode, y consulta la información de los organismos filtrando por el árbol del organismo raíz encontrado y los códigos de organismo pasados en la lista que no estén dados de baja.
| Expand |
|---|
|
SignaturaResultOrganismListByOrganismCodes organismListByOrganismCodes(ParamOrganismListByOrganismCodes paramOrganismListByOrganismCodes) 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 | | organismCodeList | String[] | Lista de códigos de organismos |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismList | Lista de objetos Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISMLISTBYORGANISMCODES_00 | Código de error general para este servicio | | ORGANISMLISTBYORGANISMCODES_01 | El objeto paramOrganismListByOrganismCodes es nulo | | ORGANISMLISTBYORGANISMCODES_02 | La lista de organismos está vacía | | ORGANISMLISTBYORGANISMCODES_03 | No se han encontrado organismos para estos parámetros de búsqueda | | ORGANISMLISTBYORGANISMCODES_04 | El organismo introducido no existe | | ORGANISMLISTBYORGANISMCODES_05 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismListByOrganismCodes param = new ParamOrganismListByOrganismCodes();
param.setApplicationId("SIU");
String[] organismCodeList = { "ORG07839" };
param.setOrganismCodeList(organismCodeList);
ResultOrganismListByOrganismCodes result = client.organismListByOrganismCodes(param);
|
|
...
Servicio que devuelve un listado de organismos, independientemente de que se encuentren en estado alta o baja, buscando por un listado de códigos de organismos.
| Expand |
|---|
|
SignaturaResultOrganismListByOrganismCodesAll organismListByOrganismCodesAll(ParamOrganismListByOrganismCodesAll paramOrganismListByOrganismCodesAll) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | organismCodeList | String[] | Lista de códigos de organismos a consultar |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismList | Lista de objetos Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISMLISTBYORGANISMCODESALL_00 | Código de error general para este servicio | | ORGANISMLISTBYORGANISMCODESALL_01 | El objeto paramOrganismListByOrganismCodes es nulo | | ORGANISMLISTBYORGANISMCODESALL_02 | La lista de organismos está vacía | | ORGANISMLISTBYORGANISMCODESALL_03 | El campo applicationId está vacio | | ORGANISMLISTBYORGANISMCODESALL_04 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismListByOrganismCodesAll param = new ParamOrganismListByOrganismCodesAll();
param.setApplicationId("SIU");
String[] organismCodeList = { "ORG07839" };
param.setOrganismCodeList(organismCodeList);
ResultOrganismListByOrganismCodesAll result = client.organismListByOrganismCodesAll(param);
|
|
...
Servicio que devuelve una lista de organismos con el código DIR3 de cada organismo, según los parámetros de búsqueda introducidos. Además devuelve el tamaño de dicha lista.
| Expand |
|---|
|
SignaturaResultOrganismDir3List organismListWithDir3Code(ParamOrganismList paramOrganismList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de objetos Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISMLIST_00 | Error durante la consulta de los datos de organismos | | ORGANISMLIST_01 | El objeto paramOrganismList es nulo | | ORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | ORGANISMLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | ORGANISMLIST_04 | No existe el organismo de entrada |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismList param = new ParamOrganismList();
param.setApplicationId("SIU");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07839");
param.setOrganismSearch(organismSearch);
ResultOrganismDir3List result = client.organismListWithDir3Code(param);
|
|
...
Servicio que devuelve una lista de organismos ascendentes y descendentes de un organismo pasado como parámetro. Este listado se ordena por código de organismo.
| Expand |
|---|
|
SignaturaResultOrganismBranchTree organismTree(ParamOrganismBranchTree paramOrganismTree) 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 |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismList | Lista de objetos Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISMTREE_00 | Error durante la consulta de los datos de organismos | | ORGANISMTREE_01 | El objeto paramOrganismTree es nulo | | ORGANISMTREE_02 | No se han encontrado organismos para estos parámetros de búsqueda | | ORGANISMTREE_03 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamOrganismBranchTree param = new ParamOrganismBranchTree();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
ResultOrganismBranchTree result = client.organismBranchTree(param);
|
|
...
Servicio que devuelve un listado de organismos ancestros de un árbol de organismos según el organismo pasado como parámetro.
| Expand |
|---|
|
SignaturaResultTreeAncestralOrganismList treeAncestralOrganismList(ParamTreeAncestralOrganismList paramTreeAncestralOrganismList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | orgCode | String | Código de organismo |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismList | Lista de objetos Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| TREE_ANCESTRAL_ORGANISM_LIST_00 | Ha ocurrido algún error inesperado | | TREE_ANCESTRAL_ORGANISM_LIST_01 | El objeto paramAncestralOrganismTree es nulo | | TREE_ANCESTRAL_ORGANISM_LIST_02 | El código de organismo no puede ser nulo | | TREE_ANCESTRAL_ORGANISM_LIST_03 | Ha ocurrido algún tipo de error al realizar la búsqueda | | TREE_ANCESTRAL_ORGANISM_LIST_04 | No se han encontrado organismos con esos parámetros de búsqueda | | TREE_ANCESTRAL_ORGANISM_LIST_05 | El organismo no existe o está dado de baja |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamTreeAncestralOrganismList param = new ParamTreeAncestralOrganismList();
param.setApplicationId("SIU");
param.setOrgCode("ORG14685");
ResultTreeAncestralOrganismList result = client.treeAncestralOrganismList(param);
|
|
...
Servicio para obtener el organismo padre raíz del árbol al que pertenece un determinado organismo.
| Expand |
|---|
|
SignaturaResultRootOrganismByOrganismCode rootFatherOrganismByOrganismCode(ParamRootFatherOrganismByOrganismCode paramRootFatherOrganism) 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 |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organism | Objeto Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISMROOTFATHER_00 | Error durante la consulta de los datos del padre raíz del organismo | | ORGANISMROOTFATHER_01 | El objeto paramRootFatherOrganism es nulo | | ORGANISMROOTFATHER_02 | No existe el organismo del que se pretende averiguar la raíz | | ORGANISMROOTFATHER_03 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamRootFatherOrganismByOrganismCode param = new ParamRootFatherOrganismByOrganismCode();
param.setApplicationId("SIU");
param.setOrganismCode("ORG03324");
ResultRootOrganismByOrganismCode result = client.rootFatherOrganismByOrganismCode(param);
|
|
...
Servicio que devuelve una lista de organismos raíz.
| Expand |
|---|
|
SignaturaResultRootOrganismList rootFatherOrganismList(ParamRootFatherOrganismList paramRootFatherOrganismList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de objetos Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ORGANISMLIST_00 | Error durante la consulta de los datos de organismos | | ORGANISMLIST_01 | El objeto paramOrganismList es nulo | | ORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | ORGANISMLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | ORGANISMLIST_04 | No existe el organismo de entrada |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamRootFatherOrganismList param = new ParamRootFatherOrganismList();
param.setApplicationId("SIU");
ResultRootOrganismList result = client.rootFatherOrganismList(param);
|
|
...
Devuelve un listado de datos extendidos con nombre, código de organismo y valor.
| Expand |
|---|
|
SignaturaResultExtendedDataList extendedDataList(ParamExtendedDataList paramExtendedDataList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | extendedDataListSearch | Campos del objeto ExtendedDataListSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | extendedDataList | Lista de objetos ExtendedDataAndOrganismCode (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| EXTENDED_DATA_LIST_00 | Error durante la consulta de los datos extendidos | | EXTENDED_DATA_LIST_01 | El objeto paramExtendedDataList es nulo | | EXTENDED_DATA_LIST_02 | No se han encontrado datos extendidos para estos parámetros de búsqueda | | EXTENDED_DATA_LIST_03 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamExtendedDataList param = new ParamExtendedDataList();
param.setApplicationId("SIU");
ExtendedDataListSearch extendedDataListSearch = new ExtendedDataListSearch();
extendedDataListSearch.setOrganismCode("ORG14343");
param.setExtendedDataListSearch(extendedDataListSearch);
ResultExtendedDataList result = client.extendedDataList(param);
|
|
...
Servicio para listar las fechas históricas de cambios en la estructura de un organismo pasado como parámetro
| Expand |
|---|
|
SignaturaResultGetHistoricalDatesStructuralChanges getHistoricalDatesStructuralChanges(ParamGetHistoricalDatesStructuralChanges paramGetHistoricalDatesStructuralChanges) 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 |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | dateList | Date[] | Lista de fechas |
Códigos error
| Código | Descripción |
|---|
| GET_HISTORICAL_DATES_STRUCTURAL_CHANGES_00 | Error durante la consulta de fechas de cambios de estructura | | GET_HISTORICAL_DATES_STRUCTURAL_CHANGES_01 | El objeto paramGetHistoricalDatesStructuralChanges es nulo | | GET_HISTORICAL_DATES_STRUCTURAL_CHANGES_02 | El código de organismo es nulo | | GET_HISTORICAL_DATES_STRUCTURAL_CHANGES_03 | No se han encontrado fechas de cambios de estructura para estos parámetros de búsqueda | | GET_HISTORICAL_DATES_STRUCTURAL_CHANGES_04 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamGetHistoricalDatesStructuralChanges param = new ParamGetHistoricalDatesStructuralChanges();
param.setApplicationId("SIU");
param.setFiscalAnagram("");
param.setOrganismCode("ORG00002");
ResultGetHistoricalDatesStructuralChanges result = client.getHistoricalDatesStructuralChanges(param);
|
|
...
Para aquellas aplicaciones que utilicen un componente de identificación que te devuelva los datos del usuario identificado, como MFE, no requerirá el uso de este servicio.
| Expand |
|---|
|
SignaturaResultAutentify autentify(ParamAutentify paramAutentify) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | originalToken | String | Token original | | token (codificado en Base64) | String | Token firmado por el certificado del usuario | | organismCode | String | Código de organismo al que pertenece el usuario |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | user | Objeto User (ver detalle de campos en el apartado de objetos comunes) | | roles | Lista de objetos Role (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| AUTENTIFY_00 | Error durante la autentificación del usuario | | AUTENTIFY_01 | El parámetro de entrada token es nulo | | AUTENTIFY_02 | El parámetro de entrada organismCode es nulo | | AUTENTIFY_03 | Ha ocurrido algún error al verificar la firma | | AUTENTIFY_04 | El funcionario no existe en la bd | | AUTENTIFY_05 | El funcionario ha sido dado de baja de la bd | | AUTENTIFY_06 | El organismo no existe en la bd | | AUTENTIFY_07 | El funcionario no pertenece a ese organismo | | AUTENTIFY_08 | Ha ocurrido algún error al realizar la búsqueda | | AUTENTIFY_09 | El parámetro de entrada token original es nulo | | AUTENTIFY_10 | El organismo del que se quiere obtener la lista de usuarios esta dado de baja | | AUTENTIFY_11 | El objeto param es nulo | | AUTENTIFY_12 | El objeto fiscalAnagram es nulo |
Ejemplo de invocaciónNecesito datos con los que responda correctamente, con estos da error de validación de firma
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamAutentify param = new ParamAutentify();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07603");
param.setOriginalToken("RnJpIEp1biAwMiAxMjoxNTozOCBDRVNUIDIwMTc=");
param.setToken("MIIJHAYJKoZIhvcNAQcCoIIJDTCCCQkCAQExCzAJBgUrDgMCGgUAMCwGCSqGSIb3DQEHAaAfBB1GcmkgSnVuIDAyIDEyOjE1OjM4IENFU1QgMjAxN6CCBt4wggbaMIIFwqADAgECAhALHHnZXL7hM1c7OgLCQBD5MA0GCSqGSIb3DQEBCwUAMEsxCzAJBgNVBAYTAkVTMREwDwYDVQQKDAhGTk1ULVJDTTEOMAwGA1UECwwFQ2VyZXMxGTAXBgNVBAMMEEFDIEZOTVQgVXN1YXJpb3MwHhcNMTYwNTE3MTUzNDI2WhcNMjAwNTE3MTUzNDI2WjCBlzELMAkGA1UEBhMCRVMxEjAQBgNVBAUTCTAwMDAwMDAwVDEkMCIGA1UEBAwbQVBFTExJRE9VTk9QRiBBUEVMTElET0RPU1BGMRIwEAYDVQQqDAlQUlVFQkFTUEYxOjA4BgNVBAMMMUFQRUxMSURPVU5PUEYgQVBFTExJRE9ET1NQRiBQUlVFQkFTUEYgLSAwMDAwMDAwMFQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD7MWTTokoJ+rHRhvX5YWwOq4q9YmNUY9kAAfYGEZjqzDBJJpF55QJVQBmm2tCS2qobDPKjab7nnAwkKEbyVr1mp+1kZeZkHNb8HLXdVGQP/3yqRXPa0zjgqHkzVFjGnp+XZWoEOKkOveG7NeFEDPve1oEelvkWOu2xdWHkrwlD8tmpf8lYwrGY0KgeJ6soVaNils1zUTJiSHaYJOj/6Q6rxWaOTdeVALYZQdld1UAO6gQk4khlgM4ntfSerJxF6it4dic+RH36Bw2UvgoDOWkYdtSOldC0cRa6BEazjGN5NTdrC97eSooMTKldk4KqY3lmM9Qhjq+Ns6s2Hi4qv7pAgMBAAGjggNrMIIDZzCBngYDVR0RBIGWMIGTgR1zb3BvcnRlX3RlY25pY29fY2VyZXNAZm5tdC5lc6RyMHAxGDAWBgkrBgEEAaxmAQQMCTAwMDAwMDAwVDEcMBoGCSsGAQQBrGYBAwwNQVBFTExJRE9ET1NQRjEcMBoGCSsGAQQBrGYBAgwNQVBFTExJRE9VTk9QRjEYMBYGCSsGAQQBrGYBAQwJUFJVRUJBU1BGMAwGA1UdEwEB/wQCMAAwDgYDVR0PAQH/BAQDAgXgMCMGA1UdJQQcMBoGCCsGAQUFBwMEBggrBgEFBQcDAgYEVR0lADAdBgNVHQ4EFgQUdUM+b0A9jn/Xg1shAB2DvKNl8CIwHwYDVR0jBBgwFoAUsdRPxCN5+kQFCcbrOc/oNbC4IGQwgYIGCCsGAQUFBwEBBHYwdDA9BggrBgEFBQcwAYYxaHR0cDovL29jc3B1c3UuY2VydC5mbm10LmVzL29jc3B1c3UvT2NzcFJlc3BvbmRlcjAzBggrBgEFBQcwAoYnaHR0cDovL3d3dy5jZXJ0LmZubXQuZXMvY2VydHMvQUNVU1UuY3J0MIHdBgNVHSAEgdUwgdIwgc8GCisGAQQBrGYDCgEwgcAwKQYIKwYBBQUHAgEWHWh0dHA6Ly93d3cuY2VydC5mbm10LmVzL2RwY3MvMIGSBggrBgEFBQcCAjCBhQyBgkNlcnRpZmljYWRvIHJlY29ub2NpZG8uIFN1amV0byBhIGxhcyBjb25kaWNpb25lcyBkZSB1c28gZXhwdWVzdGFzIGVuIGxhIERQQyBkZSBsYSBGTk1ULVJDTSAoQy9Kb3JnZSBKdWFuIDEwNi0yODAwOS1NYWRyaWQtRXNwYcOxYSkwJQYIKwYBBQUHAQMEGTAXMAgGBgQAjkYBATALBgYEAI5GAQMCAQ8wgbQGA1UdHwSBrDCBqTCBpqCBo6CBoIaBnWxkYXA6Ly9sZGFwdXN1LmNlcnQuZm5tdC5lcy9jbj1DUkw2MTMsY249QUMlMjBGTk1UJTIwVXN1YXJpb3Msb3U9Q0VSRVMsbz1GTk1ULVJDTSxjPUVTP2NlcnRpZmljYXRlUmV2b2NhdGlvbkxpc3Q7YmluYXJ5P2Jhc2U/b2JqZWN0Y2xhc3M9Y1JMRGlzdHJpYnV0aW9uUG9pbnQwDQYJKoZIhvcNAQELBQADggEBAAIBhHK4PDGkXN9Iy1/alz+kfSSP96qyiGYGVY6xLjUUUTITy8mSwOhDKT8K5I+OfLVI8Kql//EYsa1Dt2DB7g8c+QU3uxQeMXAH9p6tj8HVJB//NEwpP5RN3wB8Y6KNZeUx7k8+ZjGVFHz9uW3dsKJJL/q13I4q7vsqGWCSUEjJcNdNSn0J1GEPQ2wD4vSe8dsPhnmFz1g+MMaWBugwGkhXVgJDoMlBwQmhw/IvtKJtfUC93WaWAlVbCcbEzH1aBYRZS/WPcjV4dnD3F3lX/qnR71VuwwlX8m0zc5Xg4DdQY5JMmxapqEmDi6uoC0HufP5/coqFsR/5vlOLoX1OO7cxggHlMIIB4QIBATBfMEsxCzAJBgNVBAYTAkVTMREwDwYDVQQKDAhGTk1ULVJDTTEOMAwGA1UECwwFQ2VyZXMxGTAXBgNVBAMMEEFDIEZOTVQgVXN1YXJpb3MCEAscedlcvuEzVzs6AsJAEPkwCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE3MDYwMjEwMTc1NFowIwYJKoZIhvcNAQkEMRYEFJNz8UKjAYtsK9uVO+9vMzKNSu8aMA0GCSqGSIb3DQEBAQUABIIBAIjSakF1fROtYuyj21OTCJS8+Dm7qkYnuReBsBFDqnmtx7a2SbNeNqlLfx/TaL1EwWOeLow5/DFrZI8vKSsDo4UTQE4v5mT5QhwCrGmkRfZCZisDJj7gphPjuEfIU7tDs853jmqWqOtWoSzmJgdmPDfLgIid2lpRziqMMWuJDXbmwSPrEsyGvuIihrZfBlG5JJEMQTZ9rIcQRcK9Xw02NftCoLweju2No1jsssOzezm6lZ5TAqiVCS98fyGFWjBunuVC3/X3kxsa7OXEYd5UMxvyQ2CmxoPsnXn0oPnxkysZ2N9AHSpbMPSXvW5fBN8NJ9FpS/Q/GkI4DH+qImFqUSE=");
ResultAutentify result = client.autentify(param);
|
|
...
Devuelve la información del usuario y de los roles que tiene ese usuario.
| Expand |
|---|
|
SignaturaResultAutentify autentify(ParamAutentifyWithFiscalAnagram paramAutentifyWithFiscalAnagram) 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 al que pertenece el usuario |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | user | Objeto User (ver detalle de campos en el apartado de objetos comunes) | | roles | Lista de objetos Role (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| AUTENTIFY_00 | Error durante la autentificación del usuario | | AUTENTIFY_01 | El parámetro de entrada token es nulo | | AUTENTIFY_02 | El parámetro de entrada organismCode es nulo | | AUTENTIFY_03 | Ha ocurrido algún error al verificar la firma | | AUTENTIFY_04 | El funcionario no existe en la bd | | AUTENTIFY_05 | El funcionario ha sido dado de baja de la bd | | AUTENTIFY_06 | El organismo no existe en la bd | | AUTENTIFY_07 | El funcionario no pertenece a ese organismo | | AUTENTIFY_08 | Ha ocurrido algún error al realizar la búsqueda | | AUTENTIFY_09 | El parámetro de entrada token original es nulo | | AUTENTIFY_10 | El organismo del que se quiere obtener la lista de usuarios esta dado de baja | | AUTENTIFY_11 | El objeto param es nulo | | AUTENTIFY_12 | El objeto fiscalAnagram es nulo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamAutentifyWithFiscalAnagram param = new ParamAutentifyWithFiscalAnagram();
param.setApplicationId("SIU");
param.setFiscalAnagram("00000000T");
param.setOrganismCode("ORG07603");
ResultAutentify result = client.autentify(param);
|
|
...
Para aquellas aplicaciones que utilicen un componente de identificación que te devuelva los datos del usuario identificado, como MFE, no requerirá el uso de este servicio.
| Expand |
|---|
|
SignaturaResultAutentify autentify(ParamAutentifyWithoutOrganism paramAutentifyWithoutOrganism) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | token | String | Token firmado por el certificado del usuario | | originalToken | String | Token original |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | user | Objeto User (ver detalle de campos en el apartado de objetos comunes) | | roles | Lista de objetos Role (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| AUTENTIFY_00 | Error durante la autentificación del usuario | | AUTENTIFY_01 | El parámetro de entrada token es nulo | | AUTENTIFY_02 | El parámetro de entrada organismCode es nulo | | AUTENTIFY_03 | Ha ocurrido algún error al verificar la firma | | AUTENTIFY_04 | El funcionario no existe en la bd | | AUTENTIFY_05 | El funcionario ha sido dado de baja de la bd | | AUTENTIFY_06 | El organismo no existe en la bd | | AUTENTIFY_07 | El funcionario no pertenece a ese organismo | | AUTENTIFY_08 | Ha ocurrido algún error al realizar la búsqueda | | AUTENTIFY_09 | El parámetro de entrada token original es nulo | | AUTENTIFY_10 | El organismo del que se quiere obtener la lista de usuarios esta dado de baja | | AUTENTIFY_11 | El objeto param es nulo | | AUTENTIFY_12 | El objeto fiscalAnagram es nulo |
Ejemplo de invocaciónNecesito datos con los que responda correctamente, con estos da error de validación de firma | Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamAutentifyWithoutOrganism param = new ParamAutentifyWithoutOrganism();
param.setApplicationId("SIU");
param.setOriginalToken("RnJpIEp1biAwMiAxMjoxNTozOCBDRVNUIDIwMTc=");
param.setToken("MIIJHAYJKoZIhvcNAQcCoIIJDTCCCQkCAQExCzAJBgUrDgMCGgUAMCwGCSqGSIb3DQEHAaAfBB1GcmkgSnVuIDAyIDEyOjE1OjM4IENFU1QgMjAxN6CCBt4wggbaMIIFwqADAgECAhALHHnZXL7hM1c7OgLCQBD5MA0GCSqGSIb3DQEBCwUAMEsxCzAJBgNVBAYTAkVTMREwDwYDVQQKDAhGTk1ULVJDTTEOMAwGA1UECwwFQ2VyZXMxGTAXBgNVBAMMEEFDIEZOTVQgVXN1YXJpb3MwHhcNMTYwNTE3MTUzNDI2WhcNMjAwNTE3MTUzNDI2WjCBlzELMAkGA1UEBhMCRVMxEjAQBgNVBAUTCTAwMDAwMDAwVDEkMCIGA1UEBAwbQVBFTExJRE9VTk9QRiBBUEVMTElET0RPU1BGMRIwEAYDVQQqDAlQUlVFQkFTUEYxOjA4BgNVBAMMMUFQRUxMSURPVU5PUEYgQVBFTExJRE9ET1NQRiBQUlVFQkFTUEYgLSAwMDAwMDAwMFQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD7MWTTokoJ+rHRhvX5YWwOq4q9YmNUY9kAAfYGEZjqzDBJJpF55QJVQBmm2tCS2qobDPKjab7nnAwkKEbyVr1mp+1kZeZkHNb8HLXdVGQP/3yqRXPa0zjgqHkzVFjGnp+XZWoEOKkOveG7NeFEDPve1oEelvkWOu2xdWHkrwlD8tmpf8lYwrGY0KgeJ6soVaNils1zUTJiSHaYJOj/6Q6rxWaOTdeVALYZQdld1UAO6gQk4khlgM4ntfSerJxF6it4dic+RH36Bw2UvgoDOWkYdtSOldC0cRa6BEazjGN5NTdrC97eSooMTKldk4KqY3lmM9Qhjq+Ns6s2Hi4qv7pAgMBAAGjggNrMIIDZzCBngYDVR0RBIGWMIGTgR1zb3BvcnRlX3RlY25pY29fY2VyZXNAZm5tdC5lc6RyMHAxGDAWBgkrBgEEAaxmAQQMCTAwMDAwMDAwVDEcMBoGCSsGAQQBrGYBAwwNQVBFTExJRE9ET1NQRjEcMBoGCSsGAQQBrGYBAgwNQVBFTExJRE9VTk9QRjEYMBYGCSsGAQQBrGYBAQwJUFJVRUJBU1BGMAwGA1UdEwEB/wQCMAAwDgYDVR0PAQH/BAQDAgXgMCMGA1UdJQQcMBoGCCsGAQUFBwMEBggrBgEFBQcDAgYEVR0lADAdBgNVHQ4EFgQUdUM+b0A9jn/Xg1shAB2DvKNl8CIwHwYDVR0jBBgwFoAUsdRPxCN5+kQFCcbrOc/oNbC4IGQwgYIGCCsGAQUFBwEBBHYwdDA9BggrBgEFBQcwAYYxaHR0cDovL29jc3B1c3UuY2VydC5mbm10LmVzL29jc3B1c3UvT2NzcFJlc3BvbmRlcjAzBggrBgEFBQcwAoYnaHR0cDovL3d3dy5jZXJ0LmZubXQuZXMvY2VydHMvQUNVU1UuY3J0MIHdBgNVHSAEgdUwgdIwgc8GCisGAQQBrGYDCgEwgcAwKQYIKwYBBQUHAgEWHWh0dHA6Ly93d3cuY2VydC5mbm10LmVzL2RwY3MvMIGSBggrBgEFBQcCAjCBhQyBgkNlcnRpZmljYWRvIHJlY29ub2NpZG8uIFN1amV0byBhIGxhcyBjb25kaWNpb25lcyBkZSB1c28gZXhwdWVzdGFzIGVuIGxhIERQQyBkZSBsYSBGTk1ULVJDTSAoQy9Kb3JnZSBKdWFuIDEwNi0yODAwOS1NYWRyaWQtRXNwYcOxYSkwJQYIKwYBBQUHAQMEGTAXMAgGBgQAjkYBATALBgYEAI5GAQMCAQ8wgbQGA1UdHwSBrDCBqTCBpqCBo6CBoIaBnWxkYXA6Ly9sZGFwdXN1LmNlcnQuZm5tdC5lcy9jbj1DUkw2MTMsY249QUMlMjBGTk1UJTIwVXN1YXJpb3Msb3U9Q0VSRVMsbz1GTk1ULVJDTSxjPUVTP2NlcnRpZmljYXRlUmV2b2NhdGlvbkxpc3Q7YmluYXJ5P2Jhc2U/b2JqZWN0Y2xhc3M9Y1JMRGlzdHJpYnV0aW9uUG9pbnQwDQYJKoZIhvcNAQELBQADggEBAAIBhHK4PDGkXN9Iy1/alz+kfSSP96qyiGYGVY6xLjUUUTITy8mSwOhDKT8K5I+OfLVI8Kql//EYsa1Dt2DB7g8c+QU3uxQeMXAH9p6tj8HVJB//NEwpP5RN3wB8Y6KNZeUx7k8+ZjGVFHz9uW3dsKJJL/q13I4q7vsqGWCSUEjJcNdNSn0J1GEPQ2wD4vSe8dsPhnmFz1g+MMaWBugwGkhXVgJDoMlBwQmhw/IvtKJtfUC93WaWAlVbCcbEzH1aBYRZS/WPcjV4dnD3F3lX/qnR71VuwwlX8m0zc5Xg4DdQY5JMmxapqEmDi6uoC0HufP5/coqFsR/5vlOLoX1OO7cxggHlMIIB4QIBATBfMEsxCzAJBgNVBAYTAkVTMREwDwYDVQQKDAhGTk1ULVJDTTEOMAwGA1UECwwFQ2VyZXMxGTAXBgNVBAMMEEFDIEZOTVQgVXN1YXJpb3MCEAscedlcvuEzVzs6AsJAEPkwCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE3MDYwMjEwMTc1NFowIwYJKoZIhvcNAQkEMRYEFJNz8UKjAYtsK9uVO+9vMzKNSu8aMA0GCSqGSIb3DQEBAQUABIIBAIjSakF1fROtYuyj21OTCJS8+Dm7qkYnuReBsBFDqnmtx7a2SbNeNqlLfx/TaL1EwWOeLow5/DFrZI8vKSsDo4UTQE4v5mT5QhwCrGmkRfZCZisDJj7gphPjuEfIU7tDs853jmqWqOtWoSzmJgdmPDfLgIid2lpRziqMMWuJDXbmwSPrEsyGvuIihrZfBlG5JJEMQTZ9rIcQRcK9Xw02NftCoLweju2No1jsssOzezm6lZ5TAqiVCS98fyGFWjBunuVC3/X3kxsa7OXEYd5UMxvyQ2CmxoPsnXn0oPnxkysZ2N9AHSpbMPSXvW5fBN8NJ9FpS/Q/GkI4DH+qImFqUSE=");
ResultAutentify result = client.autentify(param);
|
|
...
Servicio que devuelve los datos de los cargos activos de un organismo.
| Expand |
|---|
|
SignaturaResultRoleListByOrganismCode activeRoleListByOrganismCode(ParamRoleListByOrganismCode paramRoleListByOrganismCode) 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 |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | roles | Lista de objetos RoleWithRoleTypeCode (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ROLELISTBYORGANISMCODE_00 | Error durante la consulta de los datos de cargos | | ROLELISTBYORGANISMCODE_01 | El objeto paramRoleListByOrganismCode es nulo | | ROLELISTBYORGANISMCODE_03 | El organismo no tiene roles | | ROLELISTBYORGANISMCODE_03 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| aramRoleListByOrganismCode param = new ParamRoleListByOrganismCode();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07603");
ResultRoleListByOrganismCode result = client.activeRoleListByOrganismCode(param);
|
|
...
Devuelve también el tamaño del resultado de cargos encontrados.
| Expand |
|---|
|
SignaturaResultRoleList roleList(ParamRoleList paramRoleList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | roleSearch | Objeto RoleSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | roles | Lista de objetos Role (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ROLELIST_00 | Error durante la consulta de los datos de cargos | | ROLELIST_01 | El objeto paramRoleList es nulo | | ROLELIST_02 | No se han encontrado cargos para estos parámetros de búsqueda | | ROLELIST_03 | Ha ocurrido algún error al realizar la búsqueda | | ROLELIST_04 | El código de organismo es nulo | | ROLELIST_05 | El organismo no existe en la base de datos | | ROLELIST_06 | El organismo esta dado de baja en la base de datos |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamRoleList param = new ParamRoleList();
param.setApplicationId("SIU");
RoleSearch roleSearch = new RoleSearch();
roleSearch.setFiscalAnagram("00000000T");
param.setRoleSearch(roleSearch);
ResultRoleList result = client.roleList(param);
|
|
...
Servicio que devuelve un listado de roles de un organismo y sus descendientes.
| Expand |
|---|
|
SignaturaResultRoleList roleList(ParamRoleListByDescendentOrganism paramRoleListByDescendentOrganism) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | roleSearch | Objeto RoleSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | roles | Lista de objetos Role (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ROLELIST_00 | Error durante la consulta de los datos de cargos | | ROLELIST_01 | El objeto paramRoleList es nulo | | ROLELIST_02 | No se han encontrado cargos para estos parámetros de búsqueda | | ROLELIST_03 | Ha ocurrido algún error al realizar la búsqueda | | ROLELIST_04 | El código de organismo es nulo | | ROLELIST_05 | El organismo no existe en la base de datos | | ROLELIST_06 | El organismo esta dado de baja en la base de datos |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| aramRoleListByDescendentOrganism param = new ParamRoleListByDescendentOrganism();
param.setApplicationId("SIU");
RoleSearch roleSearch = new RoleSearch();
roleSearch.setFiscalAnagram("00000000T");
roleSearch.setOrganismCode("ORG14685");
param.setRoleSearch(roleSearch);
ResultRoleList result = client.roleList(param);
|
|
...
En caso de que de uno de los usuarios consultados no encuentre resultados, pero de otro si, en el apartado del usuario cuyos cargos no se han encontrado devolverá un error. En el apartado correspondiente al usuario que si se han encontrado cargos, devolverá la información de los cargos encontrada.
| Expand |
|---|
|
SignaturaResultRoleListByFiscalAnagrams roleListByFiscalAnagrams(ParamRoleListByFiscalAnagrams paramRoleListByFiscalAnagrams) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagramList | String[] | Lista de códigos de anagramas fiscales |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de usuarios devuelta | | roleListByUser | Lista de objetos RoleListByFiscalAnagram (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ROLELISTBYFISCALANAGRAMS_00 | Código de error general para este servicio | | ROLELISTBYFISCALANAGRAMS_01 | El objeto paramRoleListByFiscalAmagrams es nulo | | ROLELISTBYFISCALANAGRAMS_02 | La lista de fiscal_anagram está vacía | | ROLELISTBYFISCALANAGRAMS_03 | El campo applicationId está vacio | | ROLELISTBYFISCALANAGRAMS_04 | No hay roles con ese fiscal_anagram |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamRoleListByFiscalAnagrams param = new ParamRoleListByFiscalAnagrams();
param.setApplicationId("SIU");
String[] fiscalAnagramList = { "11223344B" };
param.setFiscalAnagramList List(fiscalAnagramList );
ResultOrganismListByOrganismCodesAll result = client.roleListByFiscalAnagrams(param);
|
|
...
Servicio que devuelve un listado de los cargos con el tipo de cargo, de un organismo.
| Expand |
|---|
|
SignaturaResultRoleListByOrganismCode roleListByOrganismCode(ParamRoleListByOrganismCode paramRoleListByOrganismCode) 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 |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | roles | Lista de objetos RoleWithRoleTypeCode (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ROLELISTBYORGANISMCODE_00 | Error durante la consulta de los datos de cargos | | ROLELISTBYORGANISMCODE_01 | El objeto paramRoleListByOrganismCode es nulo | | ROLELISTBYORGANISMCODE_03 | El organismo no tiene roles | | ROLELISTBYORGANISMCODE_03 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamRoleListByOrganismCode param = new ParamRoleListByOrganismCode();
param.setApplicationId("SIU");
param.setOrganismCode("ORG14685");
ResultRoleListByOrganismCode result = client.roleListByOrganismCode(param);
|
|
...
Servicio que devuelve un listado de roles de un organismo activo y sus descendientes filtrando mediante una lista de nifs.
| Expand |
|---|
|
SignaturaResultRoleListByOrganismdescendantBranchInUserList roleListByOrganismdescendantBranchInUserList(ParamRoleListByOrganismdescendantBranchInUserList paramRoleListByOrganismdescendantBranchInUserList) 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 | | nifs | String[] | Lista de nifs | | roleSearch | Objeto RoleSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | roles | Lista de objetos Role (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ROLELIST_BY_ORGANISM_DESCENDENT_IN_USER_LIST_00 | Error durante la consulta de los datos de cargos | | ROLELIST_BY_ORGANISM_DESCENDENT_IN_USER_LIST_01 | El objeto paramRoleListByOrganismdescendantBranchInUserList es nulo | | ROLELIST_BY_ORGANISM_DESCENDENT_IN_USER_LIST_02 | No se han encontrado cargos para estos parámetros de búsqueda | | ROLELIST_BY_ORGANISM_DESCENDENT_IN_USER_LIST_03 | Ha ocurrido algún error al realizar la búsqueda | | ROLELIST_BY_ORGANISM_DESCENDENT_IN_USER_LIST_04 | El código de organismo es nulo | | ROLELIST_BY_ORGANISM_DESCENDENT_IN_USER_LIST_05 | El organismo no existe en la base de datos | | ROLELIST_BY_ORGANISM_DESCENDENT_IN_USER_LIST_06 | El organismo esta dado de baja en la base de datos | | ROLELIST_BY_ORGANISM_DESCENDENT_IN_USER_LIST_07 | La lista de nifs es nula o esta vacía |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamRoleListByOrganismdescendantBranchInUserList param = new ParamRoleListByOrganismdescendantBranchInUserList();
param.setApplicationId("SIU");
String[] lstNifs = { "00000000T" };
param.setNifs(lstNifs);
param.setOrganismCode("ORG00001");
ResultRoleListByOrganismdescendantBranchInUserList result = client.roleListByOrganismdescendantBranchInUserList(param);
|
|
...
Servicio que devuelve un listado de roles incluyendo el campo roleTypeCode que cumplen una serie de parámetros de búsqueda.
| Expand |
|---|
|
SignaturaResultRoleListWithRoleTypeCode roleListWithRoleTypeCode(ParamRoleListWithRoleTypeCode paramRoleListWithRoleTypeCode) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | roleSearchWithRoleTypeCode | Objeto RoleSearchWithRoleTypeCode (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | roles | Lista de objetos RoleWithRoleTypeCode (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ROLELISTWITHROLETYPECODE_00 | Error durante la consulta de los datos de cargos | | ROLELISTWITHROLETYPECODE_01 | El objeto paramRoleListWithRoleTypeCode es nulo | | ROLELISTWITHROLETYPECODE_02 | Ha ocurrido algún error al realizar la búsqueda | | ROLELIST_02 | No se han encontrado cargos para estos parámetros de búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamRoleListWithRoleTypeCode param = new ParamRoleListWithRoleTypeCode();
param.setApplicationId("SIU");
RoleSearchWithRoleTypeCode roleSearchWithRoleTypeCode = new RoleSearchWithRoleTypeCode();
roleSearchWithRoleTypeCode.setOrganismCode("ORG14685");
roleSearchWithRoleTypeCode.setRoleCode("ROL50563");
roleSearchWithRoleTypeCode.setRoleTypeCode(new Long(1));
param.setRoleSearchWithRoleTypeCode(roleSearchWithRoleTypeCode);
ResultRoleListWithRoleTypeCode result = client.roleListWithRoleTypeCode(param);
|
|
...
Servicio que devuelve un listado de roles según los parámetros de búsqueda introducidos.
| Expand |
|---|
|
SignaturaResultRoleTypeList roleTypeList(ParamRoleTypeList paramRoleTypeList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | roleTypeSearch | Objeto RoleTypeSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | rolesType | Lista de objetos RoleType (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ROLETYPELIST_00 | Error durante la consulta de los datos de cargos | | ROLETYPELIST_01 | El objeto paramRoleTypeList es nulo | | ROLETYPELIST_02 | No se han encontrado cargos para estos parámetros de búsqueda | | ROLETYPELIST_03 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamRoleTypeList param = new ParamRoleTypeList();
param.setApplicationId("SIU");
RoleTypeSearch roleTypeSearch = new RoleTypeSearch();
param.setRoleTypeSearch(roleTypeSearch);
ResultRoleTypeList result = client.roleTypeList(param);
|
|
...
De cada usuario devuelto, devuelve email, anagrama fiscal, nombre, nif, estado, apellidos, una lista con información de los organismos a los que pertenece ese usuario y una lista con información de los roles del usuario.
| Expand |
|---|
|
SignaturaResultGetUserInformation getUserInformation(ParamGetUserInformation paramGetUserInformation) 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 | | roleCode | String | Código de rol | | userSearch | Objeto UserSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userInfoList | Lista de objetos UserInformation (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| GET_USER_INFORMATION_00 | Error durante la consulta de los datos de funcionarios | | GET_USER_INFORMATION_01 | El objeto ParamGetUserInformation es nulo | | GET_USER_INFORMATION_02 | El objeto User es nulo | | GET_USER_INFORMATION_03 | Datos obligatorios: nombre de usuario y primer apellido, o bien el nif o la dirección de correo del usuario | | GET_USER_INFORMATION_04 | El organismo introducido no existe o esta dado de baja en la base de datos | | GET_USER_INFORMATION_05 | Error en la búsqueda de roles | | GET_USER_INFORMATION_06 | No se han encontrado usuarios para estos parámetros de búsqueda | | GET_USER_INFORMATION_07 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamGetUserInformation param = new ParamGetUserInformation();
param.setApplicationId("SIU");
UserSearch search = new UserSearch();
search.setNif("00000000T");
param.setUserSearch(search);
ResultGetUserInformation result = client.getUserInformation(param);
|
|
...
De cada usuario devuelto, devuelve email, anagrama fiscal, nombre, nif, estado, apellidos, una lista con información de los organismos a los que pertenece ese usuario, una lista con información de los puestos del usuario y una lista de la asociación del usuario con esos puestos.
| Expand |
|---|
|
SignaturaResultGetUserInformationJobs getUserInformationJobs(ParamGetUserInformationJobs paramGetUserInformationJobs) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal del usuario a consultar |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userJobInformation | objeto UserJobInformation(ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| GET_USERJOBS_INFORMATION_00 | Error durante la consulta de los datos | | GET_USER_INFORMATION_01 | El objeto ParamGetUserInformationJob es nulo | | GET_USER_INFORMATION_01 | Datos obligatorios: fiscal anagram del usuario |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamGetUserInformationJobs param = new ParamGetUserInformationJobs();
param.setApplicationId("SIU");
param.setFiscalAnagram("00000000T");
ResultGetUserInformationJobsresult = client.getUserInformationJobs(param);
|
|
...
Permite filtrar por código del puesto, descripción. puesto del que depende, fecha de inicio, fecha de cese, comentario interno, unidad orgánica, unidad de gestión, rpt, si está en frh y el nif del empleado.
| Expand |
|---|
|
SignaturaResultGetUserJobs getUserJobs(ParamGetUserJobs paramGetUserJobs) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | userJobSearch | Objeto UserJobSearch(ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | jobList | Listado de objetos UserJobRolesV (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| GET_USERJOBS_00 | Error durante la consulta | | GET_USERJOBS_01 | El objeto ParamGetUserJobs es nulo | | GET_USERJOBS_02 | El objeto UserJobSearch es nulo | | GET_USERJOBS_03 | Datos obligatorios: al marcar el check de buscar por descendientes, tiene que rellenarse alguna de las unidades |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamGetUserJobs param = new ParamGetUserJobs();
param.setApplicationId("SIU");
UserJobSearch userJobSearch = new UserJobSearch();
userJobSearch.setCheckDescendant(0);
userJobSearch.setIsfrh(2);
paramGetUserJobs.setUserJobSearch(userJobSearch);
ResultGetUserJobs result = client.getUserJobs(param);
|
|
...
Servicio que devuelve un listado de usuarios. Permite filtrar pasando parámetros de búsqueda pero no es necesario.
| Expand |
|---|
|
SignaturaResultUserList userList(ParamUserList paramUserList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | userSearch | Objeto UserSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userList | Lista de objetos User (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| USERLIST_00 | Error durante la consulta de los datos de funcionarios | | USERLIST_01 | El objeto paramUserList es nulo | | USERLIST_02 | No se han encontrado funcionarios para estos parámetros de búsqueda | | USERLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | USERLIST_04 | El código del organismo no puede estar vacío | | USERLIST_05 | No existe el organismo del que se quiere obtener la lista de usuarios | | USERLIST_06 | El organismo del que se quiere obtener la lista de usuarios esta dado de baja | | USERLIST_07 | No existen usuarios para ese organismo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamUserList param = new ParamUserList();
param.setApplicationId("SIU");
UserSearch userSearch = new UserSearch();
userSearch.setNif("00000000T");
param.setUserSearch(userSearch);
ResultUserList result = client.userList(param);
|
|
...
Servicio que devuelve un listado de usuarios filtrando por un organismo pasado como parámetro.
| Expand |
|---|
|
SignaturaResultUserList userList(ParamUserListByOrganism paramUserListByOrganism) 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 | | userSearch | Objeto UserSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userList | Lista de objetos User (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| USERLIST_00 | Error durante la consulta de los datos de funcionarios | | USERLIST_01 | El objeto paramUserList es nulo | | USERLIST_02 | No se han encontrado funcionarios para estos parámetros de búsqueda | | USERLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | USERLIST_04 | El código del organismo no puede estar vacío | | USERLIST_05 | No existe el organismo del que se quiere obtener la lista de usuarios | | USERLIST_06 | El organismo del que se quiere obtener la lista de usuarios esta dado de baja | | USERLIST_07 | No existen usuarios para ese organismo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamUserListByOrganism param = new ParamUserListByOrganism();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07603");
UserSearch userSearch = new UserSearch();
userSearch.setNif("00000000T");
param.setUserSearch(userSearch);
ResultUserList result = client.userList(param);
|
|
...
Servicio que devuelve una lista de usuarios correspondientes a un organismo.
| Expand |
|---|
|
SignaturaResultUserListWithPhone userList(ParamUserListByOrganismWithPhone paramUserListByOrganism) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | userSearchWithPhone | Objeto UserSearchWithPhone (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userList | Lista de objetos UserWithPhone (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| USERLIST_00 | Error durante la consulta de los datos de funcionarios | | USERLIST_01 | El objeto paramUserList es nulo | | USERLIST_02 | No se han encontrado funcionarios para estos parámetros de búsqueda | | USERLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | USERLIST_04 | El código del organismo no puede estar vacío | | USERLIST_05 | No existe el organismo del que se quiere obtener la lista de usuarios | | USERLIST_06 | El organismo del que se quiere obtener la lista de usuarios esta dado de baja | | USERLIST_07 | No existen usuarios para ese organismo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamUserListByOrganismWithPhone param = new ParamUserListByOrganismWithPhone();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
UserSearchWithPhone userSearch = new UserSearchWithPhone();
param.setUserSearchWithPhone(userSearch);
ResultUserListWithPhone result = client.userList(param);
|
|
...
Devuelve igualmente el tamaño de usuarios encontrados.
| Expand |
|---|
|
SignaturaResultUserListWithPhone userList(ParamUserListWithPhone paramUserListWithPhone) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | userSearch | Objeto UserSearchWithPhone (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userList | Lista de objetos UserWithPhone (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| USERLIST_00 | Error durante la consulta de los datos de funcionarios | | USERLIST_01 | El objeto paramUserList es nulo | | USERLIST_02 | No se han encontrado funcionarios para estos parámetros de búsqueda | | USERLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | USERLIST_04 | El código del organismo no puede estar vacío | | USERLIST_05 | No existe el organismo del que se quiere obtener la lista de usuarios | | USERLIST_06 | El organismo del que se quiere obtener la lista de usuarios esta dado de baja | | USERLIST_07 | No existen usuarios para ese organismo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamUserListWithPhone param = new ParamUserListWithPhone();
param.setApplicationId("SIU");
UserSearchWithPhone userSearch = new UserSearchWithPhone();
userSearch.setNif("00000000T");
param.setUserSearch(userSearch);
ResultUserListWithPhone result = client.userList(param);
|
|
...
Servicio que devuelve una lista de usuarios de un organismo ancestro pasado como parámetro y de todos sus hijos.
| Expand |
|---|
|
SignaturaResultUserListByAncestralOrganism userListByAncestralOrganism(ParamUserListByAncestralOrganism paramUserListByAncestralOrganism) 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 | | userSearch | Objeto UserSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userList | Lista de objetos User (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| USERLISTBYANCESTRALORGANISM_00 | Error durante la consulta de los usuarios de un organismo ancestro | | ORGANISMLISTBYANCESTRALORGANIM_01 | El objeto paramUserListByAncestralOrganism es nulo | | ORGANISMLISTBYANCESTRALORGANIM_02 | El código del organismo ancestro no puede estar vacío | | ORGANISMLISTBYANCESTRALORGANIM_03 | No existe el organismo ancestro del cual se pretenden obtener los código de sus descendientes | | ORGANISMLISTBYANCESTRALORGANIM_04 | El organismo está dado de baja | | ORGANISMLISTBYANCESTRALORGANIM_05 | No se han encontrado funcionarios para estos parámetros de búsqueda | | ORGANISMLISTBYANCESTRALORGANIM_06 | No existe el organismo ancestro del que se quiere obtener la lista de usuarios | | ORGANISMLISTBYANCESTRALORGANIM_07 | El organismo ancestro del que se quiere obtener la lista de usuarios esta dado de baja | | ORGANISMLISTBYANCESTRALORGANIM_08 | Ha habido un problema al recuperar los organismos para buscar roles | | ORGANISMLISTBYANCESTRALORGANIM_09 | Ha habido un problema al recuperar los roles para buscar usuarios |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamUserListByAncestralOrganism param = new ParamUserListByAncestralOrganism();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
UserSearch userSearch = new UserSearch();
param.setUserSearch(userSearch);
ResultUserListByAncestralOrganism result = client.userListByAncestralOrganism(param);
|
|
...
Servicio que devuelve un listado de usuarios de un organismo ancestro y sus hijos.
| Expand |
|---|
|
SignaturaResultUserListByAncestralOrganismWithPhone userListByAncestralOrganism(ParamUserListByAncestralOrganismWithPhone paramUserListByAncestralOrganism) 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 | | userSearchWithPhone | Objeto UserSearchWithPhone (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userListWithPhone | Lista de objetos UserWithPhone (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| USERLISTBYANCESTRALORGANISM_00 | Error durante la consulta de los usuarios de un organismo ancestro | | ORGANISMLISTBYANCESTRALORGANIM_01 | El objeto paramUserListByAncestralOrganism es nulo | | ORGANISMLISTBYANCESTRALORGANIM_02 | El código del organismo ancestro no puede estar vacío | | ORGANISMLISTBYANCESTRALORGANIM_03 | No existe el organismo ancestro del cual se pretenden obtener los código de sus descendientes | | ORGANISMLISTBYANCESTRALORGANIM_04 | El organismo está dado de baja | | ORGANISMLISTBYANCESTRALORGANIM_05 | No se han encontrado funcionarios para estos parámetros de búsqueda | | ORGANISMLISTBYANCESTRALORGANIM_06 | No existe el organismo ancestro del que se quiere obtener la lista de usuarios | | ORGANISMLISTBYANCESTRALORGANIM_07 | El organismo ancestro del que se quiere obtener la lista de usuarios esta dado de baja | | ORGANISMLISTBYANCESTRALORGANIM_08 | Ha habido un problema al recuperar los organismos para buscar roles | | ORGANISMLISTBYANCESTRALORGANIM_09 | Ha habido un problema al recuperar los roles para buscar usuarios |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamUserListByAncestralOrganismWithPhone param = new ParamUserListByAncestralOrganismWithPhone();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07839");
UserSearchWithPhone userSearchWithPhone = new UserSearchWithPhone();
param.setUserSearchWithPhone(userSearchWithPhone);
ResultUserListByAncestralOrganismWithPhone result = client.userListByAncestralOrganism(param);
|
|
...
Servicio que devuelve una lista de usuarios a partir de una lista de anagramas fiscales.
| Expand |
|---|
|
SignaturaResultUserListByFiscalAnagramList userListByFiscalAnagramList(ParamUserListByFiscalAnagramList paramUserListByFiscalAnagramList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | fiscalAnagrams | String[] | Lista de anagramas fiscales a buscar | | userSearch | Objeto UserSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | userList | Lista de objetos User (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| USERLISTBYFISCALANAGRAMALIST_00 | Error durante la consulta de los datos de funcionarios | | USERLISTBYFISCALANAGRAMALIST_01 | El objeto paramUserListByFiscalAnagramList es nulo | | USERLISTBYFISCALANAGRAMALIST_02 | No se han encontrado funcionarios para estos parámetros de búsqueda | | USERLISTBYFISCALANAGRAMALIST_03 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamUserListByFiscalAnagramList param = new ParamUserListByFiscalAnagramList();
param.setApplicationId("SIU");
String[] FiscalAnagrams = { "18419908J" };
param.setFiscalAnagrams(FiscalAnagrams);
ResultUserListByFiscalAnagramList result = client.userListByFiscalAnagramList(param);
|
|
...
Servicio que devuelve un listado con la información de los usuarios pertenecientes a un organismo pasado como parámetro y a los organismos descendientes de este.
| Expand |
|---|
|
SignaturaResultUserListByOrganismBranchTree userListByOrganismBranchTree(ParamUserListByOrganismBranchTree paramUserListByOrganismBranchTree) 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 | | userSearch | Objeto UserSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userList | Lista de objetos User (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| USERLISTBYORGANISMBRANCHTREE_00 | Error durante la consulta de los usuarios de un organismo y descendientes | | USERLISTBYORGANISMBRANCHTREE_01 | El objeto paramUserListOrganismBranchTree es nulo | | USERLISTBYORGANISMBRANCHTREE_02 | El código de organismo está vacío | | USERLISTBYORGANISMBRANCHTREE_03 | El organismo no existe | | USERLISTBYORGANISMBRANCHTREE_04 | El organismo está dado de baja | | USERLISTBYORGANISMBRANCHTREE_05 | Ha habido un error recuperando los organismos descendientes | | USERLISTBYORGANISMBRANCHTREE_06 | Ha habido un error recuperando los roles de los usuarios | | USERLISTBYORGANISMBRANCHTREE_07 | No se han encontrado usuarios con los parámetros de búsqueda establecidos |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamUserListByOrganismBranchTree param = new ParamUserListByOrganismBranchTree();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
UserSearch userSearch = new UserSearch();
param.setUserSearch(userSearch);
ResultUserListByOrganismBranchTree result = client.userListByOrganismBranchTree(param);
|
|
...
Servicio que devuelve una lista de usuarios de un organismo y sus descendientes.
| Expand |
|---|
|
SignaturaResultUserListByOrganismBranchTreeWithPhone userListByOrganismBranchTreeWithPhone(ParamUserListByOrganismBranchTreeWithPhone paramUserListByOrganismBranchTree) 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 | | userSearch | Objeto UserSearchWithPhone (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userListWithPhone | Lista de objetos UserWithPhone (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| USERLISTBYORGANISMBRANCHTREE_00 | Error durante la consulta de los usuarios de un organismo y descendientes | | USERLISTBYORGANISMBRANCHTREE_01 | El objeto paramUserListOrganismBranchTree es nulo | | USERLISTBYORGANISMBRANCHTREE_02 | El código de organismo está vacío | | USERLISTBYORGANISMBRANCHTREE_03 | El organismo no existe | | USERLISTBYORGANISMBRANCHTREE_04 | El organismo está dado de baja | | USERLISTBYORGANISMBRANCHTREE_05 | Ha habido un error recuperando los organismos descendientes | | USERLISTBYORGANISMBRANCHTREE_06 | Ha habido un error recuperando los roles de los usuarios | | USERLISTBYORGANISMBRANCHTREE_07 | No se han encontrado usuarios con los parámetros de búsqueda establecidos |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamUserListByOrganismBranchTreeWithPhone param = new ParamUserListByOrganismBranchTreeWithPhone();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
UserSearchWithPhone userSearch = new UserSearchWithPhone();
param.setUserSearch(userSearch);
ResultUserListByOrganismBranchTreeWithPhone result = client.userListByOrganismBranchTreeWithPhone(param);
|
|
...
Devuelve igualmente el tamaño de usuarios encontrados.
| Expand |
|---|
|
SignaturaResultUserListWithRevisedFlag userListWithRevisedFlag(ParamUserListWithRevisedFlag paramUserList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | userSearch | Objeto UserSearchWithPhone (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userList | Lista de objetos UserWithRevisedFlag (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| USERLIST_00 | Error durante la consulta de los datos de funcionarios | | USERLIST_01 | El objeto paramUserList es nulo | | USERLIST_02 | No se han encontrado funcionarios para estos parámetros de búsqueda | | USERLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | USERLIST_04 | El código del organismo no puede estar vacío | | USERLIST_05 | No existe el organismo del que se quiere obtener la lista de usuarios | | USERLIST_06 | El organismo del que se quiere obtener la lista de usuarios esta dado de baja | | USERLIST_07 | No existen usuarios para ese organismo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamUserListWithRevisedFlag param = new ParamUserListWithRevisedFlag();
param.setApplicationId("SIU");
UserSearchWithPhone userSearch = new UserSearchWithPhone();
userSearch.setNif("00000000T");
param.setUserSearch(userSearch);
ResultUserListWithRevisedFlag result = client.userListWithRevisedFlag(param);
|
|
...
Devuelve igualmente el tamaño de usuarios encontrados.
| Expand |
|---|
|
SignaturaResultUserByUnits userListByUnits(ParamUserListbyUnits paramUserList); Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | userSearchByUnits | Objeto UserSearchByUnits (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | userList | Lista de objetos UserWithPhoneGenderNote (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| USERLIST_00 | Error durante la consulta de los datos de funcionarios | | USERLIST_01 | El objeto paramUserList es nulo | | USERLIST_02 | No se han encontrado funcionarios para estos parámetros de búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| UserSearchByUnits userSearch = new UserSearchByUnits();
userSearch.setNif("00000000T");
ParamUserListbyUnits param = new ParamUserListbyUnits();
param.setApplicationId("SIU");
param.setUserSearch(userSearch);
param.setFiscalAnagram("00000000T");
ResultUserByUnits result = client.userListByUnits(param);
|
|
...
Devuelve de cada edificio, dirección, ciudad, código, fecha de alta, nombre código postal, fecha de baja, longitud, latitud y nombre.
| Expand |
|---|
|
SignaturaResultBuildingList buildingList(ParamBuildingList paramBuildingList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | buildingSearch | Objeto BuildingSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | buildingList | Lista de objetos Building (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| LISTBUILDING_00 | Error durante el listado de edificios | | LISTBUILDING_01 | El objeto ParamBuildingList es nulo | | LISTBUILDING_02 | El objeto de búsqueda es nulo | | LISTBUILDING_03 | No se han encontrado edificios para estos parámetros de búsqueda | | LISTBUILDING_04 | Ha ocurrido algún tipo de error al listar los edificios |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamBuildingList paramBuildingList = new ParamBuildingList();
BuildingSearch buildingSearch = new BuildingSearch();
buildingSearch.setName("Edificio1");
paramBuildingList.setBuildingSearch(buildingSearch);
ResultBuildingList result = client.buildingList(paramBuildingList);
|
|
...
Devuelve si el logo es el de por defecto, la descripción, la información de la imagen del logo, el nombre y el código del organismo.
| Expand |
|---|
|
SignaturaResultGetLogo getLogo(ParamGetLogo paramGetLogo) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | code | Long | Código de logo | | organismCode | String | Código de organismo | | name | String | Nombre del logo |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | logo | Objeto Logo (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| LISTLOGO_00 | Error durante el listado de logos | | LISTLOGO_01 | El objeto ParamLogoList es nulo | | LISTLOGO_02 | El objeto ParamGetLogo es nulo | | LISTLOGO_03 | No se han encontrado logo para estos parámetros de búsqueda | | LISTLOGO_04 | Ha ocurrido algún tipo de error al listar los logos | | LISTLOGO_05 | No se han proporcionado parámetros de búsqueda del método getLogo | | LISTLOGO_06 | Ha ocurrido algún tipo de error al obtener el logo del servicio getLogo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamGetLogo param = new ParamGetLogo();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07458");
ResultGetLogo result = client.getLogo(param);
|
|
...
Permite filtrar por código, si es el logo por defecto, descripción, imagen, nombre, código de organismo.
| Expand |
|---|
|
SignaturaResultLogoList getLogoList(ParamLogoList paramLogoList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | logoSearch | Objeto LogoSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | logoList | Lista de objetos Logo (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| LISTLOGO_00 | Error durante el listado de logos | | LISTLOGO_01 | El objeto ParamLogoList es nulo | | LISTLOGO_02 | El objeto ParamGetLogo es nulo | | LISTLOGO_03 | No se han encontrado logo para estos parámetros de búsqueda | | LISTLOGO_04 | Ha ocurrido algún tipo de error al listar los logos | | LISTLOGO_05 | No se han proporcionado parámetros de búsqueda del metodo getLogo | | LISTLOGO_06 | Ha ocurrido algún tipo de error al obtener el logo del servicio getLogo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamLogoList param = new ParamLogoList();
param.setApplicationId("SIU");
LogoSearch logoSearch = new LogoSearch();
logoSearch.setDefaultLogo(1);
param.setLogoSearch(logoSearch);
ResultLogoList result = client.getLogoList(param);
|
|
...
Servicio que devuelve la información de un puesto, partiendo de un código de puesto.
| Expand |
|---|
|
SignaturaResultGetJobByJobCode getJobByJobCode(ParamGetJobByJobCode paramGetJobInformationByJobCode) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | jobCode | String | Código del puesto |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | job | Datos del puesto recuperados, objeto Job (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| GETJOBCODE_00 | Ha ocurrido un error al realizar la búsqueda | | GETJOBCODE_01 | El objeto ParamGetJobByJobCode es nulo | | GETJOBCODE_02 | El campo JobCode es nulo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamGetJobByJobCode param = new ParamGetJobByJobCode();
param.setApplicationId("SIU");
param.setJobCode("JOB00031");
ResultGetJobByJobCode result = client.getJobByJobCode(param);
|
|
...
Servicio que devuelve la información de una lista de puestos, cuyos códigos se han pasado en la entrada. Devuelve el tamaño de la lista encontrada.
| Expand |
|---|
|
SignaturaResultJobInformationList jobInformation(ParamJobInformationList jobList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | jobCodes | List<String> | Lista de códigos de puestos a consultar |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | jobList | Lista de objetos Job encontrada (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| JOBINFORMATION_00 | Ha ocurrido un error al realizar la búsqueda | | JOBINFORMATION_01 | El objeto ParamJobInformationList es nulo | | JOBINFORMATION_02 | El listado de codigos de puestos no puede ser nulo o vacio | | JOBINFORMATION_03 | No se han encontrado puestos con esos parámetros de búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamJobInformationList param = new ParamJobInformationList();
List<String> jobs = new ArrayList<String>();
jobs.add("JOB00033");
param.setJobCodes(jobs);
ResultJobInformationList result = client.jobInformation(param);
|
|
...
Permite filtrar por código del puesto, descripción. puesto del que depende, fecha de inicio, fecha de cese, unidad orgánica, unidad de gestión, rpt, si está en frh y si está ocupado.
| Expand |
|---|
|
SignaturaResultJobList jobList(ParamJobList paramJobList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | jobSearch | Objeto JobSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | jobList | Lista de objetos Job (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| JOBLIST_00 | Ha ocurrido un error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamJobList param = new ParamJobList();
param.setApplicationId("SIU");
JobSearch jobSearch = new JobSearch();
jobSearch.setJobCode("JOB00033");
jobSearch.setIsFRH(2);
jobSearch.setVacante(true);
param.setJobSearch(jobSearch);
ResultOrganismList result = client.jobList(param);
|
|
...
Servicio que devuelve un listado de sellos encontrados, según los parámetros de búsqueda introducidos.
| Expand |
|---|
|
SignaturaResultStampList stampList(ParamStampList paramStampList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | stampSearch | Objeto StampSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | stamps | Lista de objetos Stamp (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| STAMPLIST_00 | Error durante la consulta de los datos de sellos | | STAMPLIST_01 | El objeto paramStampList es nulo | | STAMPLIST_02 | No se han encontrado sellos para estos parámetros de búsqueda | | STAMPLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | STAMPLIST_04 | El código de organismo y el alias no pueden ser nulos simultáneamente | | STAMPLIST_05 | El parámetro de entrada fiscal anagram es nulo | | STAMPLIST_06 | Se ha encontrado algún sello con el campo holder nulo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamStampList param = new ParamStampList();
param.setApplicationId("SIU");
StampSearch stampSearch = new StampSearch();
param.setStampSearch(stampSearch);
ResultStampList result = client.stampList(param);
|
|
...
Servicio que devuelve un listado de sellos encontrados e información del usuario, según los parámetros de búsqueda introducidos.
| Expand |
|---|
|
SignaturaResultStampListAndUserInformation stampListAndUserInformation(ParamStampListAndUserInformation paramStampList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | stampListSearch | Objeto StampAndUserInformationSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | stamps | Lista de objetos StampAndUserInformation (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| STAMPLIST_00 | Error durante la consulta de los datos de sellos | | STAMPLIST_01 | El objeto paramStampList es nulo | | STAMPLIST_02 | No se han encontrado sellos para estos parámetros de búsqueda | | STAMPLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | STAMPLIST_04 | El código de organismo y el alias no pueden ser nulos simultáneamente | | STAMPLIST_05 | El parámetro de entrada fiscal anagram es nulo | | STAMPLIST_06 | Se ha encontrado algún sello con el campo holder nulo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamStampListAndUserInformation param = new ParamStampListAndUserInformation();
param.setApplicationId("SIU");
StampAndUserInformationSearch stampListSearch = new StampAndUserInformationSearch();
stampListSearch.setOrganismCode("ORG07556");
param.setStampListSearch(stampListSearch);
ResultStampListAndUserInformation result = client.stampListAndUserInformation(param);
|
|
...
Servicio que devuelve una lista de sellos con información de sus usuarios pudiendo filtrar por organismo, rol y sello.
| Expand |
|---|
|
SignaturaResultStampListAndUserInformationByRoleAndUser stampListAndUserInformation(ParamStampListAndUserInformationByRoleAndUser paramStampList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | searchParams | Objeto StampAndUserInformationByRoleAndUserSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | stamps | Lista de objetos StampAndUserInformationByUser (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| STAMPLIST_00 | Error durante la consulta de los datos de sellos | | STAMPLIST_01 | El objeto paramStampList es nulo | | STAMPLIST_02 | No se han encontrado sellos para estos parámetros de búsqueda | | STAMPLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | STAMPLIST_04 | El código de organismo y el alias no pueden ser nulos simultáneamente | | STAMPLIST_05 | El parámetro de entrada fiscal anagram es nulo | | STAMPLIST_06 | Se ha encontrado algún sello con el campo holder nulo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamStampListAndUserInformationByRoleAndUser param = new ParamStampListAndUserInformationByRoleAndUser();
param.setApplicationId("SIU");
StampAndUserInformationByRoleAndUserSearch searchParams = new StampAndUserInformationByRoleAndUserSearch();
param.setSearchParams(searchParams);
ResultStampListAndUserInformationByUser result = client.stampListAndUserInformation(param);
|
|
...
Servicio que devuelve un listado de sellos con la información de sus usuarios pudiendo filtrar por el rol del usuario.
| Expand |
|---|
|
SignaturaResultStampListAndUserInformationByUser stampListAndUserInformation(ParamStampListAndUserInformationByUser paramStampList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | stampListSearch | Objeto StampAndUserInformationByUserSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | stamps | Lista de objetos StampAndUserInformationByUser (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| STAMPLIST_00 | Error durante la consulta de los datos de sellos | | STAMPLIST_01 | El objeto paramStampList es nulo | | STAMPLIST_02 | No se han encontrado sellos para estos parámetros de búsqueda | | STAMPLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | STAMPLIST_04 | El código de organismo y el alias no pueden ser nulos simultáneamente | | STAMPLIST_05 | El parámetro de entrada fiscal anagram es nulo | | STAMPLIST_06 | Se ha encontrado algún sello con el campo holder nulo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamStampListAndUserInformationByUser param = new ParamStampListAndUserInformationByUser();
param.setApplicationId("SIU");
StampAndUserInformationByUserSearch stampListSearch = new StampAndUserInformationByUserSearch();
stampListSearch.setFiscalAnagram("00000000T");
param.setStampListSearch(stampListSearch);
ResultStampListAndUserInformationByUser result = client.stampListAndUserInformation(param);
|
|
...
Servicio que devuelve una lista de sellos con información de sus usuarios pudiendo filtrar por organismo, puesto y sello.
| Expand |
|---|
|
SignaturaResultStampListAndUserInformationByJobAndUser stampListAndUserInformationJob(ParamStampListAndUserInformationByJobAndUser paramStampList) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | searchParams | Objeto StampAndUserInformationByJobAndUserSearch (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista devuelta | | stamps | Lista de objetos StampAndUserInformationByUserJob (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| STAMPLIST_00 | Error durante la consulta de los datos de sellos | | STAMPLIST_01 | El objeto paramStampList es nulo | | STAMPLIST_02 | No se han encontrado sellos para estos parámetros de búsqueda | | STAMPLIST_03 | Ha ocurrido algún error al realizar la búsqueda | | STAMPLIST_04 | El código de organismo y el alias no pueden ser nulos simultáneamente | | STAMPLIST_05 | El parámetro de entrada fiscal anagram es nulo | | STAMPLIST_06 | Se ha encontrado algún sello con el campo holder nulo |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamStampListAndUserInformationByJobAndUser param = new ParamStampListAndUserInformationByJobAndUser();
param.setApplicationId("SIU");
StampAndUserInformationByJobAndUserSearch searchParams = new StampAndUserInformationByJobAndUserSearch();
param.setSearchParams(searchParams);
ResultStampListAndUserInformationByUser result = client.stampListAndUserInformation(param);
|
|
...