4.- Servicios

4.- Servicios

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.



Signatura

ResultAdditionalDataOrganismListByUser additionalDataOrganismListByUser (ParamAdditionalDataOrganismListByUser paramAdditionalDataOrganismByUser).

Parámetros de invocación

Nombre

Tipo

Descripció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

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

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



Ejemplo de invocación
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.



Signatura

ResultAdditionalDataOrganismListByUserExtendedData additionalDataOrganismListByPernrAndCertPseudonym(ParamAdditionalDataOrganismListByUserExtendedData paramAdditionalDataOrganismListByUserExtendedData)

Parámetros de invocación

Nombre

Tipo

Descripción

Nombre

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

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

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



Ejemplo de invocación
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.



Signatura

ResultAncestralOrganismByUserList ancestralOrganismByUserList(ParamAncestralOrganismByUserList paramAncestralOrganismByUserList).

Parámetros de invocación

Nombre

Tipo

Descripció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

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

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ón

El ejemplo devuelve un error

Ejemplo de invocación
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.

Signatura

ResultAncestralOrganismWithAllTree ancestralOrganismWithAllTree(ParamAncestralOrganismWithAllTree paramAncestralOrganismWithAllTree)

Parámetros de invocación

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

applicationId

String

Aplicación que ejecuta el método

fiscalAnagram

String

Anagrama fiscal

orgCode

String

Código de organismo del que se extraerán los de su árbol

Parámetros de respuesta



Nombre

Tipo

Descripción

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

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



Ejemplo de invocación
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.



Signatura

ResultAncestralOrganismTree ancestralOrganismTree(ParamAncestralOrganismTree paramAncestralOrganismTree)

Parámetros de invocación

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

applicationId

String

Aplicación que ejecuta el método

fiscalAnagram

String

Anagrama fiscal

orgCode

String

Código de organismo del que se extraerán los de su árbol

organismSearch

Bean de búsqueda de organismos

   organism

Campos del objeto Organism (ver detalle de campos en el apartado de objetos comunes)

   pagingCriteria

Campos del objeto PagingCriteria (ver detalle de campos en el apartado de objetos comunes)

   sortingCriteria

Campos del objeto SortingCriteria (ver detalle de campos en el apartado de objetos comunes)

   params

Campos del objeto SearchParams (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta



Nombre

Tipo

Descripción

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

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