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.
ÍNDICE DE SERVICIOS
Servicios IInfoServicesPortType
Búsquedas y consultas de organismos
Método 'additionalDataOrganismListByUser'
Servicio que devuelve un listado con información adicional de los organismos a los que un usuario tiene acceso. Permite filtrar por usuario.
...
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.
ÍNDICE DE SERVICIOS
Servicios IInfoServicesPortType
Búsquedas y consultas de organismos
Método 'additionalDataOrganismListByUser'
...
Servicio que devuelve un listado con información adicional de los organismos a los que un usuario tiene acceso. Permite filtrar por usuario.
De cada organismo del listado devuelto devuelve dirección, número de hijos, ciudad, país, si es emisor, si es externo, el código del organismo padre, la identidad fiscal, la fecha inicial, el nombre, el nivel del nodo, el código del organismo, el código postal, la provincia, si es receptor, si es organismo raíz, el código de su organismo raíz, el nombre corto, el teléfono, el código Sirhga del organismo y el código Sirhga del organismo padre.
Expand |
---|
|
SignaturaResultAdditionalDataOrganismListByUser additionalDataOrganismListByUser (ParamAdditionalDataOrganismListByUser paramAdditionalDataOrganismByUser). Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | userSearch | email | String | Dirección email del funcionario | fiscalAnagram | String | Anagrama fiscal del funcionario | name | String | Nombre del funcionario | nif | String | NIF del funcionario | state | String | Estado del funcionario | surname1 | String | Primer apellido del funcionario | surname2 | String | Segundo apellido del funcionario |
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 | organismByUser | organisms | Lista de organismos (ver detalle de campos en el apartado de objetos ) | user | Usuario (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ORGANISMROOTFATHERBYUSER_01 | El objeto paramOrganismList es nulo. | ORGANISMROOTFATHERBYUSER_02 | No existen usuarios con los parámetros de búsqueda averiguar la raíz. | ORGANISMROOTFATHERBYUSER_03 | Ha ocurrido algún error al realizar la búsqueda | ORGANISMROOTFATHERBYUSER_00 | Error durante la consulta de los datos del padre raíz del organismo |
Ejemplo de invocación
Code Block |
---|
language | java |
---|
firstline | 1 |
---|
title | Ejemplo de invocación |
---|
collapse | true |
---|
| ParamAdditionalDataOrganismListByUser param = new ParamAdditionalDataOrganismListByUser();
param.setApplicationId("SIU");
UserSearch userSearch = new UserSearch();
userSearch.setNif("00000000T");
param.setUserSearch(userSearch);
ResultAdditionalDataOrganismListByUser result = client.additionalDataOrganismListByUser(param); |
|
Método 'additionalDataOrganismListByPernrAndCertPseudonym'
...
Servicio que devuelve un listado con información adicional de los organismos a los que un usuario tiene acceso. Permite filtrar por usuario.
De cada organismo del listado devuelto devuelve dirección, número de hijos, ciudad, país, si es emisor, si es externo, el código del organismo padre, la identidad fiscal, la fecha inicial, el nombre, el nivel del nodo, el código del organismo, el código postal, la provincia, si es receptor, si es organismo raíz, el código de su organismo raíz, el nombre corto, el teléfono, el código Sirhga del organismo y el código Sirhga del organismo padre.
Expand |
---|
|
SignaturaResultAdditionalDataOrganismListByUserExtendedData additionalDataOrganismListByPernrAndCertPseudonym(ParamAdditionalDataOrganismListByUserExtendedData paramAdditionalDataOrganismListByUserExtendedData) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | UserSearchExtendedData | Objeto | UserSearchExtendedData (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 | organismByUser | organisms | Lista de organismos (ver detalle de campos en el apartado de objetos ) | user | Usuario (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ORGANISMROOTFATHERBYUSER_01 | El objeto paramOrganismList es nulo. | ORGANISMROOTFATHERBYUSER_02 | No existen usuarios con los parámetros de búsqueda averiguar la raíz. | ORGANISMROOTFATHERBYUSER_03 | Ha ocurrido algún error al realizar la búsqueda | ORGANISMROOTFATHERBYUSER_00 | Error durante la consulta de los datos del padre raíz del organismo |
Ejemplo de invocación
Code Block |
---|
language | java |
---|
firstline | 1 |
---|
title | Ejemplo de invocación |
---|
collapse | true |
---|
| ParamAdditionalDataOrganismListByUserExtendedData param = new ParamAdditionalDataOrganismListByUserExtendedData();
param.setApplicationId("SIU");
UserSearch userSearch = new UserSearch();
userSearch.setNif("00000000T");
param.setUserSearch(userSearch);
ResultAdditionalDataOrganismListByUserExtendedDataresult = client.additionalDataOrganismListByPernrAndCertPseudonym(param); |
|
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ónNombre | 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ónNombre | 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ónNombre | 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); |
|
Método 'ancestralOrganismTreeExtended' #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.
De cada organismo devuelve el campo oldCode en caso de que esté este informado.
Expand |
---|
|
SignaturaResultAdditionalDataOrganismListByUser additionalDataOrganismListByUser (ParamAdditionalDataOrganismListByUser paramAdditionalDataOrganismByUser).ResultAncestralOrganismTreeWithOldCode ancestralOrganismTreeExtendedWithOldCode(ParamAncestralOrganismTree paramAncestralOrganismTree) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | userSearch | emailorgCode | String | Dirección email del funcionario | fiscalAnagram | String | Anagrama fiscal del funcionario | name | String | Nombre del funcionario | nif | String | NIF del funcionario | state | String | Estado del funcionario | surname1 | String | Primer apellido del funcionario | surname2 | String | Segundo apellido del funcionarioCó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 |
size | int | Tamaño de la lista devuelta | organismByUser | organisms | Lista de organismos (ver detalle de campos en el apartado de objetos ) | user | Usuario | organismList | Lista de organismos | organism | Organismo (ver detalle de | campos en campos en el apartado de objetos comunes) | oldCode | String | Antiguo identificador del organismo |
Códigos error
ORGANISMROOTFATHERBYUSERANCESTRAL_ORGANISM_TREE_01 | El objeto | paramOrganismList es nulo.ORGANISMROOTFATHERBYUSERparamAncestralOrganismTree es nulo | ANCESTRAL_ORGANISM_TREE_04 | El código de organismo no puede ser nulo | ANCESTRAL_ORGANISM_TREE_02 | No | existen usuarios con los se han encontrado organismos con esos parámetros de búsqueda | averiguar la raíz.ORGANISMROOTFATHERBYUSER | ANCESTRAL_ORGANISM_TREE_03 | Ha ocurrido algún tipo de error al realizar la búsqueda | ORGANISMROOTFATHERBYUSERANCESTRAL_ORGANISM_TREE_00 | Error durante la consulta de los datos del padre raíz del organismoHa ocurrido algún error inesperado |
Ejemplo de invocación
Code Block |
---|
language | java |
---|
firstline | 1 |
---|
title | Ejemplo de invocación |
---|
collapse | true |
---|
| ParamAdditionalDataOrganismListByUserParamAncestralOrganismTree param = new ParamAdditionalDataOrganismListByUserParamAncestralOrganismTree();
param.setApplicationId("SIU");
param.setOrgCode("ORG08881");
UserSearchResultAncestralOrganismTreeWithOldCode userSearchresult = new UserSearch();
userSearch.setNif("00000000T");
param.setUserSearch(userSearch);
ResultAdditionalDataOrganismListByUser result = client.additionalDataOrganismListByUser(param); |
|
Método 'ancestralOrganismByUserList'
Servicio que devuelve una lista de organismos ancestros a los que pertenece un usuario a partir de un token.
...
client.ancestralOrganismTreeExtended(param); |
|
Método 'ascendantOrganismBranchTree'
...
Servicio que devuelve un listado de organismos ascendentes de un organismo pasado como parámetro. Como mínimo hay que informar el código del organismo a buscar.
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 |
---|
|
SignaturaResultAncestralOrganismByUserList ancestralOrganismByUserList(ParamAncestralOrganismByUserList paramAncestralOrganismByUserList).ResultAscendantOrganismBranchTree ascendantOrganismBranchTree(ParamAscendantOrganismBranchTree paramAscendentOrganismBranchTree) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | tokenoriginalToken | String | Valor del token a cifrar | orgCode | String | Valor del token cifrado | 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 de organismos | | organism | Organismo (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
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 | 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 | ANCESTRALORGANISMBYUSERLIST_06para 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ónEl ejemplo devuelve un error
Code Block |
---|
language | java |
---|
firstline | 1 |
---|
title | Ejemplo de invocación |
---|
collapse | true |
---|
| ParamAncestralOrganismByUserListParamAscendantOrganismBranchTree param = new ParamAncestralOrganismByUserListParamAscendantOrganismBranchTree();
param.setApplicationId("SIU");
param.setOriginalTokensetOrgCode("TORG07810");
param.setToken("T"OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07810");
param.setOrganismSearch(organismSearch);
ResultAncestralOrganismByUserListResultAscendantOrganismBranchTree result = client.ancestralOrganismByUserListascendantOrganismBranchTree(param); |
|
Método '
...
descendentOrganismList'
...
...
Servicio que devuelve un listado de organismos hijos de otro organismo pasado como parámetro, acorde 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ízunos parámetros de búsqueda, incluyendo el organismo pasado como parámetro.
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 |
---|
|
SignaturaResultAncestralOrganismWithAllTree ancestralOrganismWithAllTree(ParamAncestralOrganismWithAllTree paramAncestralOrganismWithAllTreeResultDescendentOrganismList descendentOrganismList(ParamDescendentOrganismList paramDescendentOrganismList) Parámetros de invocaciónNombre | 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 árbolorganismSearch | 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
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 |
---|
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 |
---|
| ParamAncestralOrganismWithAllTreeParamDescendentOrganismList param = new ParamAncestralOrganismWithAllTreeParamDescendentOrganismList();
param.setApplicationId("SIU");
OrganismSearch organismSearch = new OrganismSearch();
paramorganismSearch.setOrgCodesetOrganismCode("ORG15138"ORG07839");
param.setOrganismSearch(organismSearch);
ResultAncestralOrganismWithAllTreeResultDescendentOrganismList result = client.ancestralOrganismWithAllTreedescendentOrganismList(param); |
|
Método '
...
descendentOrganismListWithCode'
...
...
Servicio que devuelve un listado de organismos hijos de otro organismo pasado como parámetro, acorde con la información de los ancestros de un organismo, el organismo buscado y los que tienen el mismo padre que el organismo buscadounos parámetros de búsqueda, incluyendo el organismo pasado como parámetro.
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 |
---|
|
SignaturaResultAncestralOrganismTree ancestralOrganismTree(ParamAncestralOrganismTree paramAncestralOrganismTreeResultDescendentOrganismListWithCode descendentOrganismList(ParamDescendentOrganismList paramDescendentOrganismList) Parámetros de invocaciónNombre | 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 organism | Campos del objeto Organism | organismSearch | Bean de búsqueda de organismos | Objeto OrganismSearch (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 | size | int | Tamaño de la lista de organismos devuelta | organismList | Lista | de de organismos | | organism | Organismo OrganismoWithCode (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
ANCESTRAL_ORGANISM_TREE_DESCENDENTORGANISMLIST_00 | Error durante la consulta de los datos de organismos | DESCENDENTORGANISMLIST_01 | El objeto | paramAncestralOrganismTree ANCESTRAL_ORGANISM_TREEparamDescendentOrganismList es nulo |
ANCESTRAL_ORGANISM_TREE_04 | El código de organismo no puede ser nulo | DESCENDENTORGANISMLIST_02 | No se han encontrado organismos | con esos para estos parámetros de búsqueda |
ANCESTRAL_ORGANISM_TREE_03 | Ha ocurrido algún tipo de error al realizar la búsqueda | ANCESTRAL_ORGANISM_TREE_00DESCENDENTORGANISMLIST_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 | inesperado Ejemplo de invocación
Code Block |
---|
language | java |
---|
firstline | 1 |
---|
title | Ejemplo de invocación |
---|
collapse | true |
---|
| ParamAncestralOrganismTreeParamDescendentOrganismListWithCode param = new ParamAncestralOrganismTreeParamDescendentOrganismList();
param.setApplicationId("SIU");
param.setOrgCode("ORG07458
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07839");
ResultAncestralOrganismTreeparam.setOrganismSearch(organismSearch);
ResultDescendentOrganismList result = client.ancestralOrganismTreedescendentOrganismList(param); |
|
Método '
...
getAdministrativeOrganismList'
...
...
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.De cada organismo devuelve el campo oldCode en caso de que esté este informadolista 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 |
---|
|
SignaturaResultAncestralOrganismTreeWithOldCode ancestralOrganismTreeExtendedWithOldCode(ParamAncestralOrganismTree paramAncestralOrganismTreeResultAdministrativeOrganismList getAdministrativeOrganismList(ParamAdministrativeOrganismList paramAdministrativeOrganismList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | orgCodeuserOrganismCode | String | Código | de del organismo | del que se extraerán los de su árbolorganismSearch | 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) | 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 | organismListdataList | Lista de organismos administradores | name | organism | Organismo (ver detalle de campos en el apartado de objetos comunes) | oldCodeString | Nombre del organismo administradores | organismCode | String | Antiguo identificador Código del | organismoorganismo administradores |
Códigos error
ANCESTRALORGANISM_TREE_01El 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 inesperadoORGAN_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 |
---|
| ParamAncestralOrganismTreeParamAdministrativeOrganismList param = new ParamAncestralOrganismTreeParamAdministrativeOrganismList();
param.setApplicationId("SIU");
param.setOrgCodesetUserOrganismCode("ORG08881ORG16671");
ResultAncestralOrganismTreeWithOldCodeResultAdministrativeOrganismList resultresponse = client.ancestralOrganismTreeExtendedgetAdministrativeOrganismList(param);
|
|
Método '
...
getClosestProcessUnitList'
...
Servicio que devuelve un listado la lista de organismos ascendentes de un organismo pasado como parámetro. Como mínimo hay que informar el código del organismo a buscar.
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 organismolos 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 |
---|
|
SignaturaResultAscendantOrganismBranchTree ascendantOrganismBranchTree(ParamAscendantOrganismBranchTree paramAscendentOrganismBranchTreeResultProcessUnitList getClosestProcessUnitList(ParamGetProcessUnitList requestParam) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagramorganismCodes | String | Anagrama fiscal | orgCodeList<String> | Listado de códigos de organismos | userOrganismCode | String | Código | de organismoorganismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes)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 | sizedataList | 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)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 |
---|
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úsquedaGETPROCESSUNIT_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 |
---|
| ParamAscendantOrganismBranchTreeParamGetProcessUnitList param = new ParamAscendantOrganismBranchTreeParamGetProcessUnitList();
param.setApplicationId("SIU");
param.setOrgCodesetUserOrganismCode("ORG07810ORG11896");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07810");
param.setOrganismSearch(organismSearch);
ResultAscendantOrganismBranchTree result = client.ascendantOrganismBranchTree(param); |
|
Método 'descendentOrganismList'
Servicio que devuelve un listado de organismos hijos de otro organismo pasado como parámetro, acorde con unos parámetros de búsqueda, incluyendo el organismo pasado como parámetro.
...
param.setOrganismCodes(new String[] { "ORG11896", "ORG14166", "ORG11882", "ORG15137", "ORG11652", "ORG11904", "ORG11964" });
ResultProcessUnitList response = client.getInfoServices().getClosestProcessUnitList(param);
|
|
Método 'getDir3CodeList' #Deprecated
...
Servicio que devuelve los organismos SIU correspondientes a un listado de códigos dir3.
Expand |
---|
|
SignaturaResultDescendentOrganismList descendentOrganismList(ParamDescendentOrganismList paramDescendentOrganismListResultGetDir3CodeList getDir3CodeList(ParamOrganismWithCodeDir3List paramOrganismWithCodeDir3List) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismDir3CodeList | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes)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 | size | int | Tamaño de la lista de organismos devuelta | organismList | 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 | DESCENDENTORGANISMLISTDESCENDENTORGANISMLISTGETDIR3CODELIST_00 | Error durante la consulta de los datos de organismos | Código de error general para este servicio | GETDIR3CODELIST_01 | El objeto | paramDescendentOrganismList ParamOrganismWithCodeDir3List es nulo | DESCENDENTORGANISMLISTGETDIR3CODELIST_02 | La lista de organismos DIR3 está vacía | GETDIR3CODELIST_03 | 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 | 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 |
---|
| ParamDescendentOrganismListParamOrganismWithCodeDir3List param = new ParamDescendentOrganismListParamOrganismWithCodeDir3List();
param.setApplicationId("SIU");
OrganismSearchList<String> organismSearchlstDirCode = new OrganismSearchArrayList<String>();
organismSearchlstDirCode.setOrganismCodeadd("ORG07839A02003454");
param.setOrganismSearchsetOrganismDir3CodeList(organismSearchlstDirCode);
ResultDescendentOrganismListResultGetDir3CodeList result = client.descendentOrganismListgetDir3CodeList(param);
|
|
Método '
...
getOrganismAdditionalData'
...
Servicio que devuelve un listado de organismos hijos de otro información adicional de un organismo pasado como parámetro, acorde con unos parámetros de búsqueda, incluyendo el organismo pasado como parámetro.
Permite filtrar además por otros datos como dirección, cif, ciudad, paíspais, email, si es emisor, si es externo, el código código del organismo padre, código sirhga del organismo padre, la fecha de baja, por la identidad fiscal, la fecha de alta, el nombre, el newCode, el código del código nuevo de organismo, código de 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 padrey teléfono.
Expand |
---|
|
SignaturaResultDescendentOrganismListWithCode descendentOrganismList(ParamDescendentOrganismList paramDescendentOrganismListResultOrganismAdditionalData getOrganismAdditionalData(ParamOrganismAdditionalData paramOrganismAdditionalData) Parámetros de invocaciónNombre | 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 organismos | organism | OrganismoWithCode organismAdditionalData | Objeto OrganismAdditionalData (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción | DESCENDENTORGANISMLISTDESCENDENTORGANISMLISTORGANISM_ADDITIONAL_DATA_00 | Error durante la consulta de los datos de organismos | Código de error general para este servicio | ORGANISM_ADDITIONAL_DATA_01 | El objeto | paramDescendentOrganismList paramOrganismAdditionalData es nulo | DESCENDENTORGANISMLISTORGANISM_ADDITIONAL_DATA_02 | No se han encontrado organismos para | estos parámetros de búsquedaDESCENDENTORGANISMLIST_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_06estos 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 |
---|
| ParamDescendentOrganismListWithCodeParamOrganismAdditionalData param = new ParamDescendentOrganismListParamOrganismAdditionalData();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07839");
param.setOrganismSearch(organismSearch);
ResultDescendentOrganismListResultOrganismAdditionalData result = client.descendentOrganismListgetOrganismAdditionalData(param);
|
|
Método '
...
getOrganismHistoricalInformation' #Deprecated
...
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 mayorpara obtener un histórico de organismos partiendo de un organismo pasado como parámetro. Devuelve un listado de organismos.
Expand |
---|
|
SignaturaResultAdministrativeOrganismList getAdministrativeOrganismList(ParamAdministrativeOrganismList paramAdministrativeOrganismListResultGetOrganismHistoricalInformation getOrganismHistoricalInformation(ParamGetOrganismHistoricalInformation paramGetOrganismHistoricalInformation) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | userOrganismCode | fiscalAnagram | String | Anagrama fiscal | organismCode | String | Código del organismo | con el que se ha logueado el usuarioa 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 | dataListorganismList | Lista de organismos | administradores name | String | Nombre del organismo administradores | | organismCodeString | Código del organismo administradores organism | Objeto Organism (ver detalle de campos en el apartado de objetos comunes) |
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 usuarioGET_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 |
---|
| ParamAdministrativeOrganismListParamGetOrganismHistoricalInformation paramparams = new ParamAdministrativeOrganismListParamGetOrganismHistoricalInformation();
paramparams.setApplicationId("SIU");
paramparams.setUserOrganismCodesetOrganismCode("ORG16671ORG04302");
ResultAdministrativeOrganismList responseparams.setChronologicalOrder("PREVIOUS");
ResultGetOrganismHistoricalInformation result = client.getAdministrativeOrganismListgetOrganismHistoricalInformation(paramparams);
|
|
Método '
...
getOrganismWithFiscalIdentity'
...
Servicio que devuelve una lista de organismos original y productor de una lista de organismos pasada como parámetro.
Expand |
---|
|
SignaturaResultProcessUnitList getClosestProcessUnitList(ParamGetProcessUnitList requestParamResultOrganismWithFiscalIdentityList getOrganismWithFiscalIdentity(ParamOrganismWithFiscalIdentityList paramOrganismWithFiscalIdentityList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | organismCodes | fiscalAnagram | String | Anagrama fiscal | organismList | List<String> | Listado de códigos de | organismosuserOrganismCode | String | Código del organismo | con el que se ha logueado el usuario |
Parámetros de respuesta
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 usuarioNombre | 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 | dataListorganismWithFiscalIdentity | Lista de organismos | tramitadores que coinciden name | String | Nombre del organismo tramitador | organismCode | String | Código del organismo tramitador |
Códigos errorCó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 |
---|
| ParamGetProcessUnitListParamOrganismWithFiscalIdentityList param = new ParamGetProcessUnitListParamOrganismWithFiscalIdentityList();
param.setApplicationId("SIU");
param.setUserOrganismCodesetFiscalAnagram("ORG11896");
param.setOrganismCodes(new String[] { "ORG11896", "ORG14166", "ORG11882", "ORG15137", "ORG11652", "ORG11904", "ORG11964" });
ResultProcessUnitList response = client.getInfoServices().getClosestProcessUnitListList<String> organismList = new ArrayList<String>();
organismList.add("ORG07810");
param.setOrganismList(organismList);
ResultOrganismWithFiscalIdentityList result = client.getOrganismWithFiscalIdentity(param);
|
|
Método '
...
getProccesingUnitsListByOrganimsList'
...
...
Servicio que devuelve la lista de los organismos tramitadores que coinciden entre los pasados como parámetro y las ramas de los organismos SIU correspondientes a un listado de códigos dir3a 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 |
---|
|
SignaturaResultGetDir3CodeList getDir3CodeList(ParamOrganismWithCodeDir3List paramOrganismWithCodeDir3ListResultProccesingUnitsListByOrganimsList getProccesingUnitsListByOrganimsList(ParamProccesingUnitsListByOrganimsList paramProccesingUnitsListByOrganimsList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el métodofiscalAnagram | organismCodes | String | Anagrama fiscal | organismDir3CodeListList<String> | Listado de códigos de organismos a consultar | organismCodesProcc | List<String> | Listado de códigos dir3de 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 | organismDir3CodeList | size | int | Tamaño de la lista processingList devuelta | processingList | Lista de organismos con código DIR3 | organism | Organismo (ver detalle de campos en el apartado de objetos comunes) | organismDir3Code | Código DIR3 del organismolistas 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 |
---|
GETDIR3CODELISTGETPROCESSUNIT_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úsquedaEl 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 |
---|
| ParamOrganismWithCodeDir3ListString[] paramuserOrganismCode = new ParamOrganismWithCodeDir3List();
param.setApplicationId("SIU");
List<String> lstDirCodeString[] { "ORG14392" };
String[] processUnitCodes = new String[] { "ORG14392", "ORG14391", "ORG14390", "ORG14367", "ORG12841", "ORG15560", "ORG16806", "ORG14123" };
ParamProccesingUnitsListByOrganimsList param = new ArrayList<String>ParamProccesingUnitsListByOrganimsList();
lstDirCodeparam.addsetApplicationId("A02003454"SIU");
param.setOrganismCodes(userOrganismCode);
param.setOrganismDir3CodeListsetOrganismCodesProcc(lstDirCodeprocessUnitCodes);
ResultGetDir3CodeListResultProccesingUnitsListByOrganimsList resultresponse = client.getDir3CodeListgetProccesingUnitsListByOrganimsList(param);
|
|
Método '
...
historicalOrganismDirectDescendentList'
...
Servicio que devuelve información adicional de un un listado de organismos descendientes directos de otro organismo pasado como parámetro .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éfonopudiendo filtrar por fecha.
Expand |
---|
|
SignaturaResultOrganismAdditionalData getOrganismAdditionalData(ParamOrganismAdditionalData paramOrganismAdditionalDataResultHistoricalOrganismDirectDescendentList historicalOrganismDirectDescendentList(ParamHistoricalOrganismDirectDescendentList paramHistoricalOrganismDirectDescendentList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismCode | String | Código de organismo | date | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes)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 ocurridoorganismAdditionalData | Objeto OrganismAdditionalData (ver detalle de campos 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_ | ADDITIONALDESCENDENT_ | DATAORGANISM_ADDITIONAL_DATALIST_00 | Código de error general para este servicio | Error durante la consulta de organismos históricos | HISTORICAL_ORGANISM_DIRECT_DESCENDENT_LIST_01 | El objeto | paramOrganismAdditionalData paramHistoricalOrganismDirectDescendentList es nulo | HISTORICAL_ORGANISM_DIRECT_ | ADDITIONALDESCENDENT_ | DATALIST_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_ | ADDITIONALDESCENDENT_ | DATALIST_ | 0304 | 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 |
---|
| ParamOrganismAdditionalData param = new ParamOrganismAdditionalData();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
OrganismSearch organismSearchParamHistoricalOrganismDirectDescendentList param = new OrganismSearch( ParamHistoricalOrganismDirectDescendentList();
param.setApplicationId("SIU");
param.setOrganismSearchsetOrganismCode(organismSearch"ORG07839");
ResultOrganismAdditionalDataResultHistoricalOrganismDirectDescendentList result = client.getOrganismAdditionalDatahistoricalOrganismDirectDescendentList(param);
|
|
Método '
...
historicalOrganismTreeList' #Deprecated
...
Servicio para obtener que devuelve un histórico listado de organismos partiendo de un formado por: el organismo pasado como parámetro. Devuelve un listado de organismos, todos sus descendientes activos y los históricos de todos ellos.
El listado devuelto se ordena por código de organismo.
Expand |
---|
|
SignaturaResultGetOrganismHistoricalInformation getOrganismHistoricalInformation(ParamGetOrganismHistoricalInformation paramGetOrganismHistoricalInformationResultHistoricalOrganismTreeList historicalOrganismTreeList(ParamHistoricalOrganismTreeList paramHistoricalOrganismTreeList) Parámetros de invocaciónNombre | 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 | 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 size | int | Tamaño de la lista de organismos devuelta | organism | Objeto Organism organismList | Lista de objetos OrganismDir3CodeWithOldCode (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
GETHISTORICAL_ORGANISM_HISTORICALTREE_INFORMATIONLIST_00 | Error durante la consulta de organismos cronológicoshistóricos | GETHISTORICAL_ORGANISM_HISTORICALTREE_INFORMATIONLIST_01 | El objeto ParamGetOrganismHistoricalInformation paramHistoricalOrganismTreeList es nulo | GETHISTORICAL_ORGANISM_HISTORICALTREE_INFORMATIONLIST_02 | El código de organismo es nulo | GETHISTORICAL_ORGANISM_HISTORICALTREE_INFORMATIONLIST_03 | No se han encontrado organismos para estos parámetros de búsqueda | GETEl organismo no existe en la base de datos | HISTORICAL_ORGANISM_HISTORICALTREE_INFORMATIONLIST_04 | Error con el parámetro de orden cronológico | GET_ORGANISM_HISTORICAL_INFORMATION_05 | Ha ocurrido algún error al realizar la búsquedaEl 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 |
---|
| ParamGetOrganismHistoricalInformationParamHistoricalOrganismTreeList paramsparam = new ParamGetOrganismHistoricalInformationParamHistoricalOrganismTreeList();
paramsparam.setApplicationId("SIU");
paramsparam.setOrganismCode("ORG04302ORG15551");
params.setChronologicalOrder("PREVIOUS");
ResultGetOrganismHistoricalInformation ResultHistoricalOrganismTreeList result = client.getOrganismHistoricalInformationhistoricalOrganismTreeList(paramsparam);
|
|
Método '
...
historicalParent' #Deprecated
...
Servicio que devuelve una lista de organismos original y productor de padre de un organismo pasado como parámetro. Admite una lista de organismos pasada como parámetro.
Además de los datos de los organismos devueltos en la lista, devuelve el código del organismo buscado.
Expand |
---|
|
SignaturaResultOrganismWithFiscalIdentityList getOrganismWithFiscalIdentity(ParamOrganismWithFiscalIdentityList paramOrganismWithFiscalIdentityListResultHistoricalParent historicalParent(ParamHistoricalParent paramHistoricalParent) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismListList<String> | String[] | Listado de códigos de organismoLista 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 | organismWithFiscalIdentity | size | int | Tamaño de la lista devuelta | historicalParentListObject | Lista de organismos, objeto OrganismWithFiscalIdentity objetos HistoricalParentListObject (ver detalle campos en el apartado de objetos comunes) |
Códigos errorCó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 | 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 |
---|
| ParamOrganismWithFiscalIdentityListParamHistoricalParent param = new ParamOrganismWithFiscalIdentityListParamHistoricalParent();
param.setApplicationId("SIU");
param.setFiscalAnagram("");
List<String>String[] organismList = new ArrayList<String>();
organismList.add("ORG07810"){ "ORG00002" };
param.setOrganismList(organismList);
ResultOrganismWithFiscalIdentityListResultHistoricalParent result = client.getOrganismWithFiscalIdentityhistoricalParent(param);
|
|
Método '
...
historicalTree' #Deprecated
...
Servicio que devuelve la lista una lista con la estructura de organismos ascendientes y descendientes de los organismos tramitadores que coinciden entre los pasados como parámetro y las ramas .
Además de los datos 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 mayordevueltos en la lista, devuelve el código del organismo buscado.
Expand |
---|
|
SignaturaResultProccesingUnitsListByOrganimsList getProccesingUnitsListByOrganimsList(ParamProccesingUnitsListByOrganimsList paramProccesingUnitsListByOrganimsListResultHistoricalTree historicalTree(ParamHistoricalTree paramHistoricalTree) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | organismCodesfiscalAnagram | List<String> | Listado de códigos de organismos a consultar | organismCodesProcc | List<String> | Listado de códigos de organismos del procedimientoString | 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 processingList lista devuelta | processingListhistoricalTreeListObject | 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 | objetos HistoricalTreeListObject (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción | GETPROCESSUNITHISTORICAL_TREE_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 consultadosError 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 |
---|
| String[]ParamHistoricalTree userOrganismCodeparam = new String[] { "ORG14392" }ParamHistoricalTree();
param.setApplicationId("SIU");
String[] processUnitCodesorganismList = new String[] { "ORG14392", "ORG14391", "ORG14390", "ORG14367", "ORG12841", "ORG15560", "ORG16806", "ORG14123" };
ParamProccesingUnitsListByOrganimsList param = new ParamProccesingUnitsListByOrganimsList();
param.setApplicationId("SIU");
param.setOrganismCodes(userOrganismCode);
param.setOrganismCodesProcc(processUnitCodes);
ResultProccesingUnitsListByOrganimsList responseORG00002" };
param.setOrganismList(organismList);
ResultHistoricalTree result = client.getProccesingUnitsListByOrganimsListhistoricalTree(param);
|
|
Método '
...
getListUserExist'
...
Servicio que devuelve dado un listado de organismos descendientes directos de otro organismo pasado como parámetro pudiendo filtrar por fechanif, si existen o no en siu.
Expand |
---|
|
SignaturaResultHistoricalOrganismDirectDescendentList historicalOrganismDirectDescendentList(ParamHistoricalOrganismDirectDescendentList paramHistoricalOrganismDirectDescendentList)ResultUserExist getListUserExist(ParamUserExist paramUserExist); Parámetros de invocaciónNombre | 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 fechalistFiscalAnagram | 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 ocurridosize | listUserExist | intList<UserExist> | 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) | Listado de UserExist |
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 |
---|
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 |
---|
| ParamHistoricalOrganismDirectDescendentList paramHashSet<String> listNifs = new HashSet<String>();
HashSet<String> listNrpts = new HashSet<String>();
ParamUserExist paramUserExist = new ParamHistoricalOrganismDirectDescendentListParamUserExist();
paramparamUserExist.setApplicationId("SIU");
param.setOrganismCode("ORG07839");
ResultHistoricalOrganismDirectDescendentListparamUserExist.setListFiscalAnagram(listNifs);
paramUserExist.setListNrpt(listNrpts);
// Consultamos la lista de nifs y nrpts en SIU
ResultUserExist result = client.historicalOrganismDirectDescendentListgetListUserExist(paramparamUserExist);
|
|
Método '
...
loginOrganismListByUser' #Deprecated
...
Servicio que devuelve un listado de organismos formado por: el organismo pasado como parámetro, todos sus descendientes activos y los históricos de todos ellos.El listado devuelto se ordena por código de organismo.los organismos en los que un usuario en estado de alta tiene roles.
Permite filtrar por email, anagrama fiscal, nombre, nif, estado y apellidos.
Expand |
---|
|
SignaturaResultHistoricalOrganismTreeList historicalOrganismTreeList(ParamHistoricalOrganismTreeList paramHistoricalOrganismTreeListResultLoginOrganismListByUser loginOrganismListByUser(ParamLoginOrganismListByUser paramLoginOrganismListByUser) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismCode | String | Código de organismouserSearch | 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 | organismListloginOrganismByUser | Lista de objetos OrganismDir3CodeWithOldCode LoginOrganismByUser (ver ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
HISTORICAL_ORGANISM_TREE_LIST_LOGINORGANISMLISTBYUSER_00 | Error durante la consulta de organismos históricos | HISTORICAL_ORGANISM_TREE_LIST_Código de error general para este servicio | LOGINORGANISMLISTBYUSER_01 | El objeto paramHistoricalOrganismTreeList paramLoginOrganismListByUser es nulo | HISTORICAL_ORGANISM_TREE_LISTLOGINORGANISMLISTBYUSER_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 | 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 |
---|
| ParamHistoricalOrganismTreeList paramParamLoginOrganismListByUser param = new ParamLoginOrganismListByUser();
param.setApplicationId("SIU");
UserSearch userSearch = new ParamHistoricalOrganismTreeListUserSearch();
paramuserSearch.setApplicationIdsetNif("SIU00000000T");
param.setOrganismCodesetUserSearch("ORG15551"userSearch);
ResultHistoricalOrganismTreeListResultLoginOrganismListByUser result = client.historicalOrganismTreeListloginOrganismListByUser(param);
|
|
Método '
...
organismActive'
...
...
Servicio que devuelve una lista de organismos padre de un organismo pasado como parámetro. Admite una lista de organismos como parámetro.Además de los datos de los organismos devueltos en la lista, devuelve el código del organismo buscadoa partir de un código de un organismo activo, devuelve los datos de ese organismo.
Expand |
---|
|
SignaturaResultHistoricalParent historicalParent(ParamHistoricalParent paramHistoricalParentResultOrganismActive organismActive(ParamOrganismActive paramOrganismActive) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismListorganismActive | String[] | Lista Código de organismos a buscarorganismo |
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 organism | Objeto Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
HISTORICAL_PARENTORGANISMACTIVE_00 | Error durante la consulta de los datos de organismos | HISTORICAL_PARENTORGANISMACTIVE_01 | El objeto paramAscendentOrganismBranchTree paramOrganismActive es nulo | HISTORICAL_PARENTORGANISMACTIVE_02 | La lista de organismos de entrada está vacíaNo 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 |
---|
| ParamHistoricalParentParamOrganismActive param = new ParamHistoricalParent();
param.setApplicationId("SIU");
String[] organismList = { "ORG00002" } ParamOrganismActive();
param.setApplicationId("SIU");
param.setOrganismListsetOrganismActive(organismList"ORG07839");
ResultHistoricalParentResultOrganismActive result = client.historicalParentorganismActive(param);
|
|
Método '
...
organismActiveList'
...
...
Servicio que devuelve una lista con la estructura de organismos ascendientes y descendientes de los organismos pasados activos correspondiente a una lista de organismos pasada como parámetro.
Además de los datos de los organismos devueltos en la lista, devuelve el código del organismo buscadoDe 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 |
---|
|
SignaturaResultHistoricalTree historicalTree(ParamHistoricalTree paramHistoricalTreeResultOrganismActiveList organismActiveList(ParamOrganismActiveList paramOrganismActiveList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismListorganismActiveList | String[] | Lista de organismos a buscaractivos |
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 | historicalTreeListObjectorganismActiveListObject | Lista de objetos HistoricalTreeListObject (ver detalle de campos en el apartado de objetos comunes)OrganismActiveListObject |
Códigos error
Código | Descripción |
---|
HISTORICALORGANISMACTIVELIST_TREE_00 | Error durante la consulta de los datos | HISTORICAL_TREEORGANISMACTIVELIST_01 | El objeto paramAscendentOrganismBranchTree paramOrganismActiveList es nulo | HISTORICALORGANISMACTIVELIST_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 |
---|
| ParamHistoricalTreeParamOrganismActiveList param = new ParamHistoricalTreeParamOrganismActiveList();
param.setApplicationId("SIU");
String[] organismListorganismActiveList = { "ORG00002ORG07839" };
param.setOrganismListsetOrganismActiveList(organismListorganismActiveList);
ResultHistoricalTreeResultOrganismActiveList result = client.historicalTree(param);
|
|
Método 'getListUserExist'
...
.organismActiveList(param);
|
|
Método 'organismDataAndFirstLevelOfDescendentList'
...
Servicio que devuelve un listado de organismos descendientes directos de otro organismo pasado como parámetro y ese mismo organismo.
Permite filtrar por dirección, cif, ciudad, país, email, si es emisor, por datos extendidos, si es externo, el código del padre, el código sirhga del padre, por fecha de baja, por identidad fiscal, por fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, el nif del jefe del servicio, el nombre corto, el código sirhga del organismo y el teléfono.
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 |
---|
|
SignaturaResultUserExist getListUserExist(ParamUserExist paramUserExist);ResultOrganismDataAndFirstLevelOfDescendentList organismDataAndFirstLevelOfDescendentList(ParamOrganismDataAndFirstLevelOfDescendentList paramOrganismDataAndFirstLevelOfDescendentList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | listFiscalAnagramorganismCode | HashSet<String>String | Listado Código de | nifsorganismo | listNrpt | HashSet<String> | Listado de nrpts (identificadores del puesto en SIRHGAorganismSearch | 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 | listUserExist | List<UserExist> | Listado de UserExist | 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 |
---|
GET_LIST_USER_EXISTDIRECTDESCENDENTORGANISMLIST_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íoCó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 |
---|
| HashSet<String> listNifs = new HashSet<String>();
HashSet<String> listNrpts | ParamOrganismDataAndFirstLevelOfDescendentList param = new HashSet<String>ParamOrganismDataAndFirstLevelOfDescendentList();
ParamUserExist paramUserExist = new ParamUserExist(param.setApplicationId("SIU");
paramUserExistparam.setApplicationIdsetOrganismCode("SIUORG07839");
paramUserExist.setListFiscalAnagram(listNifs
OrganismSearch organismSearch = new OrganismSearch();
paramUserExistparam.setListNrptsetOrganismSearch(listNrptsorganismSearch);
//ResultOrganismDataAndFirstLevelOfDescendentList Consultamosresult la lista de nifs y nrpts en SIU
ResultUserExist result = client.getListUserExist(paramUserExist);
|
|
Método 'loginOrganismListByUser' #Deprecated
Servicio que devuelve un listado de los organismos en los que un usuario en estado de alta tiene roles.
...
= client.organismDataAndFirstLevelOfDescendentList(param);
|
|
Método 'organismDataAndFirstLevelOfDescendentListWithCode'
...
Servicio que devuelve un listado de organismos descendientes directos de otro organismo pasado como parámetro y ese mismo organismo.
Permite filtrar por dirección, cif, ciudad, país, email, si es emisor, por datos extendidos, si es externo, el código del padre, el código sirhga del padre, por fecha de baja, por identidad fiscal, por fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, el nif del jefe del servicio, el nombre corto, el código sirhga del organismo y el teléfono.
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 |
---|
|
SignaturaResultLoginOrganismListByUser loginOrganismListByUser(ParamLoginOrganismListByUser paramLoginOrganismListByUserResultOrganismDataAndFirstLevelOfDescendentListWithCode organismDataAndFirstLevelOfDescendentList(ParamOrganismDataAndFirstLevelOfDescendentList paramOrganismDataAndFirstLevelOfDescendentList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | userSearch | Objeto UserSearch 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 | loginOrganismByUserorganismList | Lista de objetos LoginOrganismByUser OrganismWithCode (ver ver detalle de campos en campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
LOGINORGANISMLISTBYUSERDIRECTDESCENDENTORGANISMLIST_00 | Código de error general para este servicio | LOGINORGANISMLISTBYUSERDIRECTDESCENDENTORGANISMLIST_01 | El objeto paramLoginOrganismListByUser es nulo | LOGINORGANISMLISTBYUSER_02 | No existen usuarios dados de alta con los parámetros de búsqueda establecidosparamOrganismDataAndFirstLevelOfDescendentList 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 |
---|
| ParamLoginOrganismListByUserParamOrganismDataAndFirstLevelOfDescendentList param = new ParamLoginOrganismListByUserParamOrganismDataAndFirstLevelOfDescendentList();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07839");
UserSearchOrganismSearch userSearchorganismSearch = new UserSearch();
userSearch.setNif("00000000T"OrganismSearch();
param.setUserSearchsetOrganismSearch(userSearchorganismSearch);
ResultLoginOrganismListByUserResultOrganismDataAndFirstLevelOfDescendentList result = client.loginOrganismListByUserorganismDataAndFirstLevelOfDescendentList(param);
|
|
Método '
...
organismDataAndFirstLevelOfDescendentListWithTypes' #Deprecated
...
Servicio que a partir de un código de un organismo activo, devuelve los datos de ese organismodevuelve un listado de organismos descendientes directos de otro organismo pasado como parámetro y ese mismo organismo.
Permite filtrar por dirección, cif, ciudad, país, email, si es emisor, por datos extendidos, si es externo, el código del padre, el código sirhga del padre, por fecha de baja, por identidad fiscal, por fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, el nif del jefe del servicio, el nombre corto, el código sirhga del organismo y el teléfono.
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 |
---|
|
SignaturaResultOrganismActive organismActive(ParamOrganismActive paramOrganismActiveResultOrganismDataAndFirstLevelOfDescendentListWithTypes organismDataAndFirstLevelOfDescendentListWithTypes(ParamOrganismDataAndFirstLevelOfDescendentList params) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismActiveorganismCode | 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 | organism | Objeto Organism (ver detalle de campos en | 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 |
---|
ORGANISMACTIVEDIRECTDESCENDENTORGANISMLIST_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_03Có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 | 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 |
---|
| ParamOrganismActiveParamOrganismDataAndFirstLevelOfDescendentList param = new ParamOrganismActiveParamOrganismDataAndFirstLevelOfDescendentList();
param.setApplicationId("SIU");
param.setOrganismActivesetOrganismCode("ORG07839ORG11625");
ResultOrganismActiveResultOrganismDataAndFirstLevelOfDescendentListWithTypes result = client.organismActiveorganismDataAndFirstLevelOfDescendentListWithTypes(param);
|
|
Método '
...
organismDescendListByType' #Deprecated
...
Servicio que devuelve una lista de organismos activos correspondiente a una lista de organismos pasada como parámetro.De cada organismo devuelto, devuelve: si es emisor, una lista con un listado de organismos, filtrando por código de tipificación, código de organismo, e indicando si se quiere consultar los organismos descendientes directos o todos los hijos.
Permite filtrar por dirección, cif, ciudad, país, email, si es emisor, por datos extendidos, si es externo, el código del organismo padre, el código sirhga del padre, la por fecha de baja, por identidad fiscal, la por fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, el nif del jefe del servicio, el nombre corto, el código del organismo, si es receptor y el nombre cortosirhga del organismo y el teléfono.
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 |
---|
|
SignaturaResultOrganismActiveList organismActiveList(ParamOrganismActiveList paramOrganismActiveListResultOrganismDescendListByType organismDescendListByType(ParamOrganismDescendListByType params) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método fiscalAnagram(obligatorio) | typeId | String | Código de tipificación (obligatorio) | organismCode | String | Anagrama fiscal | organismActiveListCódigo de organismo (opcional) | directSearch | String[]Lista de organismos activos | (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 | organismActiveListObjectorganismList | Lista de objetos OrganismActiveListObjectOrganismWithTypesOrdered (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ORGANISMACTIVELISTORGANISMDESCENDLISTBYTYPE_00 | Error durante la consulta de los datos | ORGANISMACTIVELISTCódigo de error general para este servicio | ORGANISMDESCENDLISTBYTYPE_01 | El objeto paramOrganismActiveList ParamOrganismDescendListByType es nulo | ORGANISMACTIVELISTORGANISMDESCENDLISTBYTYPE_02 | El parámetro typeId es nulo | La lista de organismos de entrada está vacíaORGANISMDESCENDLISTBYTYPE_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 |
---|
| ParamOrganismActiveListParamOrganismDescendListByType param = new ParamOrganismActiveListParamOrganismDescendListByType();
param.setApplicationId("SIU");
String[] organismActiveList =
{ "ORG07839" };
param.setOrganismActiveListsetTypeId(organismActiveList1);
ResultOrganismActiveListResultOrganismDescendListByType result = client.organismActiveListorganismDescendListByType(param);
|
|
Método '
...
organismList'
...
Servicio que devuelve un listado de organismos descendientes directos de otro organismo pasado como parámetro y ese mismo organismouna lista de organismos, según los parámetros de búsqueda introducidos. Además devuelve el tamaño de dicha lista.
Permite filtrar por dirección, cif, ciudad, país, email, si es emisor, por datos extendidos, si es externo, el código del padre, el código sirhga del padre, por fecha de baja, por identidad fiscal, por fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, el nif del jefe del servicio, el nombre corto, el código sirhga del organismo y el teléfono.
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 , y el nombre corto y el teléfono.
Expand |
---|
|
SignaturaResultOrganismDataAndFirstLevelOfDescendentList organismDataAndFirstLevelOfDescendentList(ParamOrganismDataAndFirstLevelOfDescendentList paramOrganismDataAndFirstLevelOfDescendentListResultOrganismList organismList(ParamOrganismList paramOrganismList) Parámetros de invocaciónNombre | 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 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 |
---|
DIRECTDESCENDENTORGANISMLISTORGANISMLIST_00 | Código de error general para este servicio | DIRECTDESCENDENTORGANISMLISTError durante la consulta de los datos de organismos | ORGANISMLIST_01 | El objeto paramOrganismDataAndFirstLevelOfDescendentList paramOrganismList es nulo | DESCENDENTORGANISMLISTORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | DIRECTDESCENDENTORGANISMLISTORGANISMLIST_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úsquedaHa 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 |
---|
| ParamOrganismDataAndFirstLevelOfDescendentListParamOrganismList param = new ParamOrganismDataAndFirstLevelOfDescendentListParamOrganismList();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07839");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07839");
param.setOrganismSearch(organismSearch);
ResultOrganismDataAndFirstLevelOfDescendentListResultOrganismList result = client.organismDataAndFirstLevelOfDescendentListorganismList(param);
|
|
Método '
...
organismListWithCode'
...
Servicio que devuelve un listado de organismos descendientes directos de otro organismo pasado como parámetro y ese mismo organismouna lista de organismos, según los parámetros de búsqueda introducidos. Además devuelve el tamaño de dicha lista.
Permite filtrar por dirección, cif, ciudad, país, email, si es emisor, por datos extendidos, si es externo, el código del padre, el código sirhga del padre, por fecha de baja, por identidad fiscal, por fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, el nif del jefe del servicio, el nombre corto, el código sirhga del organismo y el teléfono.
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 , y el nombre corto y el teléfono.
Expand |
---|
|
SignaturaResultOrganismDataAndFirstLevelOfDescendentListWithCode organismDataAndFirstLevelOfDescendentList(ParamOrganismDataAndFirstLevelOfDescendentList paramOrganismDataAndFirstLevelOfDescendentListResultOrganismList organismList(ParamOrganismList paramOrganismList) Parámetros de invocaciónNombre | 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 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 |
---|
DIRECTDESCENDENTORGANISMLISTORGANISMLIST_00 | Código de error general para este servicio | DIRECTDESCENDENTORGANISMLISTError durante la consulta de los datos de organismos | ORGANISMLIST_01 | El objeto paramOrganismDataAndFirstLevelOfDescendentList paramOrganismList es nulo | DESCENDENTORGANISMLISTORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | DIRECTDESCENDENTORGANISMLISTORGANISMLIST_03 | El código de organismo es nulo | DIRECTDESCENDENTORGANISMLISTHa ocurrido algún error al realizar la búsqueda | ORGANISMLIST_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úsquedaNo existe el organismo de entrada |
Ejemplo de invocación
Code Block |
---|
language | java |
---|
firstline | 1 |
---|
title | Ejemplo de invocación |
---|
collapse | true |
---|
| ParamOrganismDataAndFirstLevelOfDescendentListParamOrganismList param = new ParamOrganismDataAndFirstLevelOfDescendentListParamOrganismList();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07839");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07839");
param.setOrganismSearch(organismSearch);
ResultOrganismDataAndFirstLevelOfDescendentListResultOrganismListWithCode result = client.organismDataAndFirstLevelOfDescendentListorganismList(param);
|
|
Método '
...
organismList1'
...
...
Servicio que devuelve un listado de organismos descendientes directos de otro organismo pasado como parámetro y ese mismo organismouna lista de organismos con datos extendidos permitiendo una búsqueda compleja.
Permite filtrar por dirección, cif, ciudad, país, email, si es emisor, por datos extendidos, si es externo, el código del padre, el código sirhga del padre, por fecha de baja, por identidad fiscal, por fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, el nif del jefe del servicio, el nombre corto, el código sirhga del organismo y el teléfono.
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 , y el nombre corto, el teléfono y la lista de tipificaciones asociadas ordenadas por nivel.
Expand |
---|
|
SignaturaResultOrganismDataAndFirstLevelOfDescendentListWithTypes organismDataAndFirstLevelOfDescendentListWithTypes(ParamOrganismDataAndFirstLevelOfDescendentList paramsResultOrganismList organismList(ParamOrganismListWithComplexity paramOrganismListWithComplexity) Parámetros de invocaciónNombre | 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 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 OrganismWithTypesOrdered (ver detalle objetos Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
DIRECTDESCENDENTORGANISMLISTORGANISMLIST_00 | Código de error general para este servicio | DIRECTDESCENDENTORGANISMLISTError durante la consulta de los datos de organismos | ORGANISMLIST_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_06paramOrganismList 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 |
---|
| ParamOrganismDataAndFirstLevelOfDescendentListParamOrganismListWithComplexity param = new ParamOrganismDataAndFirstLevelOfDescendentListParamOrganismListWithComplexity();
param.setApplicationId("SIU");
OrganismSearchWithComplexity organismSearch = new OrganismSearchWithComplexity();
paramorganismSearch.setOrganismCode("ORG11625"ORG07839");
param.setOrganismSearch(organismSearch);
ResultOrganismDataAndFirstLevelOfDescendentListWithTypesResultOrganismList result = client.organismDataAndFirstLevelOfDescendentListWithTypesorganismList(param);
|
|
Método '
...
organismListByOrganismCodes'
...
...
Servicio que devuelve un listado de organismos de alta, filtrando buscando por un código de tipificación, código de organismo, e indicando si se quiere consultar los organismos descendientes directos o todos los hijos.
Permite filtrar por dirección, cif, ciudad, país, email, si es emisor, por datos extendidos, si es externo, el código del padre, el código sirhga del padre, por fecha de baja, por identidad fiscal, por fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, el nif del jefe del servicio, el nombre corto, el código sirhga del organismo y el teléfono.
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 activosorganismo y un listado de códigos de organismos.
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 |
---|
|
SignaturaResultOrganismDescendListByType organismDescendListByType(ParamOrganismDescendListByType paramsResultOrganismListByOrganismCodes organismListByOrganismCodes(ParamOrganismListByOrganismCodes paramOrganismListByOrganismCodes) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método (obligatorio) | typeIdfiscalAnagram | StringCódigo | de tipificación (obligatorio)Anagrama fiscal | organismCode | String | Código de organismo (opcional) | directSearchorganismCodeList | String(valores S o N, opcional en caso de rellenar organismCode, sino se rellena organismCode, el servicio no utilizará este campo)[] | 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 | size | int | Tamaño de la lista de organismos devuelta | organismList | Lista de objetos OrganismWithTypesOrdered Organism (ver detalle ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ORGANISMDESCENDLISTBYTYPEORGANISMLISTBYORGANISMCODES_00 | Código de error general para este servicio | ORGANISMDESCENDLISTBYTYPEORGANISMLISTBYORGANISMCODES_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_07paramOrganismListByOrganismCodes 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 |
---|
| ParamOrganismDescendListByTypeParamOrganismListByOrganismCodes param = new ParamOrganismDescendListByTypeParamOrganismListByOrganismCodes();
param.setApplicationId("SIU");
String[] organismCodeList = { "ORG07839" };
param.setTypeIdsetOrganismCodeList(1organismCodeList);
ResultOrganismDescendListByTypeResultOrganismListByOrganismCodes result = client.organismDescendListByTypeorganismListByOrganismCodes(param);
|
|
Método
...
Servicio que devuelve una lista de organismos, según los parámetros de búsqueda introducidos. Además devuelve el tamaño de dicha lista.
Permite filtrar por dirección, cif, ciudad, país, email, si es emisor, si es externo, el código del padre, el código sirhga del padre, por fecha de baja, por identidad fiscal, por fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, el nif del jefe del servicio, el nombre corto, el código sirhga del organismo y el teléfono.
...
'organismListByOrganismCodesAll'
...
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 |
---|
|
SignaturaResultOrganismList organismList(ParamOrganismList paramOrganismListResultOrganismListByOrganismCodesAll organismListByOrganismCodesAll(ParamOrganismListByOrganismCodesAll paramOrganismListByOrganismCodesAll) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagramorganismCodeList | String | Anagrama fiscal | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes)[] | 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 | size | int | Tamaño de la lista de organismos devuelta | organismList | Lista de objetos Organism (ver detalle ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ORGANISMLISTORGANISMLISTBYORGANISMCODESALL_00 | Error durante la consulta de los datos de organismos | ORGANISMLISTCódigo de error general para este servicio | ORGANISMLISTBYORGANISMCODESALL_01 | El objeto paramOrganismList paramOrganismListByOrganismCodes es nulo | ORGANISMLISTORGANISMLISTBYORGANISMCODESALL_02 | No se han encontrado organismos para estos parámetros de búsqueda | ORGANISMLIST_03La lista de organismos está vacía | ORGANISMLISTBYORGANISMCODESALL_03 | El campo applicationId está vacio | ORGANISMLISTBYORGANISMCODESALL_04 | Ha ocurrido algún error al realizar la búsquedaORGANISMLIST_04 | No existe el organismo de entrada |
Ejemplo de invocación
Code Block |
---|
language | java |
---|
firstline | 1 |
---|
title | Ejemplo de invocación |
---|
collapse | true |
---|
| ParamOrganismListParamOrganismListByOrganismCodesAll param = new ParamOrganismListParamOrganismListByOrganismCodesAll();
param.setApplicationId("SIU");
OrganismSearchString[] organismSearchorganismCodeList = new OrganismSearch();
organismSearch.setOrganismCode({ "ORG07839") };
param.setOrganismSearchsetOrganismCodeList(organismSearchorganismCodeList);
ResultOrganismListResultOrganismListByOrganismCodesAll result = client.organismListorganismListByOrganismCodesAll(param);
|
|
Método '
...
organismListWithDir3Code'
...
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.
Permite filtrar por dirección, cif, ciudad, país, email, si es emisor, si es externo, el código del padre, el código sirhga del padre, por fecha de baja, por identidad fiscal, por fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, el nif del jefe del servicio, el nombre corto, el código sirhga del organismo y el teléfono.
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 organismListResultOrganismDir3List organismListWithDir3Code(ParamOrganismList paramOrganismList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismSearch | Objeto OrganismSearch (ver detalle 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 OrganismWithCodeOrganism (ver detalle 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);
ResultOrganismListWithCodeResultOrganismDir3List result = client.organismListorganismListWithDir3Code(param);
|
|
Método '
...
organismTree'
...
Servicio que devuelve una lista de organismos con datos extendidos permitiendo una búsqueda compleja.
Permite filtrar por dirección, cif, ciudad, país, email, si es emisor, por datos extendidos, si es externo, el código del padre, el código sirhga del padre, por fecha de baja, por identidad fiscal, por fecha de alta, nombre, código nuevo de organismo, código de organismo, código postal, provincia, si es receptor, el nif del jefe del servicio, el nombre corto, el código sirhga del organismo y el teléfono.
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 cortoascendentes y descendentes de un organismo pasado como parámetro. Este listado se ordena por código de organismo.
Expand |
---|
|
SignaturaResultOrganismList organismList(ParamOrganismListWithComplexity paramOrganismListWithComplexityResultOrganismBranchTree organismTree(ParamOrganismBranchTree paramOrganismTree) Parámetros de invocaciónNombre | 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)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 Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ORGANISMLISTORGANISMTREE_00 | Error durante la consulta de los datos de organismos | ORGANISMLISTORGANISMTREE_01 | El objeto paramOrganismList paramOrganismTree es nulo | ORGANISMLISTORGANISMTREE_02 | No se han encontrado organismos para estos parámetros de búsqueda | ORGANISMLISTORGANISMTREE_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 |
---|
| ParamOrganismListWithComplexityParamOrganismBranchTree param = new ParamOrganismListWithComplexityParamOrganismBranchTree();
param.setApplicationId("SIU");
OrganismSearchWithComplexity organismSearch = new OrganismSearchWithComplexity();
organismSearchparam.setOrganismCode("ORG07839ORG07810");
param.setOrganismSearch(organismSearch);
ResultOrganismList ResultOrganismBranchTree result = client.organismListorganismBranchTree(param);
|
|
Método '
...
treeAncestralOrganismList' #Deprecated
...
Servicio que devuelve un listado de organismos de alta, buscando por un código de organismo y un listado de códigos de organismos. 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 bajaancestros de un árbol de organismos según el organismo pasado como parámetro.
Expand |
---|
|
SignaturaResultOrganismListByOrganismCodes organismListByOrganismCodes(ParamOrganismListByOrganismCodes paramOrganismListByOrganismCodesResultTreeAncestralOrganismList treeAncestralOrganismList(ParamTreeAncestralOrganismList paramTreeAncestralOrganismList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismCodeorgCode | String | Código de organismo | organismCodeList | String[] | Lista de códigos de organismos | 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 |
---|
ORGANISMLISTBYORGANISMCODESTREE_ANCESTRAL_ORGANISM_LIST_00 | Código de error general para este servicio | ORGANISMLISTBYORGANISMCODESHa ocurrido algún error inesperado | TREE_ANCESTRAL_ORGANISM_LIST_01 | El objeto paramOrganismListByOrganismCodes paramAncestralOrganismTree es nulo | ORGANISMLISTBYORGANISMCODESTREE_ANCESTRAL_ORGANISM_LIST_02 | La lista de organismos está vacía | ORGANISMLISTBYORGANISMCODES_03 | 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 para estos con esos parámetros de búsqueda | ORGANISMLISTBYORGANISMCODES_04TREE_ANCESTRAL_ORGANISM_LIST_05 | El organismo introducido no existe | ORGANISMLISTBYORGANISMCODES_05 | Ha ocurrido algún error al realizar la búsquedao está dado de baja |
Ejemplo de invocación
Code Block |
---|
language | java |
---|
firstline | 1 |
---|
title | Ejemplo de invocación |
---|
collapse | true |
---|
| ParamOrganismListByOrganismCodesParamTreeAncestralOrganismList param = new ParamOrganismListByOrganismCodesParamTreeAncestralOrganismList();
param.setApplicationId("SIU");
String[] organismCodeList =
{ "ORG07839" };
param.setOrganismCodeListsetOrgCode(organismCodeList"ORG14685");
ResultOrganismListByOrganismCodesResultTreeAncestralOrganismList result = client.organismListByOrganismCodestreeAncestralOrganismList(param);
|
|
Método '
...
rootFatherOrganismByOrganismCode'
...
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. para obtener el organismo padre raíz del árbol al que pertenece un determinado organismo.
Expand |
---|
|
SignaturaResultOrganismListByOrganismCodesAll organismListByOrganismCodesAll(ParamOrganismListByOrganismCodesAll paramOrganismListByOrganismCodesAllResultRootOrganismByOrganismCode rootFatherOrganismByOrganismCode(ParamRootFatherOrganismByOrganismCode paramRootFatherOrganism) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el métodoorganismCodeList | fiscalAnagram | String | Anagrama fiscal | organismCode | String | [] | Lista de códigos de organismos a consultarCó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 | organismListorganism | Lista de objetos Objeto Organism (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ORGANISMLISTBYORGANISMCODESALLORGANISMROOTFATHER_00 | Código de error general para este servicio | ORGANISMLISTBYORGANISMCODESALLError durante la consulta de los datos del padre raíz del organismo | ORGANISMROOTFATHER_01 | El objeto paramOrganismListByOrganismCodes paramRootFatherOrganism es nulo | ORGANISMLISTBYORGANISMCODESALLORGANISMROOTFATHER_02 | La lista de organismos está vacía | ORGANISMLISTBYORGANISMCODESALL_03 | El campo applicationId está vacio | ORGANISMLISTBYORGANISMCODESALL_04 | 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 |
---|
| ParamOrganismListByOrganismCodesAllParamRootFatherOrganismByOrganismCode param = new ParamOrganismListByOrganismCodesAllParamRootFatherOrganismByOrganismCode();
param.setApplicationId("SIU");
String[] organismCodeList = { "ORG07839" };
param.setOrganismCodeListsetOrganismCode(organismCodeList"ORG03324");
ResultOrganismListByOrganismCodesAllResultRootOrganismByOrganismCode result = client.organismListByOrganismCodesAllrootFatherOrganismByOrganismCode(param);
|
|
Método '
...
rootFatherOrganismList'
...
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.raíz.
Expand |
---|
|
SignaturaResultOrganismDir3List organismListWithDir3Code(ParamOrganismList paramOrganismListResultRootOrganismList rootFatherOrganismList(ParamRootFatherOrganismList paramRootFatherOrganismList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismSearch | Objeto 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 |
---|
| ParamOrganismListParamRootFatherOrganismList param = new ParamOrganismListParamRootFatherOrganismList();
param.setApplicationId("SIU");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07839");
param.setOrganismSearch(organismSearch");
ResultOrganismDir3ListResultRootOrganismList result = client.organismListWithDir3CoderootFatherOrganismList(param);
|
|
Búsquedas y consultas de datos extendidos
Método '
...
extendedDataList'
...
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 organismopara listar datos extendidos. Permite filtrar por nombre, código de organismo, valor y operador.
Devuelve un listado de datos extendidos con nombre, código de organismo y valor.
Expand |
---|
|
SignaturaResultOrganismBranchTree organismTree(ParamOrganismBranchTree paramOrganismTreeResultExtendedDataList extendedDataList(ParamExtendedDataList paramExtendedDataList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismCode | String | Código de organismoextendedDataListSearch | 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 | organismList size | int | Tamaño de la lista devuelta | extendedDataList | Lista de objetos Organismobjetos ExtendedDataAndOrganismCode (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ORGANISMTREEEXTENDED_DATA_LIST_00 | Error durante la consulta de los datos de organismosORGANISMTREEextendidos | EXTENDED_DATA_LIST_01 | El objeto paramOrganismTree paramExtendedDataList es nulo | ORGANISMTREEEXTENDED_DATA_LIST_02 | No se han encontrado organismos datos extendidos para estos parámetros de búsqueda | ORGANISMTREEEXTENDED_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 |
---|
| ParamOrganismBranchTreeParamExtendedDataList param = new ParamOrganismBranchTreeParamExtendedDataList();
param.setApplicationId("SIU");
paramExtendedDataListSearch extendedDataListSearch = new ExtendedDataListSearch();
extendedDataListSearch.setOrganismCode("ORG07810"ORG14343");
param.setExtendedDataListSearch(extendedDataListSearch);
ResultOrganismBranchTreeResultExtendedDataList result = client.organismBranchTreeextendedDataList(param);
|
|
Datos para histórico
Método '
...
getHistoricalDatesStructuralChanges'
...
...
Servicio que devuelve un listado de organismos ancestros de un árbol de organismos según el para listar las fechas históricas de cambios en la estructura de un organismo pasado como parámetro.
Expand |
---|
|
SignaturaResultTreeAncestralOrganismList treeAncestralOrganismList(ParamTreeAncestralOrganismList paramTreeAncestralOrganismListResultGetHistoricalDatesStructuralChanges getHistoricalDatesStructuralChanges(ParamGetHistoricalDatesStructuralChanges paramGetHistoricalDatesStructuralChanges) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | orgCodeorganismCode | 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 | dateListorganismList | Date[] | Lista de | objetos Organism (ver detalle de campos en el apartado de objetos comunes)fechas |
Códigos error
Código | Descripción |
---|
TREEGET_HISTORICAL_ANCESTRALDATES_ORGANISMSTRUCTURAL_LISTCHANGES_00 | Ha ocurrido algún error inesperado | TREE_ANCESTRAL_ORGANISM_LISTError durante la consulta de fechas de cambios de estructura | GET_HISTORICAL_DATES_STRUCTURAL_CHANGES_01 | El objeto paramAncestralOrganismTree paramGetHistoricalDatesStructuralChanges es nulo | TREEGET_HISTORICAL_ANCESTRALDATES_ORGANISMSTRUCTURAL_LISTCHANGES_02 | El código de organismo no puede ser es nulo | TREEGET_HISTORICAL_ANCESTRALDATES_ORGANISMSTRUCTURAL_LISTCHANGES_03Ha ocurrido algún tipo de error al realizar la búsqueda | TREE_ANCESTRAL_ORGANISM_LIST_04 | No se han encontrado organismos con esos fechas de cambios de estructura para estos parámetros de búsqueda | TREEGET_HISTORICAL_ANCESTRALDATES_ORGANISMSTRUCTURAL_LISTCHANGES_05El organismo no existe o está dado de baja04 | 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 |
---|
| ParamTreeAncestralOrganismListParamGetHistoricalDatesStructuralChanges param = new ParamTreeAncestralOrganismListParamGetHistoricalDatesStructuralChanges();
param.setApplicationId("SIU");
param.setFiscalAnagram("");
param.setOrgCodesetOrganismCode("ORG14685ORG00002");
ResultTreeAncestralOrganismListResultGetHistoricalDatesStructuralChanges result = client.treeAncestralOrganismListgetHistoricalDatesStructuralChanges(param);
;
|
|
Búsquedas y consultas de cargos
Método '
...
autentify'
...
Servicio para obtener el organismo padre raíz del árbol al que pertenece un determinado organismoque autentifica a un usuario a partir d un token firmado , el token original y el código del organismo. Si va bien, devuelve el usuario y los roles que este tiene.
Este servicio se usa para aquellas aplicaciones cuyo método de identificación de usuarios sea la firma de un token por parte del usuario y validación de esta firma en una plataforma de firma para obtener sus datos. Por ejemplo, identificación mediante componentes de firma cliente como Websigner o algún tipo de desarrollo propio de firma.
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 |
---|
|
SignaturaResultRootOrganismByOrganismCode rootFatherOrganismByOrganismCode(ParamRootFatherOrganismByOrganismCode paramRootFatherOrganismResultAutentify autentify(ParamAutentify paramAutentify) Parámetros de invocaciónNombre | 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 | organism | Objeto Organism 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 |
---|
ORGANISMROOTFATHERAUTENTIFY_00 | Error durante la consulta de los datos del padre raíz del organismoORGANISMROOTFATHERautentificación del usuario | AUTENTIFY_01 | El objeto paramRootFatherOrganism parámetro de entrada token 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ónAUTENTIFY_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 |
---|
| ParamRootFatherOrganismByOrganismCodeParamAutentify param = new ParamRootFatherOrganismByOrganismCodeParamAutentify();
param.setApplicationId("SIU");
param.setOrganismCode("ORG03324("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=");
ResultRootOrganismByOrganismCodeResultAutentify result = client.rootFatherOrganismByOrganismCodeautentify(param);
|
|
Método '
...
autentify1'
...
...
El servicio recupera la información del empleado público que se está autenticando y devuelve el resultado de la operación.
Este servicio autentifica a un usuario a partir del anagrama fiscal del mismo y del código de organismo al que pertenece.
Devuelve la información del usuario y de los roles que tiene ese usuario.
Expand |
---|
|
SignaturaResultRootOrganismList rootFatherOrganismList(ParamRootFatherOrganismList paramRootFatherOrganismListResultAutentify autentify(ParamAutentifyWithFiscalAnagram paramAutentifyWithFiscalAnagram) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismCode | organismSearch | Objeto OrganismSearch (ver detalle de campos en el apartado de objetos comunes)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 | size | int | Tamaño de la lista de organismos devuelta | organismListuser | Objeto User (ver detalle de campos en el apartado de objetos comunes) | roles | Lista de objetos Organism Role (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ORGANISMLISTAUTENTIFY_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 entradala 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 |
---|
| ParamRootFatherOrganismListParamAutentifyWithFiscalAnagram param = new ParamRootFatherOrganismListParamAutentifyWithFiscalAnagram();
param.setApplicationId("SIU");
param.setFiscalAnagram("00000000T");
param.setOrganismCode("ORG07603");
ResultRootOrganismListResultAutentify result = client.rootFatherOrganismListautentify(param);
|
|
...
Método '
...
autentify2'
...
Servicio para listar datos extendidos. Permite filtrar por nombre, código de organismo, valor y operador.Devuelve un listado de datos extendidos con nombre, código de organismo y valorque autentica a un usuario a partir del token y token original sin organismo. Si va bien, devuelve la información del usuario y los roles que tiene este usuario.
Este servicio se usa para aquellas aplicaciones cuyo método de identificación de usuarios sea la firma de un token por parte del usuario y validación de esta firma en una plataforma de firma para obtener sus datos. Por ejemplo, identificación mediante componentes de firma cliente como Websigner o algún tipo de desarrollo propio de firma.
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 |
---|
|
SignaturaResultExtendedDataList extendedDataList(ParamExtendedDataList paramExtendedDataListResultAutentify autentify(ParamAutentifyWithoutOrganism paramAutentifyWithoutOrganism) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | token | extendedDataListSearch | Campos del objeto ExtendedDataListSearch (ver detalle de campos en el apartado de objetos comunes)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 | extendedDataList | user | Objeto User (ver detalle de campos en el apartado de objetos comunes) | roles | Lista de objetos ExtendedDataAndOrganismCode objetos Role (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
EXTENDED_DATAAUTENTIFY_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ónautentificació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 |
---|
| ParamExtendedDataListParamAutentifyWithoutOrganism param = new ParamExtendedDataListParamAutentifyWithoutOrganism();
param.setApplicationId("SIU");
ExtendedDataListSearch extendedDataListSearch = new ExtendedDataListSearch();
extendedDataListSearch.setOrganismCode("ORG14343");
param.setExtendedDataListSearch(extendedDataListSearch);
ResultExtendedDataList");
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.extendedDataListautentify(param);
|
|
Datos para histórico
Método '
...
activeRoleListByOrganismCode'
...
Servicio para listar las fechas históricas de cambios en la estructura que devuelve los datos de los cargos activos de un organismo pasado como parámetro.
Expand |
---|
|
SignaturaResultGetHistoricalDatesStructuralChanges getHistoricalDatesStructuralChanges(ParamGetHistoricalDatesStructuralChanges paramGetHistoricalDatesStructuralChangesResultRoleListByOrganismCode activeRoleListByOrganismCode(ParamRoleListByOrganismCode paramRoleListByOrganismCode) Parámetros de invocaciónNombre | 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 | dateListroles | Date[] | Lista de fechasLista de objetos RoleWithRoleTypeCode (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
GET_HISTORICAL_DATES_STRUCTURAL_CHANGES_ROLELISTBYORGANISMCODE_00 | Error durante la consulta de fechas de cambios de estructuraGET_HISTORICAL_DATES_STRUCTURAL_CHANGESlos datos de cargos | ROLELISTBYORGANISMCODE_01 | El objeto paramGetHistoricalDatesStructuralChanges paramRoleListByOrganismCode es nulo | GET_HISTORICAL_DATES_STRUCTURAL_CHANGES_02ROLELISTBYORGANISMCODE_03 | 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_04organismo 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 |
---|
| ParamGetHistoricalDatesStructuralChangesaramRoleListByOrganismCode param = new ParamGetHistoricalDatesStructuralChanges();
param.setApplicationId("SIU"ParamRoleListByOrganismCode();
param.setFiscalAnagramsetApplicationId("SIU");
param.setOrganismCode("ORG00002ORG07603");
ResultGetHistoricalDatesStructuralChangesResultRoleListByOrganismCode result = client.getHistoricalDatesStructuralChangesactiveRoleListByOrganismCode(param);
|
|
...
Método '
...
roleList'
...
Servicio que autentifica a un usuario a partir d un token firmado , el token original y el código del organismo. Si va bien, devuelve el usuario y los roles que este tiene.
Este servicio se usa para aquellas aplicaciones cuyo método de identificación de usuarios sea la firma de un token por parte del usuario y validación de esta firma en una plataforma de firma para obtener sus datos. Por ejemplo, identificación mediante componentes de firma cliente como Websigner o algún tipo de desarrollo propio de firma.
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 servicioun listado de cargos encontrados, según los parámetros de búsqueda introducidos.
Devuelve también el tamaño del resultado de cargos encontrados.
Expand |
---|
|
SignaturaResultAutentify autentify(ParamAutentify paramAutentifyResultRoleList roleList(ParamRoleList paramRoleList) Parámetros de invocaciónNombre | 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 | 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 | user | Objeto User (ver detalle de campos en el apartado de objetos comunes)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 |
---|
AUTENTIFYROLELIST_00 | Error durante la autentificación del usuarioAUTENTIFYconsulta de los datos de cargos | ROLELIST_01 | El parámetro de entrada token objeto paramRoleList es nulo | AUTENTIFYROLELIST_02 | El parámetro de entrada organismCode es nulo | AUTENTIFYNo se han encontrado cargos para estos parámetros de búsqueda | ROLELIST_03 | Ha ocurrido algún error al verificar realizar la firmabúsqueda | AUTENTIFYROLELIST_04 | El funcionario no existe en la bd | AUTENTIFY_05 | El funcionario ha sido dado de baja de la bd | AUTENTIFY_06código de organismo es nulo | ROLELIST_05 | 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 firmabase 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 |
---|
| ParamAutentifyParamRoleList param = new ParamAutentifyParamRoleList();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07603"
RoleSearch roleSearch = new RoleSearch();
paramroleSearch.setOriginalTokensetFiscalAnagram("RnJpIEp1biAwMiAxMjoxNTozOCBDRVNUIDIwMTc=00000000T");
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=");
ResultAutentifysetRoleSearch(roleSearch);
ResultRoleList result = client.autentifyroleList(param);
|
|
Método '
...
roleList1'
...
El servicio recupera la información del empleado público que se está autenticando y devuelve el resultado de la operación.
Este servicio autentifica a un usuario a partir del anagrama fiscal del mismo y del código de organismo al que pertenece.
...
...
Servicio que devuelve un listado de roles de un organismo y sus descendientes.
Expand |
---|
|
SignaturaResultAutentify autentify(ParamAutentifyWithFiscalAnagram paramAutentifyWithFiscalAnagramResultRoleList roleList(ParamRoleListByDescendentOrganism paramRoleListByDescendentOrganism) Parámetros de invocaciónNombre | 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 usuarioroleSearch | 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 | user | Objeto User (ver detalle de campos en el apartado de objetos comunes)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 |
---|
AUTENTIFYROLELIST_00 | Error durante la autentificación del usuarioAUTENTIFYconsulta de los datos de cargos | ROLELIST_01 | El parámetro de entrada token objeto paramRoleList es nulo | AUTENTIFYROLELIST_02 | El parámetro de entrada organismCode es nulo | AUTENTIFYNo se han encontrado cargos para estos parámetros de búsqueda | ROLELIST_03 | Ha ocurrido algún error al verificar realizar la firmabúsqueda | AUTENTIFYROLELIST_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 nulocó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 |
---|
| ParamAutentifyWithFiscalAnagramaramRoleListByDescendentOrganism param = new ParamAutentifyWithFiscalAnagramParamRoleListByDescendentOrganism();
param.setApplicationId("SIU");
RoleSearch roleSearch = new RoleSearch();
paramroleSearch.setFiscalAnagram("00000000T");
paramroleSearch.setOrganismCode("ORG07603"ORG14685");
param.setRoleSearch(roleSearch);
ResultAutentifyResultRoleList result = client.autentifyroleList(param);
|
|
Método '
...
roleListByFiscalAnagrams'
...
...
Servicio que autentica a un usuario a partir del token y token original sin organismo. Si va bien, devuelve la información del usuario y los roles que tiene este usuario.
Este servicio se usa para aquellas aplicaciones cuyo método de identificación de usuarios sea la firma de un token por parte del usuario y validación de esta firma en una plataforma de firma para obtener sus datos. Por ejemplo, identificación mediante componentes de firma cliente como Websigner o algún tipo de desarrollo propio de firma.
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 serviciodevuelve el listado de cargos de usuarios, buscando por sus anagramas fiscales, agrupando la respuesta por los usuarios consultados.
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 |
---|
|
SignaturaResultAutentify autentify(ParamAutentifyWithoutOrganism paramAutentifyWithoutOrganismResultRoleListByFiscalAnagrams roleListByFiscalAnagrams(ParamRoleListByFiscalAnagrams paramRoleListByFiscalAnagrams) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagramfiscalAnagramList | String | Anagrama fiscal | token | String | Token firmado por el certificado del usuario | originalToken | String | Token original | [] | 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 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ón
Necesito datos con los que responda correctamente, con estos da error de validación de firmaerror 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 |
---|
|
ParamAutentifyWithoutOrganismParamRoleListByFiscalAnagrams param = new ParamAutentifyWithoutOrganismParamRoleListByFiscalAnagrams();
param.setApplicationId("SIU");
param.setOriginalToken("RnJpIEp1biAwMiAxMjoxNTozOCBDRVNUIDIwMTc=")String[] fiscalAnagramList = { "11223344B" };
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=");
ResultAutentifysetFiscalAnagramList List(fiscalAnagramList );
ResultOrganismListByOrganismCodesAll result = client.autentifyroleListByFiscalAnagrams(param);
|
Método '
...
roleListByOrganismCode'
...
Servicio que devuelve los datos un listado de los cargos activos con el tipo de cargo, de un organismo.
Expand |
---|
|
SignaturaResultRoleListByOrganismCode activeRoleListByOrganismCoderoleListByOrganismCode(ParamRoleListByOrganismCode paramRoleListByOrganismCode) Parámetros de invocaciónNombre | 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 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 |
---|
| aramRoleListByOrganismCodeParamRoleListByOrganismCode param = new ParamRoleListByOrganismCode();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07603ORG14685");
ResultRoleListByOrganismCode result = client.activeRoleListByOrganismCoderoleListByOrganismCode(param);
|
|
Método '
...
roleListByOrganismdescendantBranchInUserList'
...
Servicio que devuelve un listado de cargos encontrados, según los parámetros de búsqueda introducidos.Devuelve también el tamaño del resultado de cargos encontradosroles de un organismo activo y sus descendientes filtrando mediante una lista de nifs.
Expand |
---|
|
SignaturaResultRoleList roleList(ParamRoleList paramRoleListResultRoleListByOrganismdescendantBranchInUserList roleListByOrganismdescendantBranchInUserList(ParamRoleListByOrganismdescendantBranchInUserList paramRoleListByOrganismdescendantBranchInUserList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscalfiscal | 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 paramRoleList 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 |
---|
| ParamRoleListParamRoleListByOrganismdescendantBranchInUserList param = new ParamRoleListParamRoleListByOrganismdescendantBranchInUserList();
param.setApplicationId("SIU");
RoleSearchString[] roleSearchlstNifs = { new RoleSearch()"00000000T" };
roleSearchparam.setFiscalAnagramsetNifs("00000000T"lstNifs);
param.setRoleSearchsetOrganismCode(roleSearch"ORG00001");
ResultRoleListResultRoleListByOrganismdescendantBranchInUserList result = client.roleListroleListByOrganismdescendantBranchInUserList(param);
|
|
Método '
...
roleListWithRoleTypeCode' #Deprecated
...
Servicio que devuelve un listado de roles de un organismo y sus descendientesincluyendo el campo roleTypeCode que cumplen una serie de parámetros de búsqueda.
Expand |
---|
|
SignaturaResultRoleList roleList(ParamRoleListByDescendentOrganism paramRoleListByDescendentOrganismResultRoleListWithRoleTypeCode roleListWithRoleTypeCode(ParamRoleListWithRoleTypeCode paramRoleListWithRoleTypeCode) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | roleSearchroleSearchWithRoleTypeCode | Objeto RoleSearch 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 Role RoleWithRoleTypeCode (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ROLELISTROLELISTWITHROLETYPECODE_00 | Error durante la consulta de los datos de cargos | ROLELISTROLELISTWITHROLETYPECODE_01 | El objeto paramRoleList paramRoleListWithRoleTypeCode es nulo | ROLELISTROLELISTWITHROLETYPECODE_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 datos02 | 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 |
---|
| aramRoleListByDescendentOrganismParamRoleListWithRoleTypeCode param = new ParamRoleListByDescendentOrganismParamRoleListWithRoleTypeCode();
param.setApplicationId("SIU");
RoleSearchRoleSearchWithRoleTypeCode roleSearchroleSearchWithRoleTypeCode = new RoleSearchRoleSearchWithRoleTypeCode();
roleSearchroleSearchWithRoleTypeCode.setFiscalAnagramsetOrganismCode("00000000TORG14685");
roleSearchroleSearchWithRoleTypeCode.setOrganismCodesetRoleCode("ORG14685ROL50563");
roleSearchWithRoleTypeCode.setRoleTypeCode(new Long(1));
param.setRoleSearchsetRoleSearchWithRoleTypeCode(roleSearchroleSearchWithRoleTypeCode);
ResultRoleListResultRoleListWithRoleTypeCode result = client.roleListroleListWithRoleTypeCode(param);
|
|
Método '
...
roleTypeList'
...
Servicio que devuelve el un listado de cargos de usuarios, buscando por sus anagramas fiscales, agrupando la respuesta por los usuarios consultados.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 encontradaroles según los parámetros de búsqueda introducidos.
Expand |
---|
|
SignaturaResultRoleListByFiscalAnagrams roleListByFiscalAnagrams(ParamRoleListByFiscalAnagrams paramRoleListByFiscalAnagramsResultRoleTypeList roleTypeList(ParamRoleTypeList paramRoleTypeList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagramListfiscalAnagram | String[]Lista de códigos de anagramas fiscales | 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 de usuarios devuelta | roleListByUserrolesType | Lista de objetos RoleListByFiscalAnagram objetos RoleType (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ROLELISTBYFISCALANAGRAMSROLETYPELIST_00 | Código de error general para este servicio | ROLELISTBYFISCALANAGRAMSError durante la consulta de los datos de cargos | ROLETYPELIST_01 | El objeto paramRoleListByFiscalAmagrams paramRoleTypeList es nulo | ROLELISTBYFISCALANAGRAMSROLETYPELIST_02 | La lista de fiscal_anagram está vacía | ROLELISTBYFISCALANAGRAMS_03 | El campo applicationId está vacio | ROLELISTBYFISCALANAGRAMS_04 | No hay roles con ese fiscal_anagramNo 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 |
---|
| ParamRoleListByFiscalAnagramsParamRoleTypeList param = new ParamRoleListByFiscalAnagramsParamRoleTypeList();
param.setApplicationId("SIU");
String[]RoleTypeSearch fiscalAnagramListroleTypeSearch = { "11223344B" }new RoleTypeSearch();
param.setFiscalAnagramList List(fiscalAnagramList setRoleTypeSearch(roleTypeSearch);
ResultOrganismListByOrganismCodesAllResultRoleTypeList result = client.roleListByFiscalAnagramsroleTypeList(param);
|
|
Búsqueda y consulta de usuarios
Método '
...
getUserInformation'
...
Servicio para obtener un listado de usuarios. Permite filtrar por código de organismo, por código de rol, por email, anagrama fiscal, nombre, nif, estado y apellidos.
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 |
---|
|
SignaturaResultRoleListByOrganismCode roleListByOrganismCode(ParamRoleListByOrganismCode paramRoleListByOrganismCodeResultGetUserInformation getUserInformation(ParamGetUserInformation paramGetUserInformation) Parámetros de invocaciónNombre | 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 | rolesuserInfoList | Lista de objetos RoleWithRoleTypeCode UserInformation (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ROLELISTBYORGANISMCODEGET_USER_INFORMATION_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_03datos 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 |
---|
| ParamRoleListByOrganismCodeParamGetUserInformation param = new ParamRoleListByOrganismCodeParamGetUserInformation();
param.setApplicationId("SIU");
UserSearch search = new UserSearch();
paramsearch.setOrganismCodesetNif("ORG1468500000000T");
ResultRoleListByOrganismCodeparam.setUserSearch(search);
ResultGetUserInformation result = client.roleListByOrganismCodegetUserInformation(param);
|
|
Método '
...
getUserInformationByPernrAndCertPseudonym'
...
Servicio que devuelve para obtener un listado de roles de un organismo activo y sus descendientes filtrando mediante una lista de nifsusuarios. Permite filtrar por anagrama fiscal, nif, pernr y certificado pseudonimo.
De cada usuario devuelto, devuelve email, anagrama fiscal, nombre, nif, estado, apellidos, pernr y certificado pseudonimo, 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 |
---|
|
SignaturaResultRoleListByOrganismdescendantBranchInUserList roleListByOrganismdescendantBranchInUserList(ParamRoleListByOrganismdescendantBranchInUserList paramRoleListByOrganismdescendantBranchInUserListResultGetUserInformationByExtendedData getUserInformationByPernrAndCertPseudonym(ParamGetUserInformationByExtendedData paramGetUserInformation) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismCodecertPseudonym | String | Código de organismo | nifs | String[] | Lista de nifs | roleSearch | Objeto RoleSearch (ver detalle de campos en el apartado de objetos comunes)del certificado pseudonimo | pernr | Integer | Código pernr |
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 | rolesUserJobInformationWithExtendedData | Lista de objetos Role objetos UserJobInformationWithExtendedData (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ROLELIST_BY_ORGANISM_DESCENDENT_IN_GET_USER_LISTINFORMATION_00 | Error durante la consulta de los datos de cargosROLELIST_BY_ORGANISM_DESCENDENT_IN_USER_LISTfuncionarios | GET_USER_INFORMATION_01 | El objeto paramRoleListByOrganismdescendantBranchInUserList ParamGetUserInformation es nulo | ROLELIST_BY_ORGANISM_DESCENDENT_INGET_USER_LISTINFORMATION_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íaEl 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 |
---|
| ParamRoleListByOrganismdescendantBranchInUserListParamGetUserInformationByExtendedData param = new ParamRoleListByOrganismdescendantBranchInUserListParamGetUserInformationByExtendedData();
param.setApplicationId("SIU");
String[] lstNifs = { param.setFiscalAnagram("00000000T" });
param.setNifssetCertPseudonym(lstNifs"codigo");
param.setOrganismCodesetPernr("ORG00001"100);
ResultRoleListByOrganismdescendantBranchInUserListResultGetUserInformationByExtendedData result = client.roleListByOrganismdescendantBranchInUserListgetUserInformationByPernrAndCertPseudonym(param);
|
|
Método '
...
getUserInformationJobs'
...
...
Servicio que devuelve un listado de roles incluyendo el campo roleTypeCode que cumplen una serie de parámetros de búsquedapara obtener los datos de un usuario.
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 |
---|
|
SignaturaResultRoleListWithRoleTypeCode roleListWithRoleTypeCode(ParamRoleListWithRoleTypeCode paramRoleListWithRoleTypeCodeResultGetUserInformationJobs getUserInformationJobs(ParamGetUserInformationJobs paramGetUserInformationJobs) Parámetros de invocaciónNombre | 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)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 | roles | Lista de objetos RoleWithRoleTypeCode userJobInformation | objeto UserJobInformation(ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ROLELISTWITHROLETYPECODEGET_USERJOBS_INFORMATION_00 | Error durante la consulta de los datos de cargosROLELISTWITHROLETYPECODE | GET_USER_INFORMATION_01 | El objeto paramRoleListWithRoleTypeCode ParamGetUserInformationJob 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úsquedaGET_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 |
---|
| ParamRoleListWithRoleTypeCodeParamGetUserInformationJobs param = new ParamRoleListWithRoleTypeCodeParamGetUserInformationJobs();
param.setApplicationId("SIU");
RoleSearchWithRoleTypeCode roleSearchWithRoleTypeCode = new RoleSearchWithRoleTypeCode();
roleSearchWithRoleTypeCode.setOrganismCode("ORG14685param.setFiscalAnagram("00000000T");
roleSearchWithRoleTypeCode.setRoleCode("ROL50563");
roleSearchWithRoleTypeCode.setRoleTypeCode(new Long(1));
param.setRoleSearchWithRoleTypeCode(roleSearchWithRoleTypeCode);
ResultRoleListWithRoleTypeCode result ResultGetUserInformationJobsresult = client.roleListWithRoleTypeCodegetUserInformationJobs(param);
|
|
Método '
...
getUserJobs'
...
Servicio que devuelve un listado de roles una lista de puestos asociados a empleados y roles, según los parámetros de búsqueda introducidos. Además devuelve el tamaño de dicha lista.
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 |
---|
|
SignaturaResultRoleTypeList roleTypeList(ParamRoleTypeList paramRoleTypeListResultGetUserJobs getUserJobs(ParamGetUserJobs paramGetUserJobs) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | roleTypeSearchuserJobSearch | Objeto RoleTypeSearch UserJobSearch(ver detalle 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 | rolesTypejobList | Lista Listado de objetos RoleType UserJobRolesV (ver detalle ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
ROLETYPELISTGET_USERJOBS_00 | Error durante la consulta de los datos de cargosROLETYPELIST | GET_USERJOBS_01 | El objeto | paramRoleTypeList ParamGetUserJobs es nulo | ROLETYPELISTGET_USERJOBS_02 | No se han encontrado cargos para estos parámetros de búsqueda | ROLETYPELIST_03 | Ha ocurrido algún error al realizar la búsquedaEl 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 |
---|
| ParamRoleTypeListParamGetUserJobs param = new ParamRoleTypeListParamGetUserJobs();
param.setApplicationId("SIU");
RoleTypeSearchUserJobSearch roleTypeSearchuserJobSearch = new RoleTypeSearch( UserJobSearch();
userJobSearch.setCheckDescendant(0);
userJobSearch.setIsfrh(2);
paramparamGetUserJobs.setRoleTypeSearchsetUserJobSearch(roleTypeSearchuserJobSearch);
ResultRoleTypeListResultGetUserJobs result = client.roleTypeListgetUserJobs(param);
|
|
...
Método '
...
userList'
...
Servicio para obtener que devuelve un listado de usuarios. Permite filtrar por código de organismo, por código de rol, por email, anagrama fiscal, nombre, nif, estado y apellidos.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 usuariopasando parámetros de búsqueda pero no es necesario.
Expand |
---|
|
SignaturaResultGetUserInformation getUserInformation(ParamGetUserInformation paramGetUserInformationResultUserList userList(ParamUserList paramUserList) Parámetros de invocaciónNombre | 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 | userInfoListuserList | Lista de objetos UserInformation User (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
GET_USER_INFORMATIONUSERLIST_00 | Error durante la consulta de los datos de funcionarios | GETUSERLIST_USER_INFORMATION_01 | El objeto ParamGetUserInformation paramUserList es nulo | GET_USER_INFORMATIONUSERLIST_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_INFORMATIONNo 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 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úsquedano 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 |
---|
| ParamGetUserInformationParamUserList param = new ParamGetUserInformationParamUserList();
param.setApplicationId("SIU");
UserSearch searchuserSearch = new UserSearch();
searchuserSearch.setNif("00000000T");
param.setUserSearch(searchuserSearch);
ResultGetUserInformationResultUserList result = client.getUserInformationuserList(param);
|
|
Método '
...
userList1'
...
Servicio para obtener los datos de un usuario.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 puestosque devuelve un listado de usuarios filtrando por un organismo pasado como parámetro.
Expand |
---|
|
SignaturaResultGetUserInformationJobs getUserInformationJobs(ParamGetUserInformationJobs paramGetUserInformationJobsResultUserList userList(ParamUserListByOrganism paramUserListByOrganism) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal del usuario a consultar | 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 | userJobInformation | objeto UserJobInformationuserList | Lista de objetos User (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 usuarioCó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 |
---|
| ParamGetUserInformationJobsParamUserListByOrganism param = new ParamGetUserInformationJobsParamUserListByOrganism();
param.setApplicationId("SIU");
param.setFiscalAnagramsetOrganismCode("ORG07603");
UserSearch userSearch = new UserSearch();
userSearch.setNif("00000000T");
param.setUserSearch(userSearch);
ResultGetUserInformationJobsresultResultUserList result = client.getUserInformationJobsuserList(param);
|
|
Método '
...
userList2'
...
Servicio que devuelve una lista de puestos asociados a empleados y roles, según los parámetros de búsqueda introducidos. Además devuelve el tamaño de dicha lista.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 empleadode usuarios correspondientes a un organismo.
Expand |
---|
|
SignaturaResultGetUserJobs getUserJobs(ParamGetUserJobs paramGetUserJobsResultUserListWithPhone userList(ParamUserListByOrganismWithPhone paramUserListByOrganism) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | userJobSearchuserSearchWithPhone | Objeto UserJobSearch(ver detalle 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 | jobListuserList | Listado Lista de objetos UserJobRolesV (ver detalle objetos UserWithPhone (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
GETUSERLIST_USERJOBS_00 | Error durante la consulta | GET_USERJOBSde los datos de funcionarios | USERLIST_01 | El objeto | ParamGetUserJobs paramUserList es nulo | GET_USERJOBSUSERLIST_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 unidadesNo 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 |
---|
| ParamGetUserJobsParamUserListByOrganismWithPhone param = new ParamGetUserJobsParamUserListByOrganismWithPhone();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
UserJobSearchUserSearchWithPhone userJobSearchuserSearch = new UserJobSearch();
userJobSearch.setCheckDescendant(0);
userJobSearch.setIsfrh(2new UserSearchWithPhone();
paramGetUserJobsparam.setUserJobSearchsetUserSearchWithPhone(userJobSearchuserSearch);
ResultGetUserJobsResultUserListWithPhone result = client.getUserJobsuserList(param);
|
|
Método '
...
userList3'
...
Servicio que devuelve un listado de usuarios. Permite filtrar pasando parámetros de búsqueda pero no es necesario, de acuerdo con los parámetros de búsqueda introducidos, teniendo en cuenta el campo mobilePhone.
Devuelve igualmente el tamaño de usuarios encontrados.
Expand |
---|
|
SignaturaResultUserList ResultUserListWithPhone userList(ParamUserList paramUserListParamUserListWithPhone paramUserListWithPhone) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | userSearch | Objeto UserSearch 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 User 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 |
---|
| ParamUserListParamUserListWithPhone param = new ParamUserListParamUserListWithPhone();
param.setApplicationId("SIU");
UserSearchUserSearchWithPhone userSearch = new UserSearchUserSearchWithPhone();
userSearch.setNif("00000000T");
param.setUserSearch(userSearch);
ResultUserListResultUserListWithPhone result = client.userList(param);
|
|
Método '
...
userListWithPhoneGenderNoteAndPernrCertPseudonym'
...
Servicio que devuelve un listado de usuarios filtrando por un organismo pasado como parámetro.una lista de según los parametros de busqueda
Expand |
---|
|
SignaturaResultUserList userList(ParamUserListByOrganism paramUserListByOrganismResultUserListWithPhoneGenderNoteAndExtendedData userListWithPhoneGenderNoteAndPernrCertPseudonym( ParamUserListWithPhoneGenderNoteAndExtendedData param) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismCode | String | Código de organismo | userSearchUserSearchExtendedData | Objeto UserSearch UserSearchExtendedData (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 | userListUserWithExtendedData | Lista de objetos User (objetos UserWithExtendedData 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 |
---|
| ParamUserListByOrganismParamUserListWithPhoneGenderNoteAndExtendedData param = new ParamUserListByOrganismParamUserListWithPhoneGenderNoteAndExtendedData();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07603ORG07810");
UserSearchUserSearchExtendedData userSearch = new UserSearchUserSearchExtendedData();
userSearch.setNif("00000000T");
param.setUserSearchsetUserSearchWithPhone(userSearch);
ResultUserListResultUserListWithPhoneGenderNoteAndExtendedData result = client.userListuserListWithPhoneGenderNoteAndPernrCertPseudonym(param);
|
|
Método '
...
userListByAncestralOrganism'
...
Servicio que devuelve una lista de usuarios correspondientes a de un organismo ancestro pasado como parámetro y de todos sus hijos.
Expand |
---|
|
SignaturaResultUserListWithPhone userList(ParamUserListByOrganismWithPhone paramUserListByOrganismResultUserListByAncestralOrganism userListByAncestralOrganism(ParamUserListByAncestralOrganism paramUserListByAncestralOrganism) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | userSearchWithPhone | Objeto UserSearchWithPhone | 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 UserWithPhone User (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
USERLISTUSERLISTBYANCESTRALORGANISM_00 | Error durante la consulta de los datos usuarios de funcionariosun organismo ancestro | USERLISTORGANISMLISTBYANCESTRALORGANIM_01 | El objeto paramUserList paramUserListByAncestralOrganism es nulo | USERLISTORGANISMLISTBYANCESTRALORGANIM_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 | USERLISTEl 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 código del organismo no puede estar vacíoUSERLISTorganismo 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 | USERLISTORGANISMLISTBYANCESTRALORGANIM_0607 | El organismo ancestro del que se quiere obtener la lista de usuarios esta dado de baja | USERLIST_07 | No existen usuarios para ese organismoORGANISMLISTBYANCESTRALORGANIM_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 |
---|
| ParamUserListByOrganismWithPhoneParamUserListByAncestralOrganism param = new ParamUserListByOrganismWithPhoneParamUserListByAncestralOrganism();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
UserSearchWithPhoneUserSearch userSearch = new UserSearchWithPhoneUserSearch();
param.setUserSearchWithPhonesetUserSearch(userSearch);
ResultUserListWithPhoneResultUserListByAncestralOrganism result = client.userListuserListByAncestralOrganism(param);
|
|
Método '
...
userListByAncestralOrganism1'
...
Servicio que devuelve un listado de usuarios , de acuerdo con los parámetros de búsqueda introducidos, teniendo en cuenta el campo mobilePhone.Devuelve igualmente el tamaño de usuarios encontradosde un organismo ancestro y sus hijos.
Expand |
---|
|
SignaturaResultUserListWithPhone userList(ParamUserListWithPhone paramUserListWithPhoneResultUserListByAncestralOrganismWithPhone userListByAncestralOrganism(ParamUserListByAncestralOrganismWithPhone paramUserListByAncestralOrganism) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | userSearch | Objeto | 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 | userListuserListWithPhone | Lista de objetos UserWithPhone (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
USERLISTUSERLISTBYANCESTRALORGANISM_00 | Error durante la consulta de los datos usuarios de funcionariosun organismo ancestro | USERLISTORGANISMLISTBYANCESTRALORGANIM_01 | El objeto paramUserList paramUserListByAncestralOrganism es nulo | USERLISTORGANISMLISTBYANCESTRALORGANIM_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 | USERLISTEl 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 código del organismo no puede estar vacíoUSERLISTorganismo 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 | USERLISTORGANISMLISTBYANCESTRALORGANIM_0607 | El organismo ancestro del que se quiere obtener la lista de usuarios esta dado de baja | USERLIST_07 | No existen usuarios para ese organismo | 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 |
---|
| ParamUserListWithPhoneParamUserListByAncestralOrganismWithPhone param = new ParamUserListWithPhoneParamUserListByAncestralOrganismWithPhone();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07839");
UserSearchWithPhone userSearchuserSearchWithPhone = new UserSearchWithPhone();
userSearch.setNif("00000000T");
param.setUserSearchsetUserSearchWithPhone(userSearchuserSearchWithPhone);
ResultUserListWithPhoneResultUserListByAncestralOrganismWithPhone result = client.userListuserListByAncestralOrganism(param);
|
|
Método '
...
userListByFiscalAnagramList'
...
Servicio que devuelve una lista de usuarios de un organismo ancestro pasado como parámetro y de todos sus hijosa partir de una lista de anagramas fiscales.
Expand |
---|
|
SignaturaResultUserListByAncestralOrganism userListByAncestralOrganism(ParamUserListByAncestralOrganism paramUserListByAncestralOrganismResultUserListByFiscalAnagramList userListByFiscalAnagramList(ParamUserListByFiscalAnagramList paramUserListByFiscalAnagramList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismCodefiscalAnagrams | String[] | Código de organismoLista de anagramas fiscales a buscar | userSearch | Objeto 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 |
---|
USERLISTBYANCESTRALORGANISMUSERLISTBYFISCALANAGRAMALIST_00 | Error durante la consulta de los usuarios datos de un organismo ancestrofuncionarios | ORGANISMLISTBYANCESTRALORGANIMUSERLISTBYFISCALANAGRAMALIST_01 | El objeto paramUserListByAncestralOrganism paramUserListByFiscalAnagramList es nulo | ORGANISMLISTBYANCESTRALORGANIMUSERLISTBYFISCALANAGRAMALIST_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 | ORGANISMLISTBYANCESTRALORGANIMUSERLISTBYFISCALANAGRAMALIST_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 | 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 |
---|
| ParamUserListByAncestralOrganismParamUserListByFiscalAnagramList param = new ParamUserListByAncestralOrganismParamUserListByFiscalAnagramList();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
UserSearch userSearch = new UserSearch()String[] FiscalAnagrams = { "18419908J" };
param.setUserSearchsetFiscalAnagrams(userSearchFiscalAnagrams);
ResultUserListByAncestralOrganismResultUserListByFiscalAnagramList result = client.userListByAncestralOrganismuserListByFiscalAnagramList(param);
|
|
Método '
...
userListByFiscalAnagramListWithIdCert'
...
Servicio que devuelve un listado una lista de usuarios de un organismo ancestro y sus hijosa partir de una lista de anagramas fiscales.
Expand |
---|
|
SignaturaResultUserListByAncestralOrganismWithPhone userListByAncestralOrganism(ParamUserListByAncestralOrganismWithPhone paramUserListByAncestralOrganismResultUserListByFiscalAnagramListWithIdCert userListByFiscalAnagramListWithIdCert(ParamUserListByFiscalAnagramListWithIdCert param) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismCodefiscalAnagrams | String[] | Código de organismo | userSearchWithPhoneLista de anagramas fiscales a buscar | userSearch | Objeto UserSearchWithPhone 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 | userListWithPhoneuserList | Lista de objetos UserWithPhone objetos User (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
USERLISTBYANCESTRALORGANISMUSERLISTBYFISCALANAGRAMALIST_00 | Error durante la consulta de los usuarios datos de un organismo ancestrofuncionarios | ORGANISMLISTBYANCESTRALORGANIMUSERLISTBYFISCALANAGRAMALIST_01 | El objeto paramUserListByAncestralOrganism paramUserListByFiscalAnagramList es nulo | ORGANISMLISTBYANCESTRALORGANIMUSERLISTBYFISCALANAGRAMALIST_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 usuariosUSERLISTBYFISCALANAGRAMALIST_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 |
---|
| ParamUserListByAncestralOrganismWithPhoneParamUserListByFiscalAnagramListWithIdCert param = new ParamUserListByAncestralOrganismWithPhoneParamUserListByFiscalAnagramListWithIdCert();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07839");
UserSearchWithPhone userSearchWithPhone = new UserSearchWithPhone()String[] FiscalAnagrams = { "18419908J" };
param.setUserSearchWithPhonesetFiscalAnagrams(userSearchWithPhoneFiscalAnagrams);
ResultUserListByAncestralOrganismWithPhoneResultUserListByFiscalAnagramListWithIdCert result = client.userListByAncestralOrganismuserListByFiscalAnagramListWithIdCert(param);
|
|
Método '
...
userListByOrganismBranchTree'
...
Servicio que devuelve una lista de usuarios a partir de una lista de anagramas fiscalesun listado con la información de los usuarios pertenecientes a un organismo pasado como parámetro y a los organismos descendientes de este.
Expand |
---|
|
SignaturaResultUserListByFiscalAnagramList userListByFiscalAnagramList(ParamUserListByFiscalAnagramList paramUserListByFiscalAnagramListResultUserListByOrganismBranchTree userListByOrganismBranchTree(ParamUserListByOrganismBranchTree paramUserListByOrganismBranchTree) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | fiscalAnagramsorganismCode | String[] | Lista de anagramas fiscales a buscarCó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 |
---|
USERLISTBYFISCALANAGRAMALISTUSERLISTBYORGANISMBRANCHTREE_00 | Error durante la consulta de los datos de funcionariosUSERLISTBYFISCALANAGRAMALISTusuarios de un organismo y descendientes | USERLISTBYORGANISMBRANCHTREE_01 | El objeto paramUserListByFiscalAnagramList paramUserListOrganismBranchTree es nulo | USERLISTBYFISCALANAGRAMALIST_02USERLISTBYORGANISMBRANCHTREE_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 funcionarios para estos usuarios con los parámetros de búsqueda | USERLISTBYFISCALANAGRAMALIST_03 | Ha ocurrido algún error al realizar la búsquedaestablecidos |
Ejemplo de invocación
Code Block |
---|
language | java |
---|
firstline | 1 |
---|
title | Ejemplo de invocación |
---|
collapse | true |
---|
| ParamUserListByFiscalAnagramListParamUserListByOrganismBranchTree param = new ParamUserListByFiscalAnagramListParamUserListByOrganismBranchTree();
param.setApplicationId("SIU");
String[] FiscalAnagramsparam.setOrganismCode("ORG07810");
UserSearch userSearch = { "18419908J" }new UserSearch();
param.setFiscalAnagramssetUserSearch(FiscalAnagramsuserSearch);
ResultUserListByFiscalAnagramListResultUserListByOrganismBranchTree result = client.userListByFiscalAnagramListuserListByOrganismBranchTree(param);
|
|
Método '
...
userListByOrganismBranchTreeWithPhone'
...
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 esteuna lista de usuarios de un organismo y sus descendientes.
Expand |
---|
|
SignaturaResultUserListByOrganismBranchTree userListByOrganismBranchTreeResultUserListByOrganismBranchTreeWithPhone userListByOrganismBranchTreeWithPhone(ParamUserListByOrganismBranchTree ParamUserListByOrganismBranchTreeWithPhone paramUserListByOrganismBranchTree) Parámetros de invocaciónNombre | 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 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 | userListuserListWithPhone | Lista de objetos User 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 |
---|
| ParamUserListByOrganismBranchTreeParamUserListByOrganismBranchTreeWithPhone param = new ParamUserListByOrganismBranchTreeParamUserListByOrganismBranchTreeWithPhone();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
UserSearchUserSearchWithPhone userSearch = new UserSearchUserSearchWithPhone();
param.setUserSearch(userSearch);
ResultUserListByOrganismBranchTreeResultUserListByOrganismBranchTreeWithPhone result = client.userListByOrganismBranchTreeuserListByOrganismBranchTreeWithPhone(param);
|
|
Método '
...
userListWithRevisedFlag'
...
Servicio que devuelve una lista un listado de usuarios de un organismo y sus descendientes, de acuerdo con los parámetros de búsqueda introducidos.
Devuelve igualmente el tamaño de usuarios encontrados.
Expand |
---|
|
SignaturaResultUserListByOrganismBranchTreeWithPhone userListByOrganismBranchTreeWithPhone(ParamUserListByOrganismBranchTreeWithPhone paramUserListByOrganismBranchTreeResultUserListWithRevisedFlag userListWithRevisedFlag(ParamUserListWithRevisedFlag paramUserList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | organismCode | String | Código de organismo | userSearch | Objeto 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 | userListWithPhoneuserList | Lista de objetos UserWithPhone objetos UserWithRevisedFlag (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
USERLISTBYORGANISMBRANCHTREEUSERLIST_00 | Error durante la consulta de los usuarios de un organismo y descendientesUSERLISTBYORGANISMBRANCHTREEdatos de funcionarios | USERLIST_01 | El objeto paramUserListOrganismBranchTree paramUserList es nulo | USERLISTBYORGANISMBRANCHTREEUSERLIST_02 | El código de organismo está vacío | USERLISTBYORGANISMBRANCHTREE_03 | El organismo no existe | USERLISTBYORGANISMBRANCHTREENo 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 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 establecidoscó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 |
---|
| ParamUserListByOrganismBranchTreeWithPhoneParamUserListWithRevisedFlag param = new ParamUserListByOrganismBranchTreeWithPhoneParamUserListWithRevisedFlag();
param.setApplicationId("SIU");
param.setOrganismCode("ORG07810");
UserSearchWithPhone userSearch = new UserSearchWithPhone();
userSearch.setNif("00000000T");
param.setUserSearch(userSearch);
ResultUserListByOrganismBranchTreeWithPhoneResultUserListWithRevisedFlag result = client.userListByOrganismBranchTreeWithPhoneuserListWithRevisedFlag(param);
|
|
Método '
...
userListByUnits'
...
Servicio que devuelve un listado de usuarios, de acuerdo con los parámetros de búsqueda introducidos.
Devuelve igualmente el tamaño de usuarios encontrados.
Expand |
---|
|
SignaturaResultUserListWithRevisedFlag userListWithRevisedFlagResultUserByUnits userListByUnits(ParamUserListWithRevisedFlag ParamUserListbyUnits paramUserList); Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | userSearchuserSearchByUnits | Objeto UserSearchWithPhone 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 UserWithRevisedFlag 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 |
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 organismoerror
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 |
---|
|
ParamUserListWithRevisedFlagUserSearchByUnits paramuserSearch = new ParamUserListWithRevisedFlagUserSearchByUnits();
paramuserSearch.setApplicationIdsetNif("SIU00000000T");
UserSearchWithPhone
ParamUserListbyUnits userSearchparam = new UserSearchWithPhoneParamUserListbyUnits();
userSearchparam.setNifsetApplicationId("00000000TSIU");
param.setUserSearch(userSearch);
param.setFiscalAnagram("00000000T");
ResultUserListWithRevisedFlag ResultUserByUnits result = client.userListWithRevisedFlaguserListByUnits(param);
|
Búsqueda y consulta de edificios
Método '
...
buildingList'
...
Servicio que devuelve un listado de usuariosedificios, de acuerdo con los parámetros de búsqueda introducidos. Devuelve igualmente el tamaño de usuarios encontradosnúmero de valores encontrados.
Permite filtrar por datos como dirección, ciudad, código, descripción, fecha de baja, fecha de alta, latitud, longitud, nombre y código postal.
Devuelve de cada edificio, dirección, ciudad, código, fecha de alta, nombre código postal, fecha de baja, longitud, latitud y nombre.
Expand |
---|
|
SignaturaResultUserByUnits userListByUnits(ParamUserListbyUnits paramUserList);ResultBuildingList buildingList(ParamBuildingList paramBuildingList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | userSearchByUnitsbuildingSearch | Objeto UserSearchByUnits 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 | userListbuildingList | Lista de objetos UserWithPhoneGenderNote objetos Building (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
USERLISTLISTBUILDING_00 | Error durante la consulta de los datos de funcionariosUSERLISTel listado de edificios | LISTBUILDING_01 | El objeto paramUserList ParamBuildingList es nulo | USERLISTLISTBUILDING_02 | El objeto de búsqueda es nulo | LISTBUILDING_03 | No se han encontrado funcionarios 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 |
---|
| UserSearchByUnitsParamBuildingList userSearchparamBuildingList = new UserSearchByUnitsParamBuildingList();
userSearch.setNif("00000000T");
ParamUserListbyUnits param BuildingSearch buildingSearch = new ParamUserListbyUnitsBuildingSearch();
parambuildingSearch.setApplicationIdsetName("SIUEdificio1");
paramparamBuildingList.setUserSearchsetBuildingSearch(userSearchbuildingSearch);
param.setFiscalAnagram("00000000T");
ResultUserByUnitsResultBuildingList result = client.userListByUnitsbuildingList(paramparamBuildingList);
|
|
Búsqueda y consulta de
...
logos
Método '
...
getLogo'
...
Servicio que devuelve un listado de edificios, de acuerdo con la información de un logo, dependiendo de los parámetros de búsqueda introducidos. Devuelve igualmente el número de valores encontrados.
Permite filtrar por datos como dirección, ciudadanagrama fiscal, código, descripción, fecha de baja, fecha de alta, latitud, longitud, nombre y código postalde organismo.
Devuelve de cada edificio, dirección, ciudad, código, fecha de alta, nombre código postal, fecha de baja, longitud, latitud y nombresi 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 |
---|
|
SignaturaResultBuildingList buildingList(ParamBuildingList paramBuildingListResultGetLogo getLogo(ParamGetLogo paramGetLogo) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | code | buildingSearch | Objeto BuildingSearch (ver detalle de campos en el apartado de objetos comunes)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 | size | int | Tamaño de la lista devuelta | buildingList | Lista de objetos Building logo | Objeto Logo (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
LISTBUILDINGLISTLOGO_00 | Error durante el listado de edificioslogos | LISTBUILDINGLISTLOGO_01 | El objeto ParamBuildingList ParamLogoList es nulo | LISTBUILDINGLISTLOGO_02 | El objeto de búsqueda ParamGetLogo es nulo | LISTBUILDINGLISTLOGO_03 | No se han encontrado edificios logo para estos parámetros de búsqueda | LISTBUILDINGLISTLOGO_04 | Ha ocurrido algún tipo de error al listar los edificioslogos | 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 |
---|
| ParamBuildingListParamGetLogo paramBuildingListparam = new ParamBuildingListParamGetLogo();
BuildingSearch buildingSearch = new BuildingSearch();
buildingSearch.setName("Edificio1param.setApplicationId("SIU");
paramBuildingListparam.setBuildingSearchsetOrganismCode(buildingSearch"ORG07458");
ResultBuildingListResultGetLogo result = client.buildingListgetLogo(paramBuildingListparam);
|
|
Búsqueda y consulta de logos
Método '
...
getLogoList'
...
Servicio que devuelve la información de un logo, dependiendo de los parámetros de búsqueda introducidosque devuelve una lista de logos.
Permite filtrar por anagrama fiscal, código, nombre y código de organismo.Devuelve si si es 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 de organismo.
Expand |
---|
|
SignaturaResultGetLogo getLogo(ParamGetLogo paramGetLogoResultLogoList getLogoList(ParamLogoList paramLogoList) Parámetros de invocaciónNombre | 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 | 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 | logo | Objeto | 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 método 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 |
---|
| ParamGetLogoParamLogoList param = new ParamGetLogoParamLogoList();
param.setApplicationId("SIU");
LogoSearch logoSearch = new LogoSearch();
logoSearch.setDefaultLogo(1);
param.setOrganismCodesetLogoSearch("ORG07458"logoSearch);
ResultGetLogoResultLogoList result = client.getLogogetLogoList(param);
|
|
Búsquedas y consultas de puestos
Método '
...
getJobByJobCode'
...
Servicio que devuelve una lista de logos.Permite filtrar por código, si es el logo por defecto, descripción, imagen, nombre, código de organismola información de un puesto, partiendo de un código de puesto.
Expand |
---|
|
SignaturaResultLogoList getLogoList(ParamLogoList paramLogoListResultGetJobByJobCode getJobByJobCode(ParamGetJobByJobCode paramGetJobInformationByJobCode) Parámetros de invocaciónNombre | 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)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 | size | int | Tamaño de la lista devuelta | logoList | Lista de objetos Logo (ver detalle job | Datos del puesto recuperados, objeto Job (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
LISTLOGOGETJOBCODE_00 | Error durante el listado de logos | LISTLOGOHa ocurrido un error al realizar la búsqueda | GETJOBCODE_01 | El objeto | ParamLogoList ParamGetJobByJobCode es nulo | LISTLOGOGETJOBCODE_02 | El objeto ParamGetLogo campo JobCode es nuloLISTLOGO_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 |
---|
| ParamLogoListParamGetJobByJobCode param = new ParamLogoListParamGetJobByJobCode();
param.setApplicationId("SIU");
LogoSearch logoSearch = new LogoSearch();
logoSearch.setDefaultLogo(1);
param.setLogoSearchsetJobCode(logoSearch"JOB00031");
ResultLogoListResultGetJobByJobCode result = client.getLogoListgetJobByJobCode(param);
|
|
...
Método '
...
jobInformation'
...
Servicio que devuelve la información de una lista de un puesto, partiendo de un código de puestopuestos, cuyos códigos se han pasado en la entrada. Devuelve el tamaño de la lista encontrada.
Expand |
---|
|
SignaturaResultGetJobByJobCode getJobByJobCode(ParamGetJobByJobCode paramGetJobInformationByJobCodeResultJobInformationList jobInformation(ParamJobInformationList jobList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | jobCodejobCodes | String | Código del puestoList<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 | job | Datos del puesto recuperados, objeto Job | 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 |
---|
GETJOBCODEJOBINFORMATION_00 | Ha ocurrido un error al realizar la búsqueda | GETJOBCODEJOBINFORMATION_01 | El objeto ParamGetJobByJobCode ParamJobInformationList es nulo | GETJOBCODEJOBINFORMATION_02 | El campo JobCode es nulolistado 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 |
---|
| ParamGetJobByJobCodeParamJobInformationList param = new ParamGetJobByJobCodeParamJobInformationList();
List<String> jobs = new ArrayList<String>();
paramjobs.setApplicationIdadd("SIUJOB00033");
param.setJobCodesetJobCodes("JOB00031"jobs);
ResultGetJobByJobCodeResultJobInformationList result = client.getJobByJobCodejobInformation(param);
|
|
Método '
...
jobList'
...
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 encontradasegún los parámetros de búsqueda introducidos. Además devuelve el tamaño de dicha lista.
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 |
---|
|
SignaturaResultJobInformationList jobInformation(ParamJobInformationList jobListResultJobList jobList(ParamJobList paramJobList) Parámetros de invocaciónNombre | 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 consultarjobSearch | 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 encontrada (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
JOBINFORMATIONJOBLIST_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 |
---|
| ParamJobInformationListParamJobList param = new ParamJobInformationListParamJobList();
List<String> jobsparam.setApplicationId("SIU");
JobSearch jobSearch = new ArrayList<String>JobSearch();
jobsjobSearch.addsetJobCode("JOB00033"); );
jobSearch.setIsFRH(2);
jobSearch.setVacante(true);
param.setJobCodessetJobSearch(jobsjobSearch);
ResultJobInformationListResultOrganismList result = client.jobInformationjobList(param);
|
|
Búsqueda y consulta de sellos de órgano
Método '
...
stampList'
...
Servicio que devuelve una lista de puestos, según los parámetros de búsqueda introducidos. Además devuelve el tamaño de dicha lista.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á ocupadoun listado de sellos encontrados, según los parámetros de búsqueda introducidos.
Expand |
---|
|
SignaturaResultJobList jobList(ParamJobList paramJobListResultStampList stampList(ParamStampList paramStampList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | jobSearchstampSearch | Objeto JobSearch StampSearch (ver detalle 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 | jobListstamps | Lista de objetos Job Stamp (ver detalle ver detalle de campos en el apartado de objetos comunes) |
Códigos error
Código | Descripción |
---|
JOBLISTSTAMPLIST_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 | un 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 |
---|
| ParamJobListParamStampList param = new ParamJobListParamStampList();
param.setApplicationId("SIU");
JobSearchStampSearch jobSearchstampSearch = new JobSearch();
jobSearch.setJobCode("JOB00033");
jobSearch.setIsFRH(2);
jobSearch.setVacante(trueStampSearch();
param.setJobSearchsetStampSearch(jobSearchstampSearch);
ResultOrganismListResultStampList result = client.jobListstampList(param);
|
|
...
Método '
...
stampListAndUserInformation'
...
Servicio que devuelve un listado de sellos encontrados e información del usuario, según los parámetros de búsqueda introducidos.
Expand |
---|
|
SignaturaResultStampList stampListResultStampListAndUserInformation stampListAndUserInformation(ParamStampList ParamStampListAndUserInformation paramStampList) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | stampSearchstampListSearch | Objeto StampSearch 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 Stamp 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 |
---|
| ParamStampListParamStampListAndUserInformation param = new ParamStampListParamStampListAndUserInformation();
param.setApplicationId("SIU");
StampSearchStampAndUserInformationSearch stampSearchstampListSearch = new StampSearchStampAndUserInformationSearch();
stampListSearch.setOrganismCode("ORG07556");
param.setStampSearchsetStampListSearch(stampSearchstampListSearch);
ResultStampListResultStampListAndUserInformation result = client.stampListstampListAndUserInformation(param);
|
|
Método '
...
stampListAndUserInformation1'
...
Servicio que devuelve un listado una lista de sellos encontrados e información del usuario, según los parámetros de búsqueda introducidoscon información de sus usuarios pudiendo filtrar por organismo, rol y sello.
Expand |
---|
|
SignaturaResultStampListAndUserInformation ResultStampListAndUserInformationByRoleAndUser stampListAndUserInformation(ParamStampListAndUserInformation ParamStampListAndUserInformationByRoleAndUser paramStampList) Parámetros de invocaciónPará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 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 |
---|
| ParamStampListAndUserInformationParamStampListAndUserInformationByRoleAndUser param = new ParamStampListAndUserInformationParamStampListAndUserInformationByRoleAndUser();
param.setApplicationId("SIU");
StampAndUserInformationSearchStampAndUserInformationByRoleAndUserSearch stampListSearchsearchParams = new StampAndUserInformationSearchStampAndUserInformationByRoleAndUserSearch();
stampListSearch.setOrganismCode("ORG07556");
param.setStampListSearchsetSearchParams(stampListSearchsearchParams);
ResultStampListAndUserInformationResultStampListAndUserInformationByUser result = client.stampListAndUserInformation(param);
|
|
Método '
...
stampListAndUserInformation2'
...
Servicio que devuelve una lista un listado de sellos con la información de sus usuarios pudiendo filtrar por organismo, rol y selloel rol del usuario.
Expand |
---|
|
SignaturaResultStampListAndUserInformationByRoleAndUser ResultStampListAndUserInformationByUser stampListAndUserInformation(ParamStampListAndUserInformationByRoleAndUser ParamStampListAndUserInformationByUser paramStampList) Parámetros de invocaciónPará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 |
---|
| ParamStampListAndUserInformationByRoleAndUserParamStampListAndUserInformationByUser param = new ParamStampListAndUserInformationByRoleAndUserParamStampListAndUserInformationByUser();
param.setApplicationId("SIU");
StampAndUserInformationByRoleAndUserSearchStampAndUserInformationByUserSearch searchParamsstampListSearch = new StampAndUserInformationByRoleAndUserSearch(StampAndUserInformationByUserSearch();
stampListSearch.setFiscalAnagram("00000000T");
param.setSearchParamssetStampListSearch(searchParamsstampListSearch);
ResultStampListAndUserInformationByUser result = client.stampListAndUserInformation(param);
|
|
Método '
...
stampListAndUserInformationJob'
...
Servicio que devuelve un listado una lista de sellos con la información de sus usuarios pudiendo filtrar por el rol del usuarioorganismo, puesto y sello.
Expand |
---|
|
SignaturaResultStampListAndUserInformationByUser stampListAndUserInformationResultStampListAndUserInformationByJobAndUser stampListAndUserInformationJob(ParamStampListAndUserInformationByUser ParamStampListAndUserInformationByJobAndUser paramStampList) Parámetros de invocaciónPará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 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 |
---|
| ParamStampListAndUserInformationByUserParamStampListAndUserInformationByJobAndUser param = new ParamStampListAndUserInformationByUserParamStampListAndUserInformationByJobAndUser();
param.setApplicationId("SIU");
StampAndUserInformationByUserSearchStampAndUserInformationByJobAndUserSearch stampListSearchsearchParams = new StampAndUserInformationByUserSearch();
stampListSearch.setFiscalAnagram("00000000T"StampAndUserInformationByJobAndUserSearch();
param.setStampListSearchsetSearchParams(stampListSearchsearchParams);
ResultStampListAndUserInformationByUser result = client.stampListAndUserInformation(param);
|
|
Método '
...
readCertPseudonym'
...
Servicio que devuelve una lista de sellos con información de sus usuarios pudiendo filtrar por organismo, puesto y sello.la información de un usuario en base a su nif, pernr o certificado pseudonimo
Expand |
---|
|
SignaturaResultStampListAndUserInformationByJobAndUser stampListAndUserInformationJob(ParamStampListAndUserInformationByJobAndUser paramStampListResultReadCertPseudonym readCertPseudonym(ParamReadCertPseudonym param) Parámetros de invocaciónNombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método | fiscalAnagram | String | Anagrama fiscal | nif | searchParams | Objeto StampAndUserInformationByJobAndUserSearch (ver detalle de campos en el apartado de objetos comunes)String | Documento de identidad | pernr | Integer | Código pernr | certPseudonym | String | Código del certificado pseudónimo |
Parámetros de respuesta
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 nuloNombre | Tipo | Descripción |
---|
errors | boolean | Informa si ha habido algún error | errorMsgmessage | 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 errordel error ocurrido | status | String | OK o KO | user | Objeto | El usuario. |
Ejemplo de invocación
Code Block |
---|
language | java |
---|
firstline | 1 |
---|
title | Ejemplo de invocación |
---|
collapse | true |
---|
| ParamStampListAndUserInformationByJobAndUserParamReadCertPseudonym param = new ParamStampListAndUserInformationByJobAndUserParamReadCertPseudonym();
param.setApplicationId("SIU");
StampAndUserInformationByJobAndUserSearch searchParams = new
StampAndUserInformationByJobAndUserSearch();
param.setSearchParamssetNif(searchParams"00000000T");
ResultStampListAndUserInformationByUserResultReadCertPseudonym result = client.stampListAndUserInformationreadCertPseudonym(param);
|
|
Anexos
Objetos comunes
Objeto Anchor |
---|
| anclaBuilding |
---|
| anclaBuilding |
---|
|
building
...
Nombre | Tipo | Descripción |
---|
organismCode | String | Código de organismo |
UserWithExtendedData | Campos del objeto UserWithExtendedData (ver detalle de campos en este mismo apartado) |
params | Campos del objeto SearchParams (ver detalle de campos en este mismo apartado) |
pagingCriteria | Campos del objeto PagingCriteria (ver detalle de campos en este mismo apartado) |
sortingCriteria | Campos del objeto SortingCriteria (ver detalle de campos en este mismo apartado) |
Objeto Anchor |
---|
| anclauserSearchWithPhone |
---|
| anclauserSearchWithPhone |
---|
|
userSearchWithPhone
Nombre | Tipo | Descripción |
---|
organismCode | String | Código de organismo |
userWithPhone | Campos del objeto UserWithPhone (ver detalle de campos en este mismo apartado) |
params | Campos del objeto SearchParams (ver detalle de campos en este mismo apartado) |
pagingCriteria | Campos del objeto PagingCriteria (ver detalle de campos en este mismo apartado) |
sortingCriteria | Campos del objeto SortingCriteria (ver detalle de campos en este mismo apartado) |
Objeto Anchor |
---|
| anclaUserSearchByUnits |
---|
| anclaUserSearchByUnits |
---|
|
UserSearchByUnits
...