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.
...
| Expand |
|---|
|
SignaturaResultAdditionalDataOrganismListByUser additionalDataOrganismListByUser (ParamAdditionalDataOrganismListByUser paramAdditionalDataOrganismByUser). Parámetros de invocación| Nombre | 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 'ancestralOrganismByUserList'
...
Servicio que devuelve una lista de organismos ancestros a los que pertenece un usuario a partir de un token.
Un organismo ancestro es aquel que tiene la identidad fiscal a 1.
| Expand |
|---|
|
SignaturaResultAncestralOrganismByUserList ancestralOrganismByUserList(ParamAncestralOrganismByUserList paramAncestralOrganismByUserList). Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | token | String | Valor del token cifrado | | originalToken | String | Valor del token a cifrar |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | organismList | Lista de organismos | | organism | Organismo (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ANCESTRALORGANISMBYUSERLIST_07 | El objeto paramAncestralOrganismByUserList es nulo | | ANCESTRALORGANISMBYUSERLIST_08 | El parámetro de entrada token original es nulo | | ANCESTRALORGANISMBYUSERLIST_01 | El parámetro de entrada token es nulo | | ANCESTRALORGANISMBYUSERLIST_03 | El funcionario no existe en la bd | | ANCESTRALORGANISMBYUSERLIST_04 | El funcionario ha sido dado de baja de la bd | | ANCESTRALORGANISMBYUSERLIST_05 | El funcionario no esta asignado a ningún organismo | | ANCESTRALORGANISMBYUSERLIST_02 | Ha ocurrido algún error al verificar la firma | | ANCESTRALORGANISMBYUSERLIST_00 | Error durante la consulta de los datos de organismos | | ANCESTRALORGANISMBYUSERLIST_06 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocaciónEl ejemplo devuelve un error | Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamAncestralOrganismByUserList param = new ParamAncestralOrganismByUserList();
param.setApplicationId("SIU");
param.setOriginalToken("T");
param.setToken("T");
ResultAncestralOrganismByUserList result = client.ancestralOrganismByUserList(param); |
|
...
Permite filtrar además por otros datos como dirección, cif, ciudad, país, email...
Devuelve el listado de organismos ordenado por código de organismo.
| Expand |
|---|
|
SignaturaResultAscendantOrganismBranchTree ascendantOrganismBranchTree(ParamAscendantOrganismBranchTree paramAscendentOrganismBranchTree) Parámetros de invocación| Nombre | Tipo | Descripción |
|---|
| applicationId | String | Aplicación que ejecuta el método | | fiscalAnagram | String | Anagrama fiscal | | orgCode | String | Código de organismo | | organismSearch | Objeto 1052050039 (ver detalle de campos en el apartado de objetos comunes) |
Parámetros de respuesta
| Nombre | Tipo | Descripción |
|---|
| errors | boolean | Informa si ha habido algún error | | errorMsg | String | Mensaje del error ocurrido | | errorCode | String | Código del error ocurrido | | size | int | Tamaño de la lista de organismos devuelta | | organismList | Lista de organismos | | organism | Organismo (ver detalle de campos en el apartado de objetos comunes) |
Códigos error
| Código | Descripción |
|---|
| ASCENDENT_ORGANISM_BRANCH_LIST_01 | El objeto paramAscendantOrganimsBranchTree es nulo | | ORGANISMLIST_00 | Error durante la consulta de los datos de organismos | | ORGANISMLIST_01 | El objeto paramOrganismList es nulo | | ORGANISMLIST_02 | No se han encontrado organismos para estos parámetros de búsqueda | | ORGANISMLIST_04 | No existe el organismo de entrada | | ORGANISMLIST_03 | Ha ocurrido algún error al realizar la búsqueda |
Ejemplo de invocación
| Code Block |
|---|
| language | java |
|---|
| firstline | 1 |
|---|
| title | Ejemplo de invocación |
|---|
| collapse | true |
|---|
| ParamAscendantOrganismBranchTree param = new ParamAscendantOrganismBranchTree();
param.setApplicationId("SIU");
param.setOrgCode("ORG07810");
OrganismSearch organismSearch = new OrganismSearch();
organismSearch.setOrganismCode("ORG07810");
param.setOrganismSearch(organismSearch);
ResultAscendantOrganismBranchTree result = client.ascendantOrganismBranchTree(param); |
|
...
| Nombre | Tipo | Descripción |
|---|
| logo | Campos del objeto Logo (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 'organism'
...
...
...
| Nombre | Tipo | Descripción |
|---|
| organismCode | String | Código del organismo |
| name | String | Nombre del organismo |
| serviceBossNif | String | Nif del jefe de ese organismo |
| sirhgaOrganismCode | String | Código del organismo en sirhga |
| fatherSirhgaOrganismCode | String | Código del padre del organismo en sirhga |
| cif | String | Cif del organismo |
| address | String | Dirección del organismo |
| city | String | Ciudad del organismo |
| province | String | Provincia del organismo |
| country | String | País del organismo |
| postalCode | String | Código postal del organismo |
| telephone | String | Teléfono del organismo |
| email | String | Email del organismo |
| external | String | El organismo es externo al sistema (es una empresa) |
| emisor | String | El organismo es emisor de facturas |
| receptor | String | El organismo es receptor de facturas |
| fiscalIdentity | String | El organismo tiene identidad fiscal propia (es ancestro, caso de AST, dentro de DGA) |
| fatherCode | String | Código del padre del organismo |
| newCode | String | Nuevo código (caso de escisiones, renombres, bajas,...) |
| initialDate | Date | Fecha inicio vigencia organismo |
| finalDate | Date | Fecha final vigencia organismo |
| shortName | String | Nombre corto del organismo |
| extendedData | Lista de datos extendidos (ver detalle de campos en este mismo apartado) |
| nodeLevel | int | Nivel al que pertenece ( si raíz= 0) |
| isRoot | boolean | Informa de si es raíz |
| isLeaf | boolean | Informa de si es hoja |
| childrenCount | int | Número de hijos |
| rootFather | String | Código de la raíz |
| levelsBelow | int | Número de niveles por debajo |
...