Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »


El dato específico CSV_Access ya no se devuelve

Servicios DraftService

Servicios de gestión de notificaciones en estado borrador


Método 'createDraft@deprecated


Inicia el proceso de alta de una notificación creando para ello un borrador en el sistema con los metadatos asociados a la notificación.

A la hora de crear un borrador tenemos que tener en cuenta la visibilidad. Todos los borradores creados con este método se crearán con visibilidad compartida y el organismo gestor será el indicado en el campo organismo.

Método deprecado, es recomendable usar el servicio → createDraftWithOrganism() para gestionar de manera específica la visibilidad de las notificaciones.

Información

Se ha modificado la lógica del servicio para que el usuario pueda emitir notificaciones en organismos en los que no tengan rol directamente pero estén en su rama.
Se podrá emitir en organismos de la misma rama en orden descendente, es decir, podrá emitir el el organismo padre del organismo que tenga roles.

 Más detalles

Signatura

ResultCreateDraft createDraft (String applicationId, ParamCreateDraft paramCreateDraft) throws RemoteException, InternalCoreException

Parámetros de invocación

NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamCreateDraftObjeto de creación de borrador
draftDraftObjeto solicitud

Parámetros de respuesta


NombreTipoDescripción
ResultCreateDraftObjeto de resultado de creación de borrador

draftId

String

Identificador del borrador creado

Ejemplo de invocación


Ejemplo de invocación
//objetos del servicio
ParamCreateDraft paramCreateDraft = new ParamCreateDraft();
ResultCreateDraft resultCreateDraft;

//Se crea un receiver
DraftReceiver draftReceiver = new DraftReceiver();
draftReceiver.setReceiverId("11111111H"); // receptor de la notificacion
draftReceiver.setName("name");
draftReceiver.setSurname1("surname1");
draftReceiver.setSurname2("surname2");
draftReceiver.setAddress("address");
draftReceiver.setEmail("email@email.com");

//Se crea la lista de Receivers
DraftReceiver[] draftReceivers = new DraftReceiver[1];
draftReceivers[0] = draftReceiver;

//Se crea la lista de datos específicos
Data[] specificDataList=new Data[3];
specificDataList[0] = new Data("keyA1","valueA1");
specificDataList[1] = new Data("keyA2","valueA2");
specificDataList[2] = new Data("keyA3","valueA3");

//Se crea el organismo asociado
Organism organism = new Organism();
organism.setCode("ORG14668");
organism.setName("Departamento de Economía y Hacienda");

//Se rellena el objeto Draft
Draft draftCreate = new Draft();
draftCreate.setDossier("20110224-01"); // expediente
draftCreate.setCreatorId("11111111H");
draftCreate.setDescription("20110224-01");
draftCreate.setOrganism(organism);
draftCreate.setSpecificDataList(specificDataList);
draftCreate.setDraftReceiversList(draftReceivers);
draftCreate.setExpireTime(new Integer(10));
draftCreate.setContent("20110224-01");
draftCreate.setProcedure("1");

//Se rellena el objeto ParamCreateDraft               
paramCreateDraft.setDraft(draftCreate);

//Se hace la invocación
try {
	resultCreateDraft = draftClient.createDraft(paramCreateDraft);
	System.out.println(resultCreateDraft.getDraftId());
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}
		


Método 'createDraftWithOrganism'


Inicia el proceso de alta de una notificación creando para ello un borrador en el sistema con los metadatos asociados a la notificación

A la hora de crear un borrador tenemos que tener en cuenta la visibilidad. Si se quiere crear un borrador con visibilidad compartida tenemos que asignarle la lista de organismos (organismVisibilityList). Si no asignamos la lista de organismos, el borrador se creará con visibilidad limitada.

En la lista de visibilidad de organismos solamente hay que pasar los organismos gestores ya que el organismo productor se obtiene automáticamente por código.


Información

Se ha modificado la lógica del servicio para que el usuario pueda emitir notificaciones en organismos en los que no tengan rol directamente pero estén en su rama.
Se podrá emitir en organismos de la misma rama en orden descendente, es decir, podrá emitir el el organismo padre del organismo que tenga roles.

 Más detalles

Signatura

ResultCreateDraft createDraftWithOrganism (String applicationId ParamCreateDraftWithOrganism paramCreateDraft) throws RemoteException, InternalCoreException

Parámetros de invocación

NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
paramUpdateDraftObjeto de creación de borrador
draftWithOrganismDraftWithOrganismObjeto solicitud

Parámetros de respuesta


NombreTipoDescripción
ResultCreateDraftObjeto de resultado de creación de borrador

draftId

String

Identificador del borrador creado

Ejemplo de invocación

En este ejemplo vamos a crear una notificación con visibilidad compartida, ya que vamos a indicar una lista de organismos gestores.

Ejemplo de invocación
//objetos del servicio
ParamCreateDraftWithOrganism paramCreateDraft = new ParamCreateDraftWithOrganism();
ResultCreateDraft resultCreateDraft;

//Se crea un receiver
DraftReceiver draftReceiver = new DraftReceiver();
draftReceiver.setReceiverId("11111111H"); // receptor de la notificacion
draftReceiver.setName("name");
draftReceiver.setSurname1("surname1");
draftReceiver.setSurname2("surname2");
draftReceiver.setAddress("address");
draftReceiver.setEmail("email@email.com");

//Se crea la lista de Receivers
DraftReceiver[] draftReceivers = new DraftReceiver[1];
draftReceivers[0] = draftReceiver;

//Se crea la lista de datos específicos
Data[] specificDataList=new Data[3];
specificDataList[0] = new Data("keyA1","valueA1");
specificDataList[1] = new Data("keyA2","valueA2");
specificDataList[2] = new Data("keyA3","valueA3");

//Se crea el organismo asociado
Organism organism = new Organism();
organism.setCode("ORG14668");
organism.setName("Departamento de Economía y Hacienda");

//Se rellena el objeto Draft
DraftWithOrganism draftCreate = new DraftWithOrganism();
draftCreate.setDossier("20110224-01"); // expediente
draftCreate.setCreatorId("11111111H"); // creador de la notificación
draftCreate.setDescription("20110224-01");
draftCreate.setOrganism(organism);
draftCreate.setSpecificDataList(specificDataList);
draftCreate.setDraftReceiversList(draftReceivers);
draftCreate.setExpireTime(new Integer(10));
draftCreate.setContent("20110224-01");
draftCreate.setProcedure("1"); // procedimiento de la notificación
	
//lista de organismos gestores para la visibilidad compartida (si no se asigna la lista se creará con visibilidad limitada)
OrganismVisibility[] organismVisibilities = new OrganismVisibility[2];
				
OrganismVisibility organismVisibility = new OrganismVisibility();
organismVisibility.setOrganismCode("ORG14668");			
organismVisibility.setTipoRelacion(SNTClientConstants.ORG_GESTOR);
					
organismVisibilities[0] = organismVisibility;

organismVisibility = new OrganismVisibility();
organismVisibility.setOrganismCode("ORG12358");			
organismVisibility.setTipoRelacion(SNTClientConstants.ORG_GESTOR);
					
organismVisibilities[1] = organismVisibility;

draftCreate.setOrganismVisibilityList(organismVisibilities);

//Se rellena el objeto ParamCreateDraft               
paramCreateDraft.setDraft(draftCreate);

//Se hace la invocación
try {
	resultCreateDraft = draftClient.createDraftWithOrganism(paramCreateDraft);
	System.out.println(resultCreateDraft.getDraftId());
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}
		

En este ejemplo vamos a crear una notificación con visibilidad limitada, ya que vamos a indicar una lista vacía de organismos gestores.

Ejemplo de invocación
//objetos del servicio
ParamCreateDraftWithOrganism paramCreateDraft = new ParamCreateDraftWithOrganism();
ResultCreateDraft resultCreateDraft;

//Se crea un receiver
DraftReceiver draftReceiver = new DraftReceiver();
draftReceiver.setReceiverId("11111111H"); // receptor de la notificacion
draftReceiver.setName("name");
draftReceiver.setSurname1("surname1");
draftReceiver.setSurname2("surname2");
draftReceiver.setAddress("address");
draftReceiver.setEmail("email@email.com");

//Se crea la lista de Receivers
DraftReceiver[] draftReceivers = new DraftReceiver[1];
draftReceivers[0] = draftReceiver;

//Se crea la lista de datos específicos
Data[] specificDataList=new Data[3];
specificDataList[0] = new Data("keyA1","valueA1");
specificDataList[1] = new Data("keyA2","valueA2");
specificDataList[2] = new Data("keyA3","valueA3");

//Se crea el organismo asociado
Organism organism = new Organism();
organism.setCode("ORG14668");
organism.setName("Departamento de Economía y Hacienda");

//Se rellena el objeto Draft
DraftWithOrganism draftCreate = new DraftWithOrganism();
draftCreate.setDossier("20110224-01"); // expediente
draftCreate.setCreatorId("11111111H"); // creador de la notificación
draftCreate.setDescription("20110224-01");
draftCreate.setOrganism(organism);
draftCreate.setSpecificDataList(specificDataList);
draftCreate.setDraftReceiversList(draftReceivers);
draftCreate.setExpireTime(new Integer(10));
draftCreate.setContent("20110224-01");
draftCreate.setProcedure("1"); // procedimiento de la notificación

draftCreate.setOrganismVisibilityList(null); // lista vacia de organismos gestores

//Se rellena el objeto ParamCreateDraft               
paramCreateDraft.setDraft(draftCreate);

//Se hace la invocación
try {
	resultCreateDraft = draftClient.createDraftWithOrganism(paramCreateDraft);
	System.out.println(resultCreateDraft.getDraftId());
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}
		


Método 'updateDraft' @deprecated


Actualiza una solicitud de notificación dada de alta en el sistema. En el caso de enviar el documento la notificación (draftDocument) se actualizaría o añadiría y se actualizarían los metadados del draft. Si solo se enviase el parámetro draft, solamente se actualizarían los metadatos de éste.

A la hora de actualizar un borrador tenemos que tener en cuenta la visibilidad. Todos los borradores actualizados con este método se actualizarán con visibilidad compartida y el organismo gestor será el indicado en el campo organismo

Método deprecado, es recomendable usar el servicio → updateDraftWithOrganism() para gestionar de manera específica la visibilidad de las notificaciones.


Información

Se ha modificado la lógica del servicio para que el usuario pueda emitir notificaciones en organismos en los que no tengan rol directamente pero estén en su rama.
Se podrá emitir en organismos de la misma rama en orden descendente, es decir, podrá emitir el el organismo padre del organismo que tenga roles.

 Más detalles

Signatura

Result updateDraft(String applicationId, ParamUpdateDraft paramUpdateDraft, DataHandler draftDocument) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

draftDocumentDataHandlerNo

Documento de principal de la notificación.

ParamUpdateDraftObjeto de actualización de borrador
draft

Draft

Objeto solicitud

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultUpdateDraft

ResultUpdateDraft

Objeto que se devuelve como resultado sin ningún parámetro.

Ejemplo de invocación


Ejemplo de invocación
ParamGetDraft paramGetDraft = new ParamGetDraft();
paramGetDraft.setDraftId(result.getDraftId());
ResultGetDraft resultGetDraft = draftClient.getDraft(paramGetDraft);

Draft draft = resultGetDraft.getDraft();

// Le añadimos los metadatos del documento de notificación
draft.setFormatSignature(new Long(SNTClientConstants.SIGN_TYPE_PDF));
draft.setMimeType("application/pdf");
draft.setFileName("NOTIFICATION_ATTACHED_PDF.pdf");
draft.setSignDate(Calendar.getInstance());

ParamUpdateDraft paramUpdateDraft = new ParamUpdateDraft();
paramUpdateDraft.setDraft(draft);
paramUpdateDraft.setInvokingId("1111111H");

// Cargamos el fichero de notificación
FileDataSource dataSourceNotification = new FileDataSource(new File("src/test/docs/NOTIFICATION.pdf"));
DataHandler draftDocument = new DataHandler(dataSourceNotification);

// Invocamos al servicio
draftClient.updateDraft(paramUpdateDraft, draftDocument);


Método 'updateDraftWithOrganism'


Actualiza una solicitud de notificación dada de alta en el sistema. En el caso de enviar el documento la notificación (draftDocument) se actualizaría o añadiría y se actualizarían los metadados del draft. Si solo se enviase el parámetro draft, solamente se actualizarían los metadatos de éste.

A la hora de actualizar un borrador tenemos que tener en cuenta la visibilidad. En la obtención del borrador obtendremos también los organismos gestores e irá incluido en la lista el organismo aportador, por lo que tenemos que quitarlo de la lista si queremos gestionarlos en nuestra aplicación.

En la lista de visibilidad de organismos solamente hay que pasar los organismos gestores ya que el organismo productor se obtiene automáticamente por código.


Información

Se ha modificado la lógica del servicio para que el usuario pueda emitir notificaciones en organismos en los que no tengan rol directamente pero estén en su rama.
Se podrá emitir en organismos de la misma rama en orden descendente, es decir, podrá emitir el el organismo padre del organismo que tenga roles.

 Más detalles

Signatura

Result updateDraft(String applicationId, ParamUpdateDraftWithOrganism paramUpdateDraftWithOrganism, DataHandler draftDocument) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

draftDocumentDataHandlerNo

Documento de principal de la notificación.

ParamUpdateDraftWithOrganismObjeto de actualización de borrador
draftWithOrganism

DraftWithOrganism

Objeto solicitud

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultUpdateDraft

ResultUpdateDraft

Objeto que se devuelve como resultado sin ningún parámetro.

Ejemplo de invocación


Ejemplo de invocación
ParamGetDraft paramGetDraft = new ParamGetDraft();
paramGetDraft.setDraftId(10940L);
ResultGetDraftWithOrganism resultGetDraft = draftClient.getDraftWithOrganism(paramGetDraft);

DraftWithOrganism draft = resultGetDraft.getDraft();

// Le añadimos los metadatos del documento de notificación
draft.setFormatSignature(new Long(SNTClientConstants.SIGN_TYPE_PDF));
draft.setMimeType("application/pdf");
draft.setFileName("NOTIFICATION_ATTACHED_PDF.pdf");
draft.setSignDate(Calendar.getInstance());

ParamUpdateDraftWithOrganism paramUpdateDraft = new ParamUpdateDraftWithOrganism();
paramUpdateDraft.setDraft(draft);
paramUpdateDraft.setInvokingId("1111111H");

// Cargamos el fichero de notificación
FileDataSource dataSourceNotification = new FileDataSource(new File("src/test/docs/NOTIFICATION.pdf"));
DataHandler draftDocument = new DataHandler(dataSourceNotification);

// Invocamos al servicio
draftClient.updateDraftWithOrganism(paramUpdateDraft, draftDocument);

Método 'deleteDraft'


Elimina una solicitud de notificación dada de alta en el sistema.

 Más detalles

Signatura

Result deleteDraft(String applicationId, ParamDeleteDraft paramDeleteDraft) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoDescripción

applicationId

String

Aplicación que ejecuta el método

ParamDeleteDraftObjeto de borrado

draftId

String

Identificador de la solicitud a eliminar

invokingId

String

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

-

Result

Objeto que se devuelve como resultado sin ningún parámetro.

Ejemplo de invocación


Ejemplo de invocación
// Objectos del servicio
ParamDeleteDraft paramDeleteDraft = new ParamDeleteDraft();
	
// Indicamos el Draft a eliminar
paramDeleteDraft.setDraftId(10940L);
paramDeleteDraft.setInvokingId("1111111H");
	
// Se hace la invocación
try {
	Result resultDeleteDraft = draftClient.deleteDraft(paramDeleteDraft);
	System.out.println("Se ha eliminado el borrador correctamente");
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}

Método 'getDraft' @deprecated


Obtiene los metadatos (sin los datos físicos del documento de notificación) de una solicitud de notificación dada de alta en el sistema.

En el borrador obtenido, no se obtiene la lista de organismos de visibilidad (organismVisibilityList) con el organismo productor y los organismos gestores.

Método deprecado, es recomendable usar el servicio → getDraftWithOrganism() para obtener visibilidad de las notificaciones.

 Más detalles

Signatura

ResultGetDraft getDraft(String applicationId, ParamGetDraft paramGetDraft) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetDraftObjeto de obtención de borrador

draftId

String

Identificador de la solicitud a obtener

Parámetros de respuesta


NombreTipoDescripción

ResultGetDraft

Objeto que contiene el borrador

draftDraftObjeto borrador

Ejemplo de invocación


Ejemplo de invocación
//Objetos del servicio
ParamGetDraft paramGetDraft = new ParamGetDraft();
ResultGetDraft resultGetDraft;

//Se indica el Draft a obtener
paramGetDraft.setDraftId(new Long(1));

//Se hace la invocación
try {
	resultGetDraft = draftClient.getDraft(paramGetDraft);
	if(resultGetDraft!=null && resultGetDraft.getDraft()!=null){
		System.out.println("Se ha obtenido el borrador");
	}else{
		System.out.println("No se ha encontrado el borrador");
	}
			
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}


Método 'getDraftWithOrganism'


Obtiene los metadatos (sin los datos físicos del documento de notificación) de una solicitud de notificación dada de alta en el sistema.

En el borrador obtenido, se obtiene la lista de organismos de visibilidad (organismVisibilityList) con el organismo productor y los organismos gestores.

 Más detalles

Signatura

ResultGetDraftWithOrganism getDraftWithOrganism(String applicationId, ParamGetDraft paramGetDraft) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetDraftObjeto de obtención de borrador

draftId

String

Identificador de la solicitud a obtener

Parámetros de respuesta


NombreTipoDescripción

ResultGetDraftWithOrganism

Objeto que contiene el borrador

draft

Draft

Ejemplo de invocación


Ejemplo de invocación
//Objetos del servicio
ParamGetDraft paramGetDraft = new ParamGetDraft();
		
//Se indica el Draft a obtener
paramGetDraft.setDraftId(new Long(1));

//Se hace la invocación
try {
	ResultGetDraftWithOrganism resultGetDraft = draftClient.getDraftWithOrganism(paramGetDraft);
	if(resultGetDraft!=null && resultGetDraft.getDraft()!=null){
		System.out.println("Se ha obtenido el borrador");
	}else{
		System.out.println("No se ha encontrado el borrador");
	}
			
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}


Método 'getDraftList' @deprecated


Obtiene una lista de solicitudes de notificación dadas de alta en el sistema, según un criterio de búsqueda.

Método deprecado, es recomendable usar el servicio → getDraftListWithOrganism() para obtener visibilidad de las notificaciones.

 Más detalles

Signatura

ResultGetDraftList getDraftList(String applicationId, ParamGetDraftList paramGetDraftList) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetDraftListObjeto de obtención de borradores

draftSearch

DraftSearch

Objeto de búsqueda de la solicitud

Parámetros de respuesta


NombreTipoDescripción

ResultGetDraftList

ResultGetDraftList

Objeto sin parámetros

draftList

Draft[]

Lista de objetos solicitud

Size

Integer

Número de elementos coincidentes con la búsqueda que se encuentran en la base de datos. Este parámetro se devuelve ya que con los parámetros de paginación se pueden solicitar que devuelva un máximo de objetos independientemente de cuántos haya en la base de datos.

Ejemplo de invocación


Ejemplo de invocación
//Objetos del servicio
ParamGetDraftList paramGetDraftList = new ParamGetDraftList();
DraftSearch objDraft = new DraftSearch();
	 
// parametros por los que filtrar
objDraft.setCreatorId("00000000T");
		 
// buscamos por procedimiento y organismos
objDraft.setProcedure("1");
		 
// Lista de organismos gestores a buscar
String[] orgListVisibility = new String[2];
orgListVisibility[0] = "ORG14668"; // organismo gestor
orgListVisibility[1] = "ORG12358"; // organismo gestor
		 
objDraft.setOrgListVisibility(orgListVisibility);
		 
paramGetDraftList.setDraftSearch(objDraft);
		 
// Se hace la invocación
try {
	ResultGetDraftList resultGetDraftList = draftClient.getDraftList(paramGetDraftList);
	if(resultGetDraftList!=null){
		System.out.println("Numero de resultados: "+resultGetDraftList.getSize());
	}else{
		System.out.println("No se han encontrado resultados");
	}
			
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}

Método 'getDraftListWithOrganism'


Obtiene una lista de solicitudes de notificación dadas de alta en el sistema, según un criterio de búsqueda.

En los borradores obtenidos, se obtiene la lista de organismos de visibilidad (organismVisibilityList) con el organismo productor y los organismos gestores.

 Más detalles

Signatura

ResultGetDraftListWithOrganism getDraftListWithOrganism(String applicationId, ParamGetDraftList paramGetDraftList) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetDraftListObjeto de obtención de borradores

draftSearch

DraftSearch

Objeto de búsqueda de la solicitud

Parámetros de respuesta


NombreTipoDescripción

ResultGetDraftListWithOrganism

ResultGetDraftListWithOrganism


draftList

DraftWithOrganism[]

Lista de objetos solicitud

Size

Integer

Número de elementos coincidentes con la búsqueda que se encuentran en la base de datos. Este parámetro se devuelve ya que con los parámetros de paginación se pueden solicitar que devuelva un máximo de objetos independientemente de cuántos haya en la base de datos.

Ejemplo de invocación


Ejemplo de invocación
//Objetos del servicio
ParamGetDraftList paramGetDraftList = new ParamGetDraftList();
	
DraftSearch objDraft = new DraftSearch();
 
//parametros por los que filtrar
objDraft.setCreatorId("00000000T");
		 
// buscamos por procedimiento y organismos
objDraft.setProcedure("1");
	
// Lista de organismos gestores a buscar 
String[] orgListVisibility = new String[2];
orgListVisibility[0] = "ORG14668"; // organismo gestor
orgListVisibility[1] = "ORG12358"; // organismo gestor
		 
objDraft.setOrgListVisibility(orgListVisibility);
	 
paramGetDraftList.setDraftSearch(objDraft);
		 
//Se hace la invocación
try {
	ResultGetDraftList resultGetDraftList = draftClient.getDraftList(paramGetDraftList);
	if(resultGetDraftList!=null){
		System.out.println("Numero de resultados: "+resultGetDraftList.getSize());
	}else{
		System.out.println("No se han encontrado resultados");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}

Método 'getDraftDocument'


Obtiene los datos físicos del documento principal de una solicitud de notificación dada de alta en el sistema.

 Más detalles

Signatura

ResultGetDraftDocument getDraftDocument(String applicationId, ParamGetDraftDocument paramGetDraftDocument) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetDraftDocumentObjeto de obtención de borradores

draftId

Long

Identificador de la solicitud

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultGetDraftDocument

ResultGetDraftDocument


draftDocument

DataHandler

Fichero documento principal de la solicitud

Ejemplo de invocación


Ejemplo de invocación
		// Objectos del servicio
		ParamGetDraftDocument paramGetDraftDocument = new ParamGetDraftDocument ();
		 
		// Se indica el idDraft del documento que queremos recuperar
		paramGetDraftDocument.setDraftId(8735L);
		paramGetDraftDocument.setInvokingId("00000000T");
		 
		// Se hace la invocación
		try {
			ResultGetDraftDocument resultGetDraftDocument = draftClient.getDraftDocument(paramGetDraftDocument);
			if(resultGetDraftDocument!=null){
				System.out.println("Documento encontrado: " + resultGetDraftDocument.getDraftDocument().getName() );
			} else{
				System.out.println("No se ha encontrado el documento");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'addAttachment'


Añade un documento adjunto a una solicitud de notificación dada de alta en el sistema. Este documento puede o no ir firmado.

 Más detalles

Signatura

ResultAddAttachment addAttachment(String applicationId, ParamAddAttachment paramAddAttachment, DataHandler document) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

DataHandler

Datos físicos del documento adjunto sin parámetros

ParamAddAttachmentObjeto de obtención de borradores

attachmentDocument

AttachmentDocument

Metadatos del documento adjunto

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultAddAttachment

Objeto de resultado

documentId

Long

Identificador del documento adjunto a la solicitud

Ejemplo de invocación


Ejemplo de invocación
		ParamAddAttachment paramAddAttachment = new ParamAddAttachment();
		DocumentAttachment documentAttachment = new DocumentAttachment();
		paramAddAttachment.setAttachmentDocument(documentAttachment);
		paramAddAttachment.setInvokingId("00000000T");
		
		byte[] documentBytes = new byte[1024]; // Datos del dataHandler recibido
		String mimeType = "";

		// Se va a obtener de CCSV el contenido de un documento almacenado
		try {
			// INICIO integracion CCSV
			ParamGetDocument paramGetDocument = new ParamGetDocument();
			paramGetDocument.setCsv("CSVNB5FBO976F1F00SNT");
			// No queremos recuperar las firmas, unicamente el documento principal
			paramGetDocument.setAddSignatures(false);
			paramGetDocument.setApplicationId("APP");
			paramGetDocument.setAddContent(true);
			paramGetDocument.setNif("00000000T");
			
			ResultGetDocument resultGetDocument = ccsvClient.getDocument(paramGetDocument); // Obtenemos el fichero(byte[]) de Notificacion de documentum
			
			if (ReturnCode.OK.equals(resultGetDocument.getReturnCode())) {
				InputStream is = resultGetDocument.getDocument().getContent().getInputStream();
				
				ByteArrayOutputStream output = new ByteArrayOutputStream();
				int size = 0;
				while ((size=is.read(documentBytes,0,1024)) > 0) {
					output.write(documentBytes,0,size);
				}
				
				documentBytes = output.toByteArray(); // Se almacena el contenido del documento
				mimeType = resultGetDocument.getDocument().getType(); // Se obtiene el mimetype
				output.close();
			} else {
				System.out.println("CCSV_DOCUMENT_BY_CSV_ERROR "  + "CSVNB5FBO976F1F00SNT" + " ERROR " + resultGetDocument.getErrorMessage());
				throw new com.tbsolutions.snt.client.exception.InternalCoreException(SNTClientConstants.DOCUMENTUM_CCSV_ERROR, resultGetDocument.getErrorMessage());
			}
			
		} catch (Throwable e) {
			System.out.println("Ha ocurrido un error al obtener de Documentum el fichero de Notificacion con CSV");
			throw new com.tbsolutions.snt.client.exception.InternalCoreException(SNTClientConstants.DOCUMENTUM_CCSV_ERROR, e.getMessage());
		}
		// FIN integracion CCSV
		 
		byte[] arrayByte = documentBytes;
		DataSource dataSource = new ByteArrayDataSource(arrayByte, mimeType);
		DataHandler dataHandler = new DataHandler(dataSource);
		
		ResultAddAttachment resultAddAttachment;
		try {
			resultAddAttachment = draftClient.addAttachment(paramAddAttachment,dataHandler);
			if(resultAddAttachment!=null && resultAddAttachment.getDocumentId()!=null){
				System.out.println("El documentId es: "+resultAddAttachment.getDocumentId());
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getAttachment'


Añade un documento adjunto a una solicitud de notificación dada de alta en el sistema. Este documento puede o no ir firmado.

 Más detalles

Signatura

ResultGetAttachment getAttachment(String applicationId, ParamGetAttachment paramGetAttachment) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetAttachment

Objeto de obtención del documento

draftId

Long

No

Identificador del documento adjunto a la solicitud para versiones anteriores a la v3

invokingId

String

No

Identificador del documento adjunto a la solicitud 

documentId

String

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultGetAttachment

Objeto de resultado

documentAttachment

DocumentAttachment

Metadatos del documento adjunto.

Ejemplo de invocación


Ejemplo de invocación
		ParamGetAttachment paramGetAttachment = new ParamGetAttachment();
		paramGetAttachment.setDraftId(new Long(5991));
		paramGetAttachment.setDocumentId("CSVX64OLQY16R1201PFI");
		paramGetAttachment.setInvokingId("00000000T");
		ResultGetAttachment resultGetAttachment;
		try {
			resultGetAttachment = draftClient.getAttachment(paramGetAttachment);
			DocumentAttachment documentAttachment = resultGetAttachment.getDocumentAttachment();
			if(documentAttachment!=null){
				System.out.println(documentAttachment.getCsv());
			}else{
				System.out.println("No se ha obtenido ningún resultado");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getAttachmentDocument'


Añade un documento adjunto a una solicitud de notificación dada de alta en el sistema. Este documento puede o no ir firmado.

 Más detalles

Signatura

ResultGetAttachmentDocument getAttachmentDocument(String applicationId, ParamGetAttachmentDocument paramGetAttachmentDocument) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetAttachmentDocument

Objeto de obtención del documento

draftId

Long

No

Identificador del documento adjunto a la solicitud para versiones anteriores a la v3

documentId

String

Si

Identificador del documento adjunto a la solicitud 

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultGetAttachmentDocument

Objeto de resultado

document

DataHandler

Fichero documento adjunto.

Ejemplo de invocación


Ejemplo de invocación
		ParamGetAttachmentDocument paramGetAttachmentDocument = new ParamGetAttachmentDocument();
		paramGetAttachmentDocument.setDraftId(new Long(5991));
		paramGetAttachmentDocument.setDocumentId("CSVX64OLQY16R1201PFI");
		paramGetAttachmentDocument.setInvokingId("00000000T");
		 
		try {
			ResultGetAttachmentDocument resultGetAttachmentDocument = draftClient.getAttachmentDocument(paramGetAttachmentDocument);
			if(resultGetAttachmentDocument!=null){
				System.out.println(resultGetAttachmentDocument.getDocument().getName());
			}else{
				System.out.println("No se ha obtenido ningún resultado");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getAttachmentList'


Obtiene una lista de los metadatos de documentos adjuntos relacionados con una solicitud de notificación.

 Más detalles

Signatura

ResultGetAttachmentList getAttachmentList(String applicationId, ParamGetAttachmentList paramGetAttachmentList) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetAttachmentList

Objeto de obtención del documento

documentAttachmentSearch

DocumentAttachmentSearch

Parámetros de búsqueda de los documentos.

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultGetAttachmentList

Objeto de resultado

documentAttachmentList

DocumentAttachment[]

Lista de documentos adjuntos a la solicitud

Size

Integer

Número de elementos totales que existe en la base de datos coincidentes con la búsqueda. Este parámetro se devuelve ya que al poder listar con parámetros de paginación se puede pedir al servicio que te devuelva un número máximo de documentos.

Ejemplo de invocación


Ejemplo de invocación
		// Objetos del Agente de Acceso
		ParamGetAttachmentList paramGetAttachmentList = new ParamGetAttachmentList();
		
		DocumentAttachmentSearch documentAttachmentSearch = new DocumentAttachmentSearch();
		documentAttachmentSearch.setParentId(new Long(7992)); // ID del borrador
		paramGetAttachmentList.setDocumentAttachmentSearch(documentAttachmentSearch);
		
		paramGetAttachmentList.setInvokingId("11111111H");
		
		ResultGetAttachmentList resultGetAttachmentList;
		try {
			resultGetAttachmentList = draftClient.getAttachmentList(paramGetAttachmentList);
			if(resultGetAttachmentList!=null && resultGetAttachmentList.getDocumentAttachmentList()!=null){
				DocumentAttachment[] documentAttachmentArray = resultGetAttachmentList.getDocumentAttachmentList();
				
				ArrayList arrayDocumentAttachment = new ArrayList();
				if(documentAttachmentArray!=null && documentAttachmentArray.length>0){
					for(int k=0;k<documentAttachmentArray.length;k++){
						if(documentAttachmentArray[k]!=null){
							arrayDocumentAttachment.add(documentAttachmentArray[k]);
							System.out.println("Se ha encontrado el documento: " + documentAttachmentArray[k].getAttId() );
						}
					}
				}
				
			} else{
				System.out.println("No se han encontrado adjuntos");
			}
			
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'updateAttachment'


Actualiza un documento adjunto relacionado con una solicitud de notificación dada de alta en el sistema. Se actualizarán sus metadatos y en caso de que se le envíe un DataHandler también se actualizarán sus datos físicos.

 Más detalles

Signatura

Result updateAttachment(String applicationId, ParamUpdateAttachment paramUpdateAttachment, DataHandler document) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

DataHandler
No

Fichero documento adjunto a la solicitud

ParamGetAttachmentList

Objeto de obtención del documento

draftId

Long

Identificador del documento adjunto a la solicitud

attId

String

Identificador del documento adjunto a la solicitud

Description

String

Descripción del adjunto

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

Result

Objeto devuelto sin ningún parámetro

Ejemplo de invocación


Ejemplo de invocación
		// Objetos del agente de acceso
		ParamUpdateAttachment paramUpdateAttachment = new ParamUpdateAttachment();
		
		paramUpdateAttachment.setDraftId(new Long(4001));
		paramUpdateAttachment.setDescription("Descripción modificada");
		paramUpdateAttachment.setAttId("CSV0U8PD0C0461V00SNT");
		paramUpdateAttachment.setInvokingId("00000000T");
		
		// Se hace la invocación
		try {
			Result resultUpdateAttachment = draftClient.updateAttachment(paramUpdateAttachment);
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'deleteAttachment'


Elimina un documento adjunto relacionado con una solicitud de notificación dada de alta en el sistema.

 Más detalles

Signatura

Result deleteAttachment(String applicationId, ParamDeleteAttachment paramDeleteAttachment) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamDeleteAttachment

Objeto de eliminación del documento

draftId

Long

No

Identificador del documento adjunto a la solicitud para versiones anteriores a la v3

attId

String

Identificador del documento adjunto a la solicitud

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultDeleteAttachmentResultDeleteAttachment

Result

Objeto devuelto sin ningún parámetro

Ejemplo de invocación


Ejemplo de invocación
		// Objetos del Agente de Acceso
		ParamDeleteAttachment paramDeleteAttachment = new ParamDeleteAttachment();
		paramDeleteAttachment.setAttId("CSV0U8PD0C0461V00SNT");
		paramDeleteAttachment.setDraftId(new Long(4001));
		paramDeleteAttachment.setInvokingId("00000000T");
		 
		try {
			ResultDeleteAttachment result = draftClient.deleteAttachment(paramDeleteAttachment);
			System.out.println(result.getMessage());
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'issueNotification'


Emite una solicitud de notificación, pasando esta a ser una notificación propiamente dicha.

Con la invocación de este servicio se genera un recibo de emisión que se asocia a la nueva notificación y se genera y consume un evento de tipo emisión. Por defecto, este evento envía un correo electrónico al receptor y a la lista de comunicación que tenga el borrador. Además, se genera y guarda y sello de tiempo con la fecha de emisión.

Información

Se ha modificado la lógica del servicio para que el usuario pueda emitir notificaciones en organismos en los que no tengan rol directamente pero estén en su rama.
Se podrá emitir en organismos de la misma rama en orden descendente, es decir, podrá emitir el el organismo padre del organismo que tenga roles.

 Más detalles

Signatura

ResultIssueNotification issueNotification(String applicationId, ParamIssueNotification paramIssueNotification) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamIssueNotification

Objeto de eliminación del documento

draftId

Long

Identificador de la solicitud

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultIssueNotification ResultIssueNotification

notificationId

Long

Identificador de la notificación

Ejemplo de invocación


Ejemplo de invocación
		// Objetos del servicio
		ParamIssueNotification paramIssueNotification = new ParamIssueNotification();
		
		// Se indica el Id de la solicitud a actualizar (debe estar en estado 3=Pendiente de emisión)
		paramIssueNotification.setDraftId(new Long(3389));
		paramIssueNotification.setInvokingId("00000000T");
		 
		// Se hace la invocación
		try {
			ResultIssueNotification resultIssueNotification = draftClient.issueNotification(paramIssueNotification);
			System.out.println("Emitida notificación: "+resultIssueNotification.getNotificationId());
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'createIssueRegisterNotification' @deprecated


Crea una notificación, la emite y la registra en un mismo paso.

A la hora de crear la notificación tenemos que tener en cuenta la visibilidad. Las notificaciones serán creadas con visibilidad compartida y con organismo gestor el indicado en el parámetro organism

Método deprecado, es recomendable usar el servicio createIssueRegisterNotificationWithOrganism() para gestionar de manera específica la visibilidad de las notificaciones.

Información

Se ha modificado la lógica del servicio para que el usuario pueda emitir notificaciones en organismos en los que no tengan rol directamente pero estén en su rama.
Se podrá emitir en organismos de la misma rama en orden descendente, es decir, podrá emitir el el organismo padre del organismo que tenga roles.

 Más detalles

Signatura

ResultCreateIssueRegisterNotification createIssueRegisterNotification(ParamCreateIssueRegisterNotification paramCreateIssueRegisterNotification) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamCreateIssueRegisterNotification

Objeto de eliminación del documento

draft

DraftCreateIssue

Id

Long

Identificador interno de la solicitud

creatorId

String

Identificador del funcionario creador de la solicitud

issuerId

String

Identificador del funcionario emisor de la solicitud

draftReceiversList

DraftReceiver[]

Lista de destinatarios de la solicitud

dossier

String

No

Número de Expediente de la solicitud

description

String

Asunto de la solicitud (Tamaño máximo de 250 caracteres)

expireTime

Integer

Tiempo que tardará en caducar la solicitud

organism

Organism

Objeto organismo

specificDataList

Data[]

Lista de datos específicos. (se detallan en Datos específicos)

procedure

String

Procedimiento por el cual se ha realizado la notificación.

Parámetros de respuesta


NombreTipoDescripción
ResultCreateIssueRegisterNotification ResultCreateIssueRegisterNotification

notificationId

String

Identificador de la notificación

Ejemplo de invocación


Ejemplo de invocación
		//objetos del servicio
		ParamCreateIssueRegisterNotification paramCreateIssueRegisterNotification = new ParamCreateIssueRegisterNotification();
		 
		//Se crea un receiver
		DraftReceiver draftReceiver = new DraftReceiver();
		draftReceiver.setReceiverId("00000000T");
		draftReceiver.setName("name");
		draftReceiver.setSurname1("surname1");
		draftReceiver.setSurname2("surname2");
		draftReceiver.setAddress("address");
		draftReceiver.setEmail("correo@mail.com");
		 
		//Se crea la lista de Receivers
		DraftReceiver[] draftReceivers = new DraftReceiver[1];
		draftReceivers[0] = draftReceiver;
		 
		//Se crea la lista de datos específicos
		Data[] specificDataList=new Data[3];
		specificDataList[0] = new Data("CSV_Notification","CSVRU4GYTJ46R1V01PFI");
		specificDataList[1] = new Data("CSV_Attached_1","CSVOB13DWL45O1R01PFI");
		specificDataList[2] = new Data("CSV_Attached_2","CSVZR3JG9C56Y1601PFI");
		 
		//Se crea el organismo asociado
		Organism organism = new Organism();
		organism.setCode("ORG14668");
		organism.setName("Departamento de Economía y Hacienda");
		 
		//Se rellena el objeto Draft
		DraftCreateIssue draft = new DraftCreateIssue();
		draft.setDossier("20110224-01");
		draft.setIssuerId ("00000000T");
		draft.setCreatorId("00000000T");
		draft.setDescription("20110224-01");
		draft.setOrganism(organism);
		draft.setSpecificDataList(specificDataList);
		draft.setDraftReceiversList(draftReceivers);
		draft.setExpireTime(new Integer(10));
		draft.setProcedure("1");
		 
		//Se rellena el objeto ParamCreateIssueNotification
		paramCreateIssueRegisterNotification.setDraft(draft);
		 
		//Se hace la invocación
		try {
			ResultCreateIssueRegisterNotification resultCreateIssueRegisterNotification = draftClient.createIssueRegisterNotification(paramCreateIssueRegisterNotification);
			System.out.println("Emitida notificacion con ID: "+resultCreateIssueRegisterNotification.getNotificationId());
			
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}
		 

Datos específicos

Se pueden añadir datos específicos para el envío a Notific@, adjuntos o el documento de notificación. Los valores serán los siguientes:

  • Notifica_envio_programado: Fecha para realizar un envío programado
  • CSV_Notification (Obligatorio): csv del documento de Notificación. Debe tener el estado Original o Copia Simple/Autentica.

  • CSV_Attached_x: para añadir documentos adjuntos. Donde la X será el número del adjunto (CSV_Attached_1, CSV_Attached_2....etc)

Método 'createIssueRegisterNotificationWithOrganism'


Crea una notificación, la emite y la registra en un mismo paso.

A la hora de crear la notificación tenemos que tener en cuenta la visibilidad. Si se quiere crear una notificación con visibilidad compartida tenemos que asignarle la lista de organismos (organismVisibilityList). Si no asignamos la lista de organismos, la notificación se creará con visibilidad limitada.

En la lista de visibilidad de organismos solamente hay que pasar los organismos gestores ya que el organismo productor se obtiene automáticamente por código.


Información

Se ha modificado la lógica del servicio para que el usuario pueda emitir notificaciones en organismos en los que no tengan rol directamente pero estén en su rama.
Se podrá emitir en organismos de la misma rama en orden descendente, es decir, podrá emitir el el organismo padre del organismo que tenga roles.

 Más detalles

Signatura

ResultCreateIssueRegisterNotification createIssueRegisterNotification(ParamCreateIssueRegisterNotificationWithOrganism paramCreateIssueRegisterNotification) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamCreateIssueRegisterNotificationWithOrganism 

Objeto de eliminación del documento

draft

DraftCreateIssue

Id

Long

Identificador interno de la solicitud

creatorId

String

Identificador del funcionario creador de la solicitud

issuerId

String

Identificador del funcionario emisor de la solicitud

draftReceiversList


Lista de destinatarios de la solicitud

dossier

String

No

Número de Expediente de la solicitud

description

String

Asunto de la solicitud (Tamaño máximo de 250 caracteres)

expireTime

Integer

Tiempo que tardará en caducar la solicitud

organism

Organism

Objeto organismo

specificDataList

Data[]

Lista de datos específicos. (se detallan en Datos específicos)

procedure

String

Procedimiento por el cual se ha realizado la notificación.

organismVisibilityList

OrganismVisibility[]

No

Listado de organismos utilizados en la visibilidad compartida.

Parámetros de respuesta


NombreTipoDescripción
ResultCreateIssueRegisterNotification ResultCreateIssueRegisterNotification

notificationId

String

Identificador de la notificación

Ejemplo de invocación


Ejemplo de invocación
		//objetos del servicio
		ParamCreateIssueRegisterNotificationWithOrganism paramCreateIssueRegisterNotification = new ParamCreateIssueRegisterNotificationWithOrganism();
		 
		//Se crea un receiver
		DraftReceiver draftReceiver = new DraftReceiver();
		draftReceiver.setReceiverId("11111111H");
		draftReceiver.setName("name");
		draftReceiver.setSurname1("surname1");
		draftReceiver.setSurname2("surname2");
		draftReceiver.setAddress("address");
		draftReceiver.setEmail("correo@mail.com");
		 
		//Se crea la lista de Receivers
		DraftReceiver[] draftReceivers = new DraftReceiver[1];
		draftReceivers[0] = draftReceiver;
		 
		//Se crea la lista de datos específicos
		Data[] specificDataList=new Data[3];
		specificDataList[0] = new Data("CSV_Notification","CSVRU4GYTJ46R1V01PFI");
		specificDataList[1] = new Data("CSV_Attached_1","CSVOB13DWL45O1R01PFI");
		specificDataList[2] = new Data("CSV_Attached_2","CSVZR3JG9C56Y1601PFI");
		 
		//Se crea el organismo asociado
		Organism organism = new Organism();
		organism.setCode("ORG14668");
		organism.setName("Departamento de Economía y Hacienda");
		 
		//Se rellena el objeto Draft
		DraftCreateIssueWithOrganism draft = new DraftCreateIssueWithOrganism();
		draft.setDossier("20110224-01");
		draft.setIssuerId ("11111111H");
		draft.setCreatorId("11111111H");
		draft.setDescription("20110224-01");
		draft.setOrganism(organism);
		draft.setSpecificDataList(specificDataList);
		draft.setDraftReceiversList(draftReceivers);
		draft.setExpireTime(new Integer(10));
		draft.setProcedure("1");
		 
		//lista de organismos gestores para la visibilidad compartida (si no se asigna la lista se creará con visibilidad limitada)
		OrganismVisibility[] organismVisibilities = new OrganismVisibility[2];
		 
		OrganismVisibility organismVisibility = new OrganismVisibility();
		organismVisibility.setOrganismCode("ORG14668");
		organismVisibility.setTipoRelacion(SNTClientConstants.ORG_GESTOR);
		 
		organismVisibilities[0] = organismVisibility;
		 
		organismVisibility = new OrganismVisibility();
		organismVisibility.setOrganismCode("ORG12358");
		organismVisibility.setTipoRelacion(SNTClientConstants.ORG_GESTOR);
		 
		organismVisibilities[1] = organismVisibility;
		 
		draft.setOrganismVisibilityList(organismVisibilities);
		 
		//Se rellena el objeto ParamCreateIssueNotification
		paramCreateIssueRegisterNotification.setDraft(draft);
		 
		//Se hace la invocación
		try {
			ResultCreateIssueRegisterNotification resultCreateIssueRegisterNotification = draftClient.createIssueRegisterNotificationWithOrganism(paramCreateIssueRegisterNotification);
			if(resultCreateIssueRegisterNotification!=null){
				System.out.println("ID de la notificación: "+ resultCreateIssueRegisterNotification.getNotificationId());
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Datos específicos

Se pueden añadir datos específicos para el envío a Notific@, adjuntos o el documento de notificación. Los valores serán los siguientes:

  • Notifica_envio_programado: Fecha para realizar un envío programado
  • CSV_Notification (Obligatorio): csv del documento de Notificación. Debe tener el estado Original o Copia Simple/Autentica.

  • CSV_Attached_x: para añadir documentos adjuntos. Donde la X será el número del adjunto (CSV_Attached_1, CSV_Attached_2....etc)

Método 'verifySignedDocument'


Verifica la firma de un documento asociado a un borrador que esté firmado.

 Más detalles

Signatura

ResultVerifySignedDocument verifySignedDocument(String applicationId, ParamVerifySignedDocument paramVerifySignedDocument) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamVerifySignedDocument

Objeto de verificación del documento

documentId

Long

Identificador del documento que se desee verificar.

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultVerifySignedDocument ResultVerifySignedDocument

certList

Cert[]

Lista de los certificados que han firmado el documento.

Ejemplo de invocación


Ejemplo de invocación
		// Objetos del servicio
		ParamVerifySignedDocument paramVerifySignedDocument = new ParamVerifySignedDocument ();
		paramVerifySignedDocument.setDocumentId("CSVRU4GYTJ46R1V01PFI");
		paramVerifySignedDocument.setInvokingId("00000000T");
		 
		//Se consume el servicio
		try {
			ResultVerifySignedDocument resultVerifySignedDocument = draftClient.verifySignedDocument(paramVerifySignedDocument);
			if(resultVerifySignedDocument!=null && resultVerifySignedDocument.getCertList()!=null && resultVerifySignedDocument.getCertList().length>0 ){
				for (Cert cert : resultVerifySignedDocument.getCertList()) {
					System.out.println(cert.getStatus());
				}
			}else{
				System.out.println("No se han obtenido datos");
			}
		} catch (SNTException e) {
			System.out.println("Error: "+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'issueRegisterNotification'


Emite una solicitud de notificación, pasando esta a ser una notificación propiamente dicha.

Con la invocación de este servicio se genera un recibo de emisión que se asocia a la nueva notificación y se genera y consume un evento de tipo emisión. Por defecto, este evento envía un correo electrónico al receptor y a la lista de comunicación que tenga el borrador. Además, se genera y guarda y sello de tiempo con la fecha de emisión. Internamente se conecta con el sistema de registro telemático para generar el asiento registral salida de la notificación a emitir.

Información

Se ha modificado la lógica del servicio para que el usuario pueda emitir notificaciones en organismos en los que no tengan rol directamente pero estén en su rama.
Se podrá emitir en organismos de la misma rama en orden descendente, es decir, podrá emitir el el organismo padre del organismo que tenga roles.

 Más detalles

Signatura

ResultIssueRegisterNotification issueRegisterNotification(String applicationId, ParamIssueRegisterNotification paramIssueRegisterNotification) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamIssueRegisterNotification

Objeto de solicitud

draftId

Long

Identificador de la solicitud de notificación creada anteriormente

organismRegister

String

Código de organismo en cuyo libro registral de salida se realizará el asiento de la notificación a emitir

issuerId

String

Identificador (NIF) del empleado público que realiza la emisión de la notificación y que será el representante del organismo emisor en el asiento registral correspondiente

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultIssueRegisterNotification ResultIssueRegisterNotification

notificationId

Long

Identificador de la notificación

Ejemplo de invocación


Ejemplo de invocación
		// Objetos del servicio
		ParamIssueRegisterNotification paramIssueRegisterNotification = new ParamIssueRegisterNotification();
		 		 
		// Se indica el Id de la solicitud a actualizar
		paramIssueRegisterNotification.setDraftId(new Long(4693));
		 
		paramIssueRegisterNotification.setOrganismRegister("ORG14668");
		paramIssueRegisterNotification.setIssuerId("00000000T");
		paramIssueRegisterNotification.setInvokingId("00000000T");
		 
		// Se hace la invocación
		try {
			ResultIssueRegisterNotification resultIssueRegisterNotification = draftClient.issueRegisterNotification(paramIssueRegisterNotification);
			if(resultIssueRegisterNotification != null){
				System.out.println("ID de la notificación: "+ resultIssueRegisterNotification.getNotificationId());
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'createDraftSpreadSheet' @deprecated


Inicia el proceso de alta desde un documento Excel, de una o varias notificaciones, creando para ello borrador/es en el sistema con los metadatos asociados a la notificación.

Para la creación del borrador solamente se envían los metadatos de la notificación, aún no su documento. Se pueden asociar documentos adjuntos a los borradores mediante CSV.

Método deprecado, es recomendable usar el servicio → createDraftSpreadsheetAdvanced()

 Más detalles

Signatura

ResultCreateDraftSpreadsheet createDraftSpreadsheet(String applicationId, ParamCreateDraftSpreadsheet paramCreateDraftSpreadsheet) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamCreateDraftSpreadsheet

Objeto de solicitud

spreadSheetDocument

Datahandler

Documento Excel a leer

organismRegister

String

Organismo del usuario logueado

organismVisibilityList

OrganismVisibility[]NOListado de organismos utilizados en la visibilidad compartida/limitada

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultCreateDraftSpreadsheet ResultCreateDraftSpreadsheet

draftIdList

Long[]

Lista de identificadores de las notificaciones

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
ParamCreateDraftSpreadsheet paramCreateDraftSpreadsheet = 
new ParamCreateDraftSpreadsheet();
ResultCreateDraftSpreadsheet resultCreateDraftSpreadsheet;

// Se indica el Id de la solicitud a actualizar
paramCreateDraftSpreadsheet.setDocument(dataHandler);
paramCreateDraftSpreadsheet.setFiscalAnagram(userLogin.getFiscalAnagram());
paramCreateDraftSpreadsheet.setNif(userLogin.getNif());
paramCreateDraftSpreadsheet.setOrganismCode(userLogin.getOrganismCode());
paramCreateDraftSpreadsheet.setInvokingId("1111111H");

// Se hace la invocación
resultCreateDraftSpreadsheet =
draftClient.createDraftSpreadsheet(paramCreateDraftSpreadsheet);

Método 'createDraftSpreadSheetAdvanced'


Inicia el proceso de alta desde un documento Excel, de una o varias notificaciones, creando para ello borrador/es en el sistema con los metadatos asociados a la notificación.

Para la creación del borrador solamente se envían los metadatos de la notificación, aún no su documento. Se pueden asociar documentos adjuntos a los borradores mediante CSV.

 Más detalles

Signatura

ResultCreateDraftSpreadSheetAdvanced createDraftSpreadsheetAdvanced(String applicationId, ParamCreateDraftSpreadSheetAdvanced paramCreateDraftSpreadSheetAdvanced) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamCreateDraftSpreadSheetAdvanced

Objeto de solicitud

spreadSheetDocument

Datahandler

Documento Excel a leer

organismRegister

String

Organismo del usuario logueado

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

procedureId

String

Código de procedimiento.

organismVisibilityList

OrganismVisibility[]NOListado de organismos utilizados en la visibilidad compartida/limitada

Parámetros de respuesta


NombreTipoDescripción
ResultCreateDraftSpreadSheetAdvanced ResultCreateDraftSpreadSheetAdvanced

draftIdList

Long[]

Lista de identificadores de las notificaciones

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
ParamCreateDraftSpreadsheetAdvanced paramCreateDraftSpreadsheetAdvanced = new ParamCreateDraftSpreadsheetAdvanced();
ResultCreateDraftSpreadsheetAdvanced result;

// Se indica el Id de la solicitud a actualizar
paramCreateDraftSpreadsheetAdvanced.setDocument(dataHandler);
paramCreateDraftSpreadsheetAdvanced.
setFiscalAnagram(userLogin.getFiscalAnagram());
paramCreateDraftSpreadsheetAdvanced.setNif(userLogin.getNif());
paramCreateDraftSpreadsheetAdvanced.
setOrganismCode(userLogin.getOrganismCode());
paramCreateDraftSpreadsheetAdvanced.setInvokingId("1111111H");

// Se hace la invocación
result = draftClient.createDraftSpreadsheetAdvanced(paramCreateDraftSpreadsheetAdvanced);

Método 'addAttachmentByCSV'


Añade un documento adjunto a una solicitud de notificación dada de alta en el sistema pasándole uno o varios csv's.

 Más detalles

Signatura

Result addAttachmentByCSV(String applicationId, ParamAddAttachmentByCSV paramAddAttachmentByCSV) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamAddAttachmentByCSV

Objeto de solicitud

draftId

Long

Identificador del borrador

attIdList

String

Lista de csv's a adjuntar al borrador

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
Result Objeto sin parámetros

Ejemplo de invocación


Ejemplo de invocación
			
	// Objetos del servicio
	ParamAddAttachmentByCSV paramAddAttachmentByCSV = new ParamAddAttachmentByCSV();
	
	// Se indica el Id de la solicitud a asociar el adjunto
	paramAddAttachmentByCSV.setDraftId(5000L);
	
	// Se añade la lista de csv's a adjuntar a la solicitud
	String[] csvAdjuntos = new String[3];
	csvAdjuntos[0] = "CSVPH06BYR54Y1601PFI";
	csvAdjuntos[1] = "CSVLV44LFX26O1601PFI";
	csvAdjuntos[2] = "CSV266CLIX05F1U01PFI";
	paramAddAttachmentByCSV.setAttIdList(csvAdjuntos);
	
	paramAddAttachmentByCSV.setInvokingId("00000000T");
	 
	// Se hace la invocación
	try {
		draftClient.addAttachmentByCSV(paramAddAttachmentByCSV);
	} catch (SNTException e) {
		System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
	}

Servicios NotificationService

Servicios de gestión de notificaciones emitidas.


Método 'getNotification' @deprecated


Obtiene los metadatos de una notificación dada de alta en el sistema.

La notificación que se obtiene no contiene la lista de visibilidad de organismos.

Método deprecado, es recomendable usar el servicio getNotificationWithOrganism() para obtener la visibilidad de las notificaciones.


 Más detalles

Signatura

ResultGetNotification getNotification(String applicationId, ParamGetNotification paramGetNotification) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipo
Descripción

applicationId

String

Aplicación que ejecuta el método

ParamGetNotification

Objeto de solicitud

notificationId

Long

Identificador de la notificación

Parámetros de respuesta


NombreTipoDescripción
ResultGetNotification ResultGetNotification

notification

Notification

Objeto notificación

Ejemplo de invocación


Ejemplo de invocación
		// Objectos del servicio
		ParamGetNotification paramGetNotification = new ParamGetNotification();
		
		// Se añade el id de la notificación
		paramGetNotification.setNotificationId(new Long(5000));

		// Se hace la invocación
		try {
			ResultGetNotification resultGetNotification = notificationClient.getNotification(paramGetNotification);
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getNotificationWithOrganism'


Obtiene los metadatos de una notificación dada de alta en el sistema.

La notificación que se obtiene contiene la lista de visibilidad de organismos con el organismo productor y los organismos gestores (en caso de que sea compartida ya que las limitadas solamente tienen organismo productor)


 Más detalles

Signatura

ResultGetNotificationWithOrganism getNotification(String applicationId, ParamGetNotification paramGetNotification) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetNotification

Objeto de solicitud

notificationId

Long

Identificador de la notificación

Parámetros de respuesta


NombreTipoDescripción
ResultGetNotificationWithOrganismResultGetNotificationWithOrganism

notification

NotificationWithOrganism

Objeto notificación

Ejemplo de invocación


Ejemplo de invocación
		// Objectos del servicio
		ParamGetNotification paramGetNotification = new ParamGetNotification();
		
		// Se añade el id de la notificación
		paramGetNotification.setNotificationId(new Long(5000));

		// Se hace la invocación
		try {
			ResultGetNotificationWithOrganism resultGetNotification = notificationClient.getNotificationWithOrganism(paramGetNotification);
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getNotificationList' @deprecated


Obtiene una lista de notificaciones dadas de alta en el sistema según unos criterios de búsqueda.

En las notificaciones devueltas no se obtiene la lista de visibilidad de organismos 

Método deprecado, es recomendable usar el servicio → getNotificationWithOrganismList() para obtener la visibilidad de las notificaciones.


 Más detalles

Signatura

ResultGetNotificationList getNotificationList(String applicationId, ParamGetNotificationList paramGetNotificationList) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetNotificationList

Objeto de solicitud

notificationSearch

NotificationSearch

Objeto relativo a la búsqueda de una notificación

Parámetros de respuesta


NombreTipoDescripción
ResultGetNotificationList ResultGetNotificationWithOrganism

notificationList

Notification[]

Lista de notificaciones

size

Integer

Número de elementos concidentes con la búsqueda que se encuentran en la base de datos. Este parámetro se devuelve ya que con los parámetros de paginación se pueden solicitar que devuelva un máximo de objetos independientemente de cuántos haya en la base de datos.

Ejemplo de invocación


Ejemplo de invocación
		NotificationSearch notificationSearch = new NotificationSearch();
		notificationSearch.setCreatorId("00000000T"); // Creador de la notificación
		notificationSearch.setState(SNTClientConstants.STATE_NOT_ACCEPTED); // Estado de la notificación
		notificationSearch.setProcedure("1"); // Procedimiento
		// notificationSearch...
		ParamGetNotificationList paramGetNotificationList = new ParamGetNotificationList(notificationSearch);
	
		try {
			ResultGetNotificationList resultGetNotificationList = 	notificationClient.getNotificationList(paramGetNotificationList);
			if(resultGetNotificationList!=null && resultGetNotificationList.getSize()>0){
				System.out.println("Se han encontrado: "+ resultGetNotificationList.getSize());
			}else{
				System.out.println("No se han encontrado resultados");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getNotificationWithOrganismList'


Obtiene una lista de notificaciones dadas de alta en el sistema según unos criterios de búsqueda.

En las notificaciones devueltas se obtiene una lista de visibilidad de organismos con el organismo productor y los organismos gestores (en caso de que sean de visibilidad compartida ya que las limitadas solamente tienen organismo productor)


 Más detalles

Signatura

ResultGetNotificationList getNotificationList(String applicationId, ParamGetNotificationList paramGetNotificationList) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetNotificationList

Objeto de solicitud

notificationSearch

NotificationSearch

Objeto relativo a la búsqueda de una notificación

Parámetros de respuesta


NombreTipoDescripción
ResultGetNotificationList ResultGetNotificationWithOrganism

notificationList

NotificationWithOrganism[]

Lista de notificaciones

size

Integer

Número de elementos concidentes con la búsqueda que se encuentran en la base de datos. Este parámetro se devuelve ya que con los parámetros de paginación se pueden solicitar que devuelva un máximo de objetos independientemente de cuántos haya en la base de datos.

Ejemplo de invocación


Ejemplo de invocación
		NotificationSearch  notificationSearch = new NotificationSearch();
		notificationSearch.setCreatorId("00000000T"); // Creador de la notificación
		notificationSearch.setState(SNTClientConstants.STATE_NOT_ACCEPTED);  // Estado de la notificación
		notificationSearch.setProcedure("1"); // Procedimiento
		// notificationSearch...  
		ParamGetNotificationList paramGetNotificationList = new ParamGetNotificationList(notificationSearch);
	
		try {
			ResultGetNotificationWithOrganismList resultGetNotificationList = notificationClient.getNotificationWithOrganismList(paramGetNotificationList);
			if(resultGetNotificationList!=null && resultGetNotificationList.getSize()>0){
				System.out.println("Se han encontrado: "+ resultGetNotificationList.getSize());
			}else{
				System.out.println("No se han encontrado resultados");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getNotificationDocument'


Obtiene los datos físicos del documento de notificación.

 Más detalles

Signatura

ResultGetNotificationDocument getNotificationDocument(String applicationId, ParamGetNotificationDocument paramGetNotificationDocument) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetNotificationDocument

Objeto de solicitud

notificationId

Long

Identificador de la notificación

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultGetNotificationDocument ResultGetNotificationDocument

NotificationDocument

DataHandler

Fichero documento de la notificación

Ejemplo de invocación


Ejemplo de invocación
		// Objetos del servicio
		ParamGetNotificationDocument paramGetNotificationDocument = new ParamGetNotificationDocument();
		
		// Se indica el id de la notificación del documento 
		paramGetNotificationDocument.setNotificationId(new Long(5000));
		paramGetNotificationDocument.setInvokingId("00000000T");

		// Se hace la invocación
		try {
			ResultGetNotificationDocument resultGetNotificationDocument = notificationClient.getNotificationDocument(paramGetNotificationDocument);
			if(resultGetNotificationDocument!=null && resultGetNotificationDocument.getNotificationDocument()!=null){
				System.out.println("Se ha obtenido el documento");
			}else{
				System.out.println("No se ha obtenido el documento");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}


Método 'getAttachment'


Obtiene los metadatos de un documento adjunto relacionado con una notificación dada de alta en el sistema.

 Más detalles

Signatura

ResultGetAttachment getAttachment(String applicationId, ParamGetAttachment paramGetAttachment) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetAttachment

Objeto de solicitud

documentId

Long

No

Identificador del documento adjunto a la solicitud para versiones anteriores a la v3

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultGetAttachment ResultGetNotificationDocument

documentAttachment

DocumentAttachment

Metadatos del documento adjunto.

Ejemplo de invocación


Ejemplo de invocación
		// Objetos del servicio
		ParamGetAttachment paramGetAttachment = new ParamGetAttachment();

		// Se indica el id del adjunto a recuperar
		paramGetAttachment.setDocumentId("CSV"); // CSV del documento a consultar
		paramGetAttachment.setInvokingId("00000000T");

		// Se hace la invocación
		try {
			ResultGetAttachment resultGetAttachment = notificationClient.getAttachment(paramGetAttachment);
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getAttachmentDocument'


Obtiene los datos físicos de un documento adjunto relacionado con una notificación dada de alta en el sistema.

 Más detalles

Signatura

ResultGetAttachmentDocument getAttachmentDocument(String applicationId, ParamGetAttachmentDocument paramGetAttachmentDocument) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetAttachmentDocument

Objeto de solicitud

documentId

Long

No

Identificador del documento adjunto a la solicitud

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultGetAttachmentDocumentResultGetAttachmentDocument

document

dataHandler

Documento adjunto a la notificación

Ejemplo de invocación


Ejemplo de invocación
		// Objectos del servicio
		ParamGetAttachmentDocument paramGetAttachmentDocument = new ParamGetAttachmentDocument();
		
		// Se incluye el documento a obtener
		paramGetAttachmentDocument.setDocumentId("CSV"); // CSV del documento a consultar
		paramGetAttachmentDocument.setInvokingId("00000000T"); // NIF del usuario que realiza la petición

		// Se hace la invocación
		try {
			ResultGetAttachmentDocument resultGetAttachmentDocument = notificationClient.getAttachmentDocument(paramGetAttachmentDocument);
			if(resultGetAttachmentDocument!=null){
				System.out.println("Se ha obtenido el documento: " + resultGetAttachmentDocument.getDocument().getName());
			}else{
				System.out.println("No se han obtenido resultados");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getAttachmentList'


Obtiene una lista de documentos adjuntos según unos criterios de búsqueda.

 Más detalles

Signatura

ResultGetAttachmentList getAttachmentList(String applicationId, ParamGetAttachmentList paramGetAttachmentList) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetAttachmentList

Objeto de solicitud

documentAttachmentsearch

DocumentAttachmentsearch

Parámetros de búsqueda relativos al documento adjunto a la notificación

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultGetAttachmentList ResultGetAttachmentList

documentAttachmentList

DocumentAttachmentList []

Lista de documentos adjuntos

size

Integer

Número de elementos concidentes con la búsqueda que se encuentran en la base de datos. Este parámetro se devuelve ya que con los parámetros de paginación se pueden solicitar que devuelva un máximo de objetos independientemente de cuántos haya en la base de datos

Ejemplo de invocación


Ejemplo de invocación
	// Objetos del Agente de Acceso
		ParamGetAttachmentList paramGetAttachmentList = new ParamGetAttachmentList();

		DocumentAttachmentSearch documentAttachmentSearch = new DocumentAttachmentSearch();
		documentAttachmentSearch.setParentId(new Long(5000)); // ID de la notificación
		
		paramGetAttachmentList.setDocumentAttachmentSearch(documentAttachmentSearch );
		paramGetAttachmentList.setInvokingId("00000000T");
		
		// Obtenemos la lista de documentos adjuntos
		try {
			ResultGetAttachmentList resultGetAttachmentList = notificationClient.getAttachmentList(paramGetAttachmentList);
			if(resultGetAttachmentList!=null && resultGetAttachmentList.getSize()>0){
				System.out.println("se han obtenido: " + resultGetAttachmentList.getSize());
			}else{
				System.out.println("No se han obtenido resultados");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'acceptNotification'


Servicio utilizado para realizar la aceptación de una notificación por parte de un ciudadano. Este servicio cambia el estado de la notificación a aceptada, genera un recibo de aceptación por parte del core y un evento que es consumido mediante el envío de un correo electrónico al destinatario.

 Más detalles

Signatura

Result acceptNotification(String applicationId, ParamAcceptNotification paramAcceptNotification, DataHandler document) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

dataHandlerDataHandlerDocumento de acuse de recibo de aceptación firmado por el ciudadano.
ParamAcceptNotification

Objeto de solicitud

notificationId

Long

Identificador de la notificación

reason

String

Motivo de la notificación

Extiende de FileInfo



Metadatos del documento de acuse de recibo firmado por el ciudadano.

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultAcceptNotificationResult Objeto que se devuelve como resultado sin ningún parámetro.

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
ParamAcceptNotification paramAcceptNotification = new ParamAcceptNotification();
paramAcceptNotification.setNotificationId(new Long(5000)); // ID de la notificación a aceptar

// Create global dataSource
DataSource dataSource;

// check detached signed
if(detached.booleanValue()){ // Documento con firma detached
	paramAcceptNotification.setFileSize(new Long(document.getDocument().length));
	paramAcceptNotification.setDetachedSignature(signedData);
	dataSource = new ByteArrayDataSource(document.getDocument(),document.getMimeType());
}else{ // Documento sin firma detached
	byte[] documentDataFromSigned = BASE64Decoder.decode(signedData);
	paramAcceptNotification.setFileSize(new Long(documentDataFromSigned.length));
	dataSource = new ByteArrayDataSource(documentDataFromSigned,document.getMimeType());
}
paramAcceptNotification.setName(document.getFileName()); // Nombre del documento
paramAcceptNotification.setFormatSignature(new Long(signatureFormat)); // Formato de la firma
paramAcceptNotification.setMimeType(document.getMimeType()); // mimetype del documento
paramAcceptNotification.setDescription(NTPcConfig.getReceiptEntryAcceptDescription()); // Descripción del documento
paramAcceptNotification.setMotivo(motivo); // Motivo de la aceptación
paramAcceptNotification.setInvokingId("00000000T"); // NIF del usuario que invoca
notificationClient.acceptNotification(paramAcceptNotification, new DataHandler(dataSource));

Método 'acceptNotificationByCSV'


Servicio utilizado para realizar la aceptación de una notificación por parte de un ciudadano. Este servicio cambia el estado de la notificación a aceptada, genera un recibo de aceptación por parte del core y un evento que es consumido mediante el envío de un correo electrónico al destinatario.

 Más detalles

Signatura

Result acceptNotificationByCSV(String applicationId, ParamAcceptNotificationByCSV paramAcceptNotificationByCSV, String documentCSV) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

documentCSVStringCSV del recibo de aceptación de la notificación
ParamAcceptNotificationByCSV 

Objeto de solicitud

notificationId

Long

Identificador de la notificación

reason

String

Motivo de la notificación

invokingId

String

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultAcceptNotificationResult Objeto que se devuelve como resultado sin ningún parámetro.

Ejemplo de invocación


Ejemplo de invocación
		// Objetos del servicio
		ParamAcceptNotificationByCSV paramAcceptNotificationByCSV = new ParamAcceptNotificationByCSV();
		
		String documentCSV = "CSVU61Z0FI12R1600SNT"; // CSV del documento de aceptación

		// Se rellena el param
		paramAcceptNotificationByCSV.setNotificationId(new Long(5000)); // ID de la notificación a aceptar
		paramAcceptNotificationByCSV.setInvokingId("00000000T"); // NIF del usuario que realiza la petición
		paramAcceptNotificationByCSV.setReason("Aceptada por ..."); // Motivo de aceptación

		// Se hace la invocación
		try {
			notificationClient.acceptNotificationByCSV(paramAcceptNotificationByCSV, documentCSV);
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'rejectNotification'


Servicio utilizado para realizar el rechazo de una notificación por parte de un ciudadano. Este servicio cambia el estado de la notificación a rechazada, genera un recibo de rechazo por parte del core y un evento que es consumido mediante el envío de un correo electrónico al destinatario.

 Más detalles

Signatura

Result rejectNotification(String applicationId, ParamRejectNotification paramRejectNotification, DataHandler document) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

dataHandlerDataHandlerDocumento de acuse de recibo de rechazo firmado por el ciudadano.
ParamRejectNotification 

Objeto de solicitud

notificationId

Long

Identificador de la notificación

reason

String

Motivo de la notificación

Extiende de FileInfo



Metadatos del documento de acuse de recibo firmado por el ciudadano.

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultRejectNotificationResult Objeto que se devuelve como resultado sin ningún parámetro.

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
ParamRejectNotification paramRejectNotification = new ParamRejectNotification();
paramRejectNotification.setNotificationId(new Long(5000)); // ID de la notificación a rechazar

// Create global dataSource
DataSource dataSource;

// check detached signed
if(detached.booleanValue()){ // Documento con firma detached
	paramRejectNotification.setFileSize(new Long(document.getDocument().length));
	paramRejectNotification.setDetachedSignature(signedData);
	dataSource = new ByteArrayDataSource(document.getDocument(),document.getMimeType());
} else { // Documento sin firma detached
	byte[] documentDataFromSigned = BASE64Decoder.decode(signedData);
	paramRejectNotification.setFileSize(new Long(documentDataFromSigned.length));
	dataSource = new ByteArrayDataSource(documentDataFromSigned,document.getMimeType());
}

// Se rellena el param
paramRejectNotification.setName(document.getFileName()); // Nombre del documento de rechazo
paramRejectNotification.setFormatSignature(new Long(signatureFormat)); // Formato de la firma
paramRejectNotification.setMimeType(document.getMimeType()); // MimeType del documento
paramRejectNotification.setDescription(NTPcConfig.getReceiptEntryRejectDescription()); // Descripción del documento de rechazo
paramRejectNotification.setMotivo(motivo); // Motivo del rechazo
paramRejectNotification.setInvokingId("00000000T"); // NIF del usuario que realiza la petición

// Se hace la invocación
notificationClient.rejectNotification(paramRejectNotification, new DataHandler(dataSource));

Método 'rejectNotificationByCSV'


Servicio utilizado para realizar el rechazo de una notificación por parte de un ciudadano usando un documento referenciado por su código CSV. Este servicio cambia el estado de la notificación a rechazada y genera un evento que es consumido mediante el envío de un correo electrónico al destinatario.

 Más detalles

Signatura

Result rejectNotificationByCSV(String applicationId, ParamRejectNotificationByCSV paramRejectNotificationByCSV, String documentCSV) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

documentCSVStringCSV del recibo de rechazo de la notificación
ParamRejectNotificationByCSV 

Objeto de solicitud

notificationId

Long

Identificador de la notificación

reason

String

Motivo de la notificación

invokingId

String

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultRejectNotificationByCSVResult Objeto que se devuelve como resultado sin ningún parámetro.

Ejemplo de invocación


Ejemplo de invocación
		// Objetos del servicio
		ParamRejectNotificationByCSV paramRejectNotificationByCSV = new ParamRejectNotificationByCSV();
		
		String documentCSV = "CSVU61Z0FI12R1600SNT"; // Documento firmado que será el justificante de rechazo

		// Se rellena el param
		paramRejectNotificationByCSV.setNotificationId(new Long(5000)); // ID de la notificación a rechazar
		paramRejectNotificationByCSV.setInvokingId("00000000T"); // NIF del usuario que invoca
		paramRejectNotificationByCSV.setReason("Rechazada por ..."); // Razon del rechazo

		// Se hace la invocación
		try {
			Result paramResult  = notificationClient.rejectNotificationByCSV(paramRejectNotificationByCSV, documentCSV);
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'verifySignedNotification'


Verifica la firma de un documento de notificación dado de alta en el sistema.

 Más detalles

Signatura

ResultVerifySignedNotification verifySignedNotification( String applicationId, ParamVerifySignedNotification paramVerifySignedNotification) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamVerifySignedNotification 

Objeto de solicitud

documentId

Long

Identificador de la notificación

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultVerifySignedNotificationResultVerifySignedNotificationObjeto que se devuelve como resultado 
certListCert[]Lista de los certificados con los que se firmó el documento.

Ejemplo de invocación


Ejemplo de invocación
// Objetos del agente de acceso
ParamVerifySignedNotification paramVerifySignedNotification = new ParamVerifySignedNotification();
ResultVerifySignedNotification resultVerifySignedNotification ;

// identificador de la notificación
paramVerifySignedNotification.setDocumentId(idNotification);
paramVerifySignedNotification.setInvokingId("1111111H");

// Se hace la invocación
resultVerifySignedNotification = notificationClient.verifySignedNotification(paramVerifySignedNotification);

Método 'verifySignedDocument'


Verifica la firma de un documento adjunto asociado a una notificación dada de alta en el sistema.

 Más detalles

Signatura

ResultVerifySignedDocument verifySignedDocument(String applicationId, ParamVerifySignedDocument paramVerifySignedDocument) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamVerifySignedDocument 

Objeto de solicitud

documentId

Long

Identificador de la notificación

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción
ResultVerifySignedDocumentResultVerifySignedDocumentObjeto que se devuelve como resultado 
certListCert[]Lista de los certificados con los que se firmó el documento.

Ejemplo de invocación


Ejemplo de invocación
		// Objetos del servicio
		ParamVerifySignedDocument paramVerifySignedDocument = new ParamVerifySignedDocument();
		paramVerifySignedDocument.setDocumentId("CSV"); // CSV del documento a verificar
		paramVerifySignedDocument.setInvokingId("00000000T"); // NIF del usuario que consulta

		// Se hace la invocación
		try {
			ResultVerifySignedDocument resultVerifySignedDocument = notificationClient.verifySignedDocument(paramVerifySignedDocument);
			if(resultVerifySignedDocument!=null&&resultVerifySignedDocument.getCertList()!=null){
				System.out.println("Se ha encontrado información de los siguientes certificados en la firma: "+resultVerifySignedDocument.getCertList().length);
			}else{
				System.out.println("No se ha podido verificar el documento");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getCountNotificationOtherAdministrations'


Busca el número de notificaciones emitidas por otras administraciones que tiene un usuario dado en el sistema Notific@

 Más detalles

Signatura

ResultGetCountNotificationOtherAdministrations getCountNotificationOtherAdministrations(ParamGetCountNotificationOtherAdministrations paramGetCountNotificationOtherAdministrations) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetCountNotificationOtherAdministrations 

Objeto de solicitud

userNif

String

Identificador del usuario del que se va a obtener el número de notificaciones. Si se trata de una aplicación web será la persona autenticada en el mismo.

notificationSearch

NotificationSearch

Objeto relativo a la búsqueda de una notificación

Parámetros de respuesta


NombreTipoDescripción
ResultGetCountNotificationOtherAdministrationsObjeto que se devuelve como resultado 
sizeLongNúmero de notificaciones emitidas por otras
administraciones

Ejemplo de invocación


Ejemplo de invocación
	// Objetos del servicio
	ParamGetCountNotificationOtherAdministrations paramGetCountNotificationOtherAdministrations = new ParamGetCountNotificationOtherAdministrations();
	paramGetCountNotificationOtherAdministrations.setUserNif("00000000T");
	NotificationSearch notificationSearch = new NotificationSearch();
	notificationSearch.setMinNotificationDate(Calendar.getInstance()); // Indicar fecha minima
	notificationSearch.setMaxNotificationDate(Calendar.getInstance()); // Indicar fecha máxima
			
	paramGetCountNotificationOtherAdministrations.setNotificationSearch(notificationSearch );

	// Se hace la invocación
	try {
		ResultGetCountNotificationOtherAdministrations result = notificationClient.getCountNotificationOtherAdministrations(paramGetCountNotificationOtherAdministrations);
		if(result!=null && result.getSize()>0){
			System.out.println("Se han obtenido: "+result.getSize());
		}else{
			System.out.println("No se han obtenido resultados");
		}
			
	} catch (SNTException e) {
		System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
	}

Método 'getSendMail'


Busca si una notificación tiene envíos de aviso por correo

 Más detalles

Signatura

ResultGetSendMail getSendMail(ParamGetSendMail paramGetSendMail) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamGetSendMail 

Objeto de solicitud

notificationSendMailBean

NotificationSendMail

Objeto relativo a la búsqueda de una notificación

Parámetros de respuesta

NombreTipoDescripción
ResultGetSendMailObjeto que se devuelve como resultado 
getSendMailListNotificationSendMail[]Lista con los avisos enviados de la notificación
sizeLongNúmero de avisos enviados de la notificación

Ejemplo de invocación

Ejemplo de invocación
		ParamGetSendMail paramGetSendMail = new ParamGetSendMail();
		NotificationSendMail notificationSendMail = new NotificationSendMail();
		
		notificationSendMail.setIdNotification(new Long(5786)); // ID de la notificación a consultar
		
		paramGetSendMail.setNotificationSendMailBean(notificationSendMail);
		
		try {
			ResultGetSendMail resultGetSendMail = notificationClient.getSendMail("APP", paramGetSendMail);
			if(resultGetSendMail!=null && resultGetSendMail.getSize()>0){
				System.out.println("Se han encontrado: " + resultGetSendMail.getSize());
			}else{
				System.out.println("No se han obtenido resultados");
			}
		} catch (InternalCoreException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		} catch (RemoteException e) {
			System.out.println("Error:"+e.getLocalizedMessage()+" Mensaje:"+e.getMessage());
		}

Método 'sendMail'


Guarda o actualiza en la base de datos un envio de aviso por correo para una notificación

 Más detalles

Signatura

ParamSendMail getSendMail(ResultSendMail paramGetSendMail) throws RemoteException, InternalCoreException;

Parámetros de invocación

NombreTipoObligatorioDescripción

applicationId

String

Aplicación que ejecuta el método

ParamSendMail 

Objeto de solicitud

notificationSendMailBean

NotificationSendMail

Objeto relativo al envio de un aviso en papel

Parámetros de respuesta

NombreTipoDescripción
ResultSendMailObjeto que se devuelve como resultado 
isErrorsBooleanIndica si la operación ha tenido algun error
errorCodeStringCadena que muestra el código de error (si ha ocurrido)
errorMessageStringCadena que muestra el mensaje de error (si ha ocurrido)

Ejemplo de invocación

Ejemplo de invocación
		ParamSendMail paramSendMail = new ParamSendMail();
		
		NotificationSendMail notificationSendMail = new NotificationSendMail();
		notificationSendMail.setIdNotification(new Long(5000)); // ID de la notificación
		notificationSendMail.setSendId("REF_CORREOS_ENVIO"); // Referencia del envio 
		notificationSendMail.setSendDate(Calendar.getInstance()); // Fecha de envio
		notificationSendMail.setAddress("Calle Mayor"); // Direccion
		notificationSendMail.setName("Pepe Perez Gomez");
		notificationSendMail.setReceiptId("REF_CORREOS_ACUSE"); // Referencia de recepción
		notificationSendMail.setReceiptDate(Calendar.getInstance()); // Fecha de recepción
		notificationSendMail.setState(SNTClientConstants.NOT_ACCEPT_PAPEL); // Valores posibles: SNTClientConstants.NOT_ACCEPT_PAPEL || 	
																							  // SNTClientConstants.NOT_REJECT_PAPEL
		
		paramSendMail.setNotificationSendMail(notificationSendMail);
		
		try {
			ResultSendMail resultSendMail = notificationClient.sendMail("APP", paramSendMail);
			if(resultSendMail!=null && !resultSendMail.getIsErrors()){
				System.out.println("Se ha guardado correctamente");
			}else{
				System.out.println("Ha ocurrido un error en el guardado: "+resultSendMail.getErrorMessage());
			}
		} catch (InternalCoreException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		} catch (RemoteException e) {
			System.out.println("Error:"+e.getLocalizedMessage()+" Mensaje:"+e.getMessage());
		}

Servicios CommunicationNTDraftService

Servicios de gestión de comunicaciones en estado borrador.


Método 'createCommunicationNTDraft@deprecated


Inicia el proceso de alta de una comunicación creando para ello un borrador en el sistema con los metadatos asociados a la comunicación.au

A la hora de crear un borrador tenemos que tener en cuenta la visibilidad. Todos los borradores creados con este método se crearán con visibilidad compartida y el organismo gestor será el indicado en el campo organismo.

Método deprecado, es recomendable usar el servicio → createCommunicationNTDraftWithOrganism() para gestionar de manera específica la visibilidad de las comunicaciones.


 Más detalles

Signatura


ResultCreateCommunicationNTDraft createCommunicationNTDraft(String applicationId, ParamCreateCommunicationNTDraft paramCreateCommunicationNTDraft) throws RemoteException, InternalCoreException;

Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamCreateCommunicationNTDraftObjeto de creación del borrador
communicationNTDraftCommunicationNTDraft

Parámetros de respuesta


NombreTipoDescripción
resultCreateCommunicationNTDraftObjeto de resultado de la creación del borrador
communicationNTDraftIdStringIdentificador del borrador creado

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
//objetos del servicio
		ParamCreateCommunicationNTDraft paramCreateCommunicationNTDraft = new ParamCreateCommunicationNTDraft();
		
		//Se crea un receiver
		DraftReceiver draftReceiver = new DraftReceiver();
		draftReceiver.setReceiverId("00000000T");
		draftReceiver.setName("name");
		draftReceiver.setSurname1("surname1");
		draftReceiver.setSurname2("surname2");
		draftReceiver.setAddress("address");
		draftReceiver.setEmail("email@email.com");
		 
		//Se crea la lista de Receivers
		DraftReceiver[] draftReceivers = new DraftReceiver[1];
		draftReceivers[0] = draftReceiver;
		 
		//Se crea la lista de datos específicos
		Data[] specificDataList=new Data[3];
		specificDataList[0] = new Data("keyA1","valueA1");
		specificDataList[1] = new Data("keyA2","valueA2");
		specificDataList[2] = new Data("keyA3","valueA3");
		 
		//Se crea el organismo asociado
		Organism organism = new Organism();
		organism.setName("Departamento de Economía y Hacienda");
		organism.setCode("ORG14668");
		 
		//Se rellena el objeto Draft
		CommunicationNTDraft communicationNTDraftCreate = new CommunicationNTDraft();
		communicationNTDraftCreate.setDossier("20110224-01");
		communicationNTDraftCreate.setCreatorId("00000000T");
		communicationNTDraftCreate.setDescription("20110224-01");
		communicationNTDraftCreate.setOrganism(organism);
		communicationNTDraftCreate.setSpecificDataList(specificDataList);
		communicationNTDraftCreate.setDraftReceiversList(draftReceivers);
		communicationNTDraftCreate.setContent("20110224-01");
		communicationNTDraftCreate.setProcedure("1");
		             
		//Se rellena el objeto ParamCreateDraft              
		paramCreateCommunicationNTDraft.setCommunicationNTDraft(communicationNTDraftCreate);
		 
		//Se hace la invocación
		try {
			ResultCreateCommunicationNTDraft resultCreateCommunicationNTDraft = communicationNTDraftClient.createCommunicationNTDraft(paramCreateCommunicationNTDraft);
			if(resultCreateCommunicationNTDraft!=null && resultCreateCommunicationNTDraft.getCommunicationNTDraftId()!=null){
				System.out.println("Se ha creado el borrador con ID: "+resultCreateCommunicationNTDraft.getCommunicationNTDraftId());
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'createCommunicationNTDraftWithOrganism'


Inicia el proceso de alta de una notificación creando para ello un borrador en el sistema con los metadatos asociados a la notificación.

A la hora de crear una comunicación tenemos que tener en cuenta la visibilidad. Si se quiere crear una comunicación con visibilidad compartida tenemos que asignarle la lista de organismos (organismVisibilityList). Si no asignamos la lista de organismos, la comunicación se creará con visibilidad limitada.

En la lista de visibilidad de organismos solamente hay que pasar los organismos gestores ya que el organismo productor se obtiene automáticamente por código.


 Más detalles

Signatura

ResultCreateCommunicationNTDraftWithOrganism createCommunicationNTDraftWithOrganism(String applicationId, ParamCreateCommunicationNTDraftWithOrganism paramCreateCommunicationNTDraftWithOrganism) throws RemoteException, InternalCoreException;

Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamCreateCommunicationNTDraftWithOrganismObjeto de creación del borrador
communicationNTDraftWithOrganismCommunicationNTDraftWithOrganism

Parámetros de respuesta


NombreTipoDescripción
resultCreateCommunicationNTDraftObjeto de resultado de la creación del borrador
communicationNTDraftIdStringIdentificador del borrador creado

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
//objetos del servicio
		ParamCreateCommunicationNTDraftWithOrganism paramCreateCommunicationNTDraft = new ParamCreateCommunicationNTDraftWithOrganism();
		
		 
		//Se crea un receiver
		DraftReceiver draftReceiver = new DraftReceiver();
		draftReceiver.setId(null);
		draftReceiver.setIdDraft(null);
		draftReceiver.setReceiverId("11111111H");
		draftReceiver.setName("name");
		draftReceiver.setSurname1("surname1");
		draftReceiver.setSurname2("surname2");
		draftReceiver.setAddress("address");
		draftReceiver.setEmail("email");
		 
		//Se crea la lista de Receivers
		DraftReceiver[] draftReceivers = new DraftReceiver[1];
		draftReceivers[0] = draftReceiver;
		 
		//Se crea la lista de datos específicos
		Data[] specificDataList=new Data[3];
		specificDataList[0] = new Data("keyA1","valueA1");
		specificDataList[1] = new Data("keyA2","valueA2");
		specificDataList[2] = new Data("keyA3","valueA3");
		 
		//Se crea el organismo asociado
		Organism organism = new Organism();
		organism.setName("Departamento de Economía y Hacienda");
		organism.setCode("ORG14668");
		 
		//Se rellena el objeto Draft
		CommunicationNTDraftWithOrganism communicationNTDraftCreate = new CommunicationNTDraftWithOrganism();
		communicationNTDraftCreate.setDossier("20110224-01");
		communicationNTDraftCreate.setIssuerId("11111111H");
		communicationNTDraftCreate.setCreatorId("11111111H");
		communicationNTDraftCreate.setDescription("20110224-01");
		communicationNTDraftCreate.setOrganism(organism);
		communicationNTDraftCreate.setSpecificDataList(specificDataList);
		communicationNTDraftCreate.setDraftReceiversList(draftReceivers);
		communicationNTDraftCreate.setContent("20110224-01");
		communicationNTDraftCreate.setProcedure("1");
		 
		 
		//lista de organismos gestores para la visibilidad compartida (si no se asigna la lista se creará con visibilidad limitada)
		OrganismVisibility[] organismVisibilities = new OrganismVisibility[2];
		             
		OrganismVisibility organismVisibility = new OrganismVisibility();
		organismVisibility.setOrganismCode("ORG14668");        
		organismVisibility.setTipoRelacion(SNTClientConstants.ORG_GESTOR);
		             
		organismVisibilities[0] = organismVisibility;
		 
		organismVisibility = new OrganismVisibility();
		organismVisibility.setOrganismCode("ORG12358");        
		organismVisibility.setTipoRelacion(SNTClientConstants.ORG_GESTOR);
		             
		organismVisibilities[1] = organismVisibility;
		 
		communicationNTDraftCreate.setOrganismVisibilityList(organismVisibilities);
		             
		//Se rellena el objeto ParamCreateDraft              
		paramCreateCommunicationNTDraft.setCommunicationNTDraft(communicationNTDraftCreate);
		 
		//Se hace la invocación
		try {
			ResultCreateCommunicationNTDraft resultCreateCommunicationNTDraft = communicationNTDraftClient.createCommunicationNTDraftWithOrganism(paramCreateCommunicationNTDraft);
			if(resultCreateCommunicationNTDraft!=null && resultCreateCommunicationNTDraft.getCommunicationNTDraftId()!=null){
				System.out.println("Se ha creado el borrador con ID: "+resultCreateCommunicationNTDraft.getCommunicationNTDraftId());
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'updateCommunicationNTDraft@deprecated


Actualiza una solicitud de comunicación dada de alta en el sistema. Al enviar el parámetro communication, solamente se actualizarían los metadatos de éste.

Método deprecado, es recomendable usar el servicio → 4.- Servicios de SNT#updateCommunicationNTDraftWithOrganism para gestionar de manera específica la visibilidad de las comunicaciones.


 Más detalles

Signatura

Result updateCommunicationNTDraft(String applicationId, ParamUpdateCommunicationNTDraft paramCommunicationNTDraft) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamUpdateCommunicationNTDraftObjeto de actualización del borrador
invokingIdStringNoIdentificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.
communicationNTDraftCommunicationNTDraftObjeto solicitud

Parámetros de respuesta


NombreTipoDescripción

resultUpdateDraft

Objeto de resultado de la actualización del borrador

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
ParamGetCommunicationNTDraft paramGetCommunicationNTDraft = new ParamGetCommunicationNTDraft();
		 
		paramGetCommunicationNTDraft.setCommunicationNTDraftId(new Long(5000)); // ID del borrador de la comunicación
		ResultGetCommunicationNTDraft resultGetCommunicationNTDraft;
		try {
			resultGetCommunicationNTDraft = communicationNTDraftClient.getCommunicationNTDraft(paramGetCommunicationNTDraft); // Obtenemos el borrador actualizado
			
			CommunicationNTDraft communicationNTDraft = resultGetCommunicationNTDraft.getCommunicationNTDraft();
			 
			//Modificamos un dato
			communicationNTDraft.setDescription("Modificación de la descripción");
			 
			ParamUpdateCommunicationNTDraft paramUpdateCommunicationNTDraft = new ParamUpdateCommunicationNTDraft();
			 
			paramUpdateCommunicationNTDraft.setCommunicationNTDraft(communicationNTDraft);
			paramUpdateCommunicationNTDraft.setInvokingId("00000000T"); // NIF del usuario que invoca
			 
			// Invocamos al servicio
			try {
				communicationNTDraftClient.updateCommunicationNTDraft(paramUpdateCommunicationNTDraft);
			} catch (SNTException e) {
				System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
			}
		} catch (SNTException e1) {
			System.out.println("Error:"+e1.getCode()+" Mensaje:"+e1.getExtraInfo());
		}


Método 'updateCommunicationNTDraftWithOrganism'


Actualiza una solicitud de comunicación dada de alta en el sistema. Al enviar el parámetro communication, solamente se actualizarían los metadatos de éste.

A la hora de actualizar una comunicación tenemos que tener en cuenta la visibilidad. Si se quiere asignar una visibilidad limitada no se tiene que asignar la lista de visibilidad de organismos. En cambio, si se quiere asignar una visibilidad compartida, se tiene que asignar la lista de visibilidad de organismos.

En la lista de visibilidad de organismos solamente hay que pasar los organismos gestores ya que el organismo productor se obtiene automáticamente por código.


 Más detalles

Signatura

Result updateCommunicationNTDraftWithOrganism(String applicationId, ParamUpdateCommunicationNTDraftWithOrganism paramCommunicationNTDraftWithOrganism) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamUpdateCommunicationNTDraftWithOrganismObjeto de actualización del borrador
invokingIdStringNoIdentificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.
communicationNTDraftWithOrganismCommunicationNTDraftWithOrganismObjeto solicitud

Parámetros de respuesta


NombreTipoDescripción

resultUpdateDraft

Objeto de resultado de la actualización del borrador

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
ParamGetCommunicationNTDraft paramGetCommunicationNTDraft = new ParamGetCommunicationNTDraft();
		paramGetCommunicationNTDraft.setCommunicationNTDraftId(new Long(5000)); // ID del borrador de la comunicación
		 
		ResultGetCommunicationNTDraftWithOrganism resultGetCommunicationNTDraft;
		try {
			resultGetCommunicationNTDraft = communicationNTDraftClient.getCommunicationNTDraftWithOrganism(paramGetCommunicationNTDraft);
			
			CommunicationNTDraftWithOrganism communicationNTDraft = resultGetCommunicationNTDraft.getCommunicationNTDraft();
			 
			//Modificamos un dato
			communicationNTDraft.setDescription("Modificación de la descripción");
			 
			ParamUpdateCommunicationNTDraftWithOrganism paramUpdateCommunicationNTDraft = new ParamUpdateCommunicationNTDraftWithOrganism();
			 
			paramUpdateCommunicationNTDraft.setCommunicationNTDraft(communicationNTDraft);
			paramUpdateCommunicationNTDraft.setInvokingId("00000000T");
			 
			// Invocamos al servicio
			try {
				communicationNTDraftClient.updateCommunicationNTDraftWithOrganism(paramUpdateCommunicationNTDraft);
			} catch (SNTException e) {
				System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
			}
		} catch (SNTException e1) {
			System.out.println("Error:"+e1.getCode()+" Mensaje:"+e1.getExtraInfo());
		}

Método 'deleteCommunicationNTDraft'


Elimina una solicitud de notificación dada de alta en el sistema.

 Más detalles

Signatura

Result deleteCommunicationNTDraft(String applicationId, ParamDeleteCommunicationNTDraft paramDeleteCommunicationNTDraft) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamDeleteCommunicationNTDraftObjeto de eliminación del borrador

communicationId

Long

Identificador de la solicitud a eliminar

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultDeleteCommunicationNTDraft

Objeto de resultado de la actualización del borrador

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
//Objectos del servicio
		ParamDeleteCommunicationNTDraft paramDeleteCommunicationNTDraft = new ParamDeleteCommunicationNTDraft ();
		 
		//Indicamos el Draft a eliminar
		paramDeleteCommunicationNTDraft.setCommunicationId(new Long(5000)); // ID de la comunicación
		paramDeleteCommunicationNTDraft.setInvokingId("00000000T"); // NIF del usuario que invoca
		 
		//Se hace la invocación
		try {
			Result resultDeleteCommunicationNTDraft = communicationNTDraftClient.deleteCommunicationNTDraft(paramDeleteCommunicationNTDraft);
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getCommunicationNTDraftList' @deprecated


Obtiene una lista de borradores tipo comunicación dadas de alta en el sistema, según un criterio de búsqueda.

Método deprecado, es recomendable usar el servicio → getCommunicationNTDraftWithOrganismList() para obtener la visibilidad de las comunicaciones.


 Más detalles

Signatura

ResultGetCommunicationNTDraftList getCommunicationNTDraftList(String applicationId, ParamGetCommunicationNTDraftList paramGetCommunicationNTDraftList) throws RemoteException, InternalCoreException;

Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetCommunicationNTDraftListObjeto para obtener una lista de borradores de tipo comunicación

communicationNTDraftSearch

CommunicationNTDraftSearch

Objeto de búsqueda de la solicitud

Parámetros de respuesta


NombreTipoDescripción

ResultGetCommunicationNTDraftList

Objeto de resultado de la obtención de la lista de borradores de tipo comunicación

communicationNTDraftList

CommunicationNTDraft[]

Lista de objetos solicitud

Size

Integer

Número de elementos coincidentes con la búsqueda que se encuentran en la base de datos. Este parámetro se devuelve ya que con los parámetros de paginación se pueden solicitar que devuelva un máximo de objetos independientemente de cuántos haya en la base de datos.

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
//Objetos del servicio
		ParamGetCommunicationNTDraftList paramGetCommunicationNTDraftList = new ParamGetCommunicationNTDraftList();
		CommunicationNTDraftSearch communicationNTDraft = new CommunicationNTDraftSearch();
		 
		//parametros por los que filtrar
		communicationNTDraft.setCreatorId("00000000T"); // Creador de la comunicación
		 
		// buscamos por procedimiento y organismos
		communicationNTDraft.setProcedure("1");
		 
		String[] orgListVisibility = new String[2];orgListVisibility[1] = "ORG14668"; // organismo gestor
		communicationNTDraft.setOrgListVisibility(orgListVisibility);
		 
		paramGetCommunicationNTDraftList.setCommunicationNTDraftSearch(communicationNTDraft);
		 
		//Se hace la invocación
		try {
			ResultGetCommunicationNTDraftList resultGetCommunicationNTDraftList = communicationNTDraftClient.getCommunicationNTDraftList(paramGetCommunicationNTDraftList);
			if(resultGetCommunicationNTDraftList!=null && resultGetCommunicationNTDraftList.getCommunicationNTDraftList()!=null){
				System.out.println("Se han encontrado: "+resultGetCommunicationNTDraftList.getCommunicationNTDraftList().length);
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}


Método 'getCommunicationNTDraftWithOrganismList'


Obtiene una lista de borradores tipo comunicación dadas de alta en el sistema, según un criterio de búsqueda.

En las comunicaciones obtenidas se obtiene una lista de visibilidad de organismos con el organismo productor y los organismos gestores (en caso de que sean de visibilidad compartida ya que las de visibilidad limitada solamente tienen organismo productor)


 Más detalles

Signatura

ResultGetCommunicationNTDraftWithOrganismList getCommunicationNTDraftList(String applicationId, ParamGetCommunicationNTDraftList paramGetCommunicationNTDraftList) throws RemoteException, InternalCoreException;

Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetCommunicationNTDraftListObjeto para obtener una lista de borradores de tipo comunicación

communicationNTDraftSearch

CommunicationNTDraftSearch

Objeto de búsqueda de la solicitud

Parámetros de respuesta


NombreTipoDescripción

ResultGetCommunicationNTDraftWithOrganismList

Objeto de resultado de la obtención de la lista de borradores de tipo comunicación

communicationNTDraftWithOrganismList

CommunicationNTDraftWithOrganismList[]

Lista de objetos solicitud

Size

Integer

Número de elementos coincidentes con la búsqueda que se encuentran en la base de datos. Este parámetro se devuelve ya que con los parámetros de paginación se pueden solicitar que devuelva un máximo de objetos independientemente de cuántos haya en la base de datos.

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
//Objetos del servicio
		ParamGetCommunicationNTDraftList paramGetCommunicationNTDraftList = new ParamGetCommunicationNTDraftList();
		 
		CommunicationNTDraftSearch communicationNTDraft = new CommunicationNTDraftSearch();
		 
		//parametros por los que filtrar
		communicationNTDraft.setCreatorId("00000000T");
		 
		// buscamos por procedimiento y organismos
		communicationNTDraft.setProcedure("1");
		 
		String[] orgListVisibility = new String[2];
		orgListVisibility[1] = "ORG14668"; // organismo gestor
		orgListVisibility[2] = "ORG12358"; // organismo gestor
		 
		communicationNTDraft.setOrgListVisibility(orgListVisibility);
		 
		paramGetCommunicationNTDraftList.setCommunicationNTDraftSearch(communicationNTDraft);
		 
		//Se hace la invocación
		try {
			ResultGetCommunicationNTDraftWithOrganismList resultGetCommunicationNTDraftList = communicationNTDraftClient.getCommunicationNTDraftWithOrganismList(paramGetCommunicationNTDraftList);
			if(resultGetCommunicationNTDraftList!=null && resultGetCommunicationNTDraftList.getCommunicationNTDraftList()!=null){
				System.out.println("Se han encontrado: "+resultGetCommunicationNTDraftList.getCommunicationNTDraftList().length);
			}else{
				System.out.println("No se han encontrado resultados");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}


Método 'getCommunicationNTDraft' @deprecated


Obtiene un borrador de tipo comunicación dado de alta en el sistema.

Método deprecado, es recomendable usar el servicio → getCommunicationNTDraftWithOrganism() para obtener la visibilidad de las comunicaciones.


 Más detalles

Signatura

ResultGetCommunicationNTDraft getCommunicationNTDraft(String applicationId, ParamGetCommunicationNTDraft paramGetCommunicationNTDraft) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetCommunicationNTDraftObjeto para obtener un borrador de tipo comunicación

communicationNTDraftId

Long

Identificador de la solicitud

Parámetros de respuesta


NombreTipoDescripción

ResultGetCommunicationNTDraft

Objeto de resultado de la obtención del borrador de tipo comunicación

communicationNTDraft

CommunicationNTDraft

Objeto de la solicitud

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
//Objetos del servicio
		ParamGetCommunicationNTDraft paramGetCommunicationNTDraft = new ParamGetCommunicationNTDraft();
		 		 
		//Se indica el Draft a obtener
		paramGetCommunicationNTDraft.setCommunicationNTDraftId(new Long(5000)); // ID del borrador de la comunicacion
		 
		//Se hace la invocación
		try {
			ResultGetCommunicationNTDraft resultGetCommunicationNTDraft = communicationNTDraftClient.getCommunicationNTDraft(paramGetCommunicationNTDraft);
			if(resultGetCommunicationNTDraft!=null && resultGetCommunicationNTDraft.getCommunicationNTDraft()!=null){
				System.out.println("Se ha encontrado: "+resultGetCommunicationNTDraft.getCommunicationNTDraft().getDescription());
			}else{
				System.out.println("No se han encontrado resultados");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getCommunicationNTDraftWithOrganism'


Obtiene un borrador de tipo comunicación dado de alta en el sistema.


 Más detalles

Signatura

ResultGetCommunicationNTDraftWithOrganism getCommunicationNTDraftWithOrganism(String applicationId, ParamGetCommunicationNTDraft paramGetCommunicationNTDraft) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetCommunicationNTDraftObjeto para obtener un borrador de tipo comunicación

communicationNTDraftId

Long

Identificador de la solicitud

Parámetros de respuesta


NombreTipoDescripción

ResultGetCommunicationNTDraftWithOrganism

Objeto de resultado de la obtención del borrador de tipo comunicación

communicationNTDraftWithOrgansm

CommunicationNTDraftWithOrganism

Objeto de la solicitud

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
//Objetos del servicio
		ParamGetCommunicationNTDraft paramGetCommunicationNTDraft = new ParamGetCommunicationNTDraft();
		 
		//Se indica el Draft a obtener
		paramGetCommunicationNTDraft.setCommunicationNTDraftId(new Long(5000)); // ID del borrador de la comunicacion
		 
		//Se hace la invocación
		try {
			ResultGetCommunicationNTDraftWithOrganism resultGetCommunicationNTDraft = communicationNTDraftClient.getCommunicationNTDraftWithOrganism(paramGetCommunicationNTDraft);
			if(resultGetCommunicationNTDraft!=null && resultGetCommunicationNTDraft.getCommunicationNTDraft()!=null){
				System.out.println("Se ha encontrado: "+resultGetCommunicationNTDraft.getCommunicationNTDraft().getDescription());
			}else{
				System.out.println("No se han encontrado resultados");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'addAttachmentByCSV'


Añade un documento adjunto a una solicitud de comunicación dada de alta en el sistema pasándole uno o varios csv's.

 Más detalles

Signatura

Result addAttachmentByCSV(String applicationId, ParamAddAttachmentByCSV paramAddAttachmentByCSV) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamAddAttachmentByCSVObjeto para añadir documentos adjuntos a una comunicación

draftId

Long

Identificador del borrador

attIdList

String[]

Lista de csv's a adjuntar al borrador

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

Result

Objeto de resultado de creación del documento adjunto asociado a la comunicación




Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
		ParamAddAttachmentByCSV paramAddAttachmentByCSV =
		new ParamAddAttachmentByCSV();
		// Se indica el Id de la solicitud a asociar el adjunto
		paramAddAttachmentByCSV.setDraftId(new Long(5000));
		// Se añade la lista de csv's a adjuntar a la solicitud
		String[] listaCSV = new String[1];
		listaCSV[0] = "CSV";
		paramAddAttachmentByCSV.setAttIdList(listaCSV);
		paramAddAttachmentByCSV.setInvokingId("00000000T");
		 
		// Se hace la invocación
		try {
			communicationNTDraftClient.addAttachmentByCSV(paramAddAttachmentByCSV);
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}


Método 'deleteAttachment'


Elimina un documento adjunto relacionado con una solicitud de comunicación dada de alta en el sistema.

 Más detalles

Signatura

Result deleteAttachment(String applicationId, ParamDeleteAttachment paramDeleteAttachment) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamDeleteAttachmentObjeto para eliminar documento adjunto asociado a una comunicación

draftId

Long

Identificador del documento adjunto a la solicitud

attId

String[]

Lista de csv's a adjuntar al borrador

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

Result

ResultObjeto de resultado de la eliminación del documento adjunto de la comunicación

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del Agente de Acceso
		ParamDeleteAttachment paramDeleteAttachment = new ParamDeleteAttachment();
		paramDeleteAttachment.setAttId("CSV1234567890XXX");
		paramDeleteAttachment.setDraftId(new Long(1573));
		paramDeleteAttachment.setInvokingId("00000000T");
		 
		try {
			communicationNTDraftClient.deleteAttachment(paramDeleteAttachment);
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Método 'getAttachment'


Obtiene los metadatos de un documento adjunto relacionado con una solicitud de comunicación dada de alta en el sistema.

 Más detalles

Signatura

ResultGetAttachment getAttachment(String applicationId, ParamGetAttachment paramGetAttachment) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetAttachmentObjeto para obtener los metadatos de un documento adjunto de la comunicación

draftId

Long

Sí (para v2)

Identificador del documento adjunto a la solicitud para versiones anteriores a la v3

documentId

String

Sí (para v3)

Identificador del documento adjunto a la solicitud para v3

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultGetAttachment

Objeto de resultado de la obtención de los metadatos del documeto adjunto de la comunicación

documentAttachment

DocumentAttachment

Metadatos del documento adjunto.

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
ParamGetAttachment paramGetAttachment = new ParamGetAttachment();
		
		paramGetAttachment.setDraftId(new Long(5000)); // id del borrador de la comunicacion
		paramGetAttachment.setDocumentId("CSV1234567890XXX");
		paramGetAttachment.setInvokingId("00000000T");
		 
		try {
			ResultGetAttachment resultGetAttachment = draftClient.getAttachment(paramGetAttachment);
			if(resultGetAttachment!=null && resultGetAttachment.getDocumentAttachment()!=null){
				System.out.println("Se ha obtenido el adjunto: "+resultGetAttachment.getDocumentAttachment().getFileName());
			} else{
				System.out.println("No se ha obtenido el adjunto"); 
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}


Método 'getAttachmentDocument'


Obtiene los datos físicos de un documento adjunto a una solicitud de comunicación dada de alta en el sistema.

 Más detalles

Signatura

ResultGetAttachmentDocument getAttachmentDocument(String applicationId, ParamGetAttachmentDocument paramGetAttachmentDocument) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetAttachmentDocumentObjeto para obtener los datos físicos de un documento adjunto de la comunicación

draftId

Long

Identificador del documento adjunto a la solicitud

documentId

String

Identificador del documento adjunto a la solicitud

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultGetAttachmentDocument

Objeto de resultado de la obtención de los datos físicos del documento adjunto de la comunicación

document

DataHandler

Fichero documento adjunto.

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
ParamGetAttachmentDocument paramGetAttachmentDocument = new ParamGetAttachmentDocument();
		paramGetAttachmentDocument.setDraftId(new Long(5000)); // Id del borrador de la comunicaicon
		paramGetAttachmentDocument.setDocumentId("CSV1234567890XXX");
		paramGetAttachmentDocument.setInvokingId("00000000T");
		 
		try {
			ResultGetAttachmentDocument resultGetAttachmentDocument = communicationNTDraftClient.getAttachmentDocument(paramGetAttachmentDocument);
			if(resultGetAttachmentDocument!=null && resultGetAttachmentDocument.getDocument()!=null){
				System.out.println("Se ha obtenido el adjunto: "+resultGetAttachmentDocument.getDocument().getName());
			} else{
				System.out.println("No se ha obtenido el adjunto"); 
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}


Método 'getAttachmentList'


Obtiene una lista de los metadatos de documentos adjuntos relacionados con una solicitud de comunicación.

 Más detalles

Signatura

ResultGetAttachmentList getAttachmentList(String applicationId, ParamGetAttachmentList paramGetAttachmentList) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetAttachmentListObjeto para obtener una lista de metadatos de documentos adjuntos de la comunicación

documentAttachmentSearch

DocumentAttachmentSearch

Parámetros de búsqueda de los documentos

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo

Parámetros de respuesta


NombreTipoDescripción

ResultGetAttachmentList

Objeto de resultado de la obtención de la lista de metadatos de documentos adjuntos de la comunicación

documentAttachmentList

DocumentAttachment[]

Lista de documentos adjuntos a la solicitud

Size

Integer

Número de elementos totales que existe en la base de datos coincidentes con la búsqueda. Este parámetro se devuelve ya que al poder listar con parámetros de paginación se puede pedir al servicio que te devuelva un número máximo de documentos.

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del Agente de Acceso
		ParamGetAttachmentList paramGetAttachmentList = new ParamGetAttachmentList();
		
		DocumentAttachmentSearch documentAttachmentSearch = new DocumentAttachmentSearch();
		documentAttachmentSearch.setParentId(new Long(7992)); // ID del borrador
		paramGetAttachmentList.setDocumentAttachmentSearch(documentAttachmentSearch);
		
		paramGetAttachmentList.setInvokingId("00000000T");
		
		ResultGetAttachmentList resultGetAttachmentList;
		try {
			resultGetAttachmentList = communicationNTDraftClient.getAttachmentList(paramGetAttachmentList);
			if(resultGetAttachmentList!=null && resultGetAttachmentList.getDocumentAttachmentList()!=null){
				DocumentAttachment[] documentAttachmentArray = resultGetAttachmentList.getDocumentAttachmentList();
				
				if(documentAttachmentArray!=null && documentAttachmentArray.length>0){
					for(int k=0;k<documentAttachmentArray.length;k++){
						if(documentAttachmentArray[k]!=null){
							System.out.println("Se ha encontrado el documento: " + documentAttachmentArray[k].getAttId() );
						}
					}
				}
				
			} else{
				System.out.println("No se han encontrado adjuntos");
			}
			
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}
		 


Método 'getCommunicationNTDraftDocument'


Obtiene los datos físicos del documento principal de una solicitud de comunicación dada de alta en el sistema.

 Más detalles

Signatura

ResultGetCommunicationNTDraftDocument getCommunicationNTDraftDocument(String applicationId, ParamGetCommunicationNTDraftDocument paramGetCommunicationNTDraftDocument) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetDraftDocumentObjeto para obtener los datos físicos del documento principal de la comunicación

communicationNTDraftId

Long

Identificador de la solicitud

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo

Parámetros de respuesta


NombreTipoDescripción

ResultGetCommunicationNTDraftDocument

Objeto de resultado de la obtención de los datos físicos del documento principal de la comunicación

communicationNTDraftDocument

DataHandler

Fichero documento principal de la solicitud

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
		ParamGetCommunicationNTDraftDocument paramGetCommunicationNTDraftDocument = new ParamGetCommunicationNTDraftDocument ();
		ResultGetCommunicationNTDraftDocument resultGetCommunicationNTDraftDocument;
		paramGetCommunicationNTDraftDocument.setCommunicationDraftId(new Long(5000)); // Se indica el idDraft del documento que queremos recuperar
		paramGetCommunicationNTDraftDocument.setInvokingId("1111111H");
		 
		// Se hace la invocación
		try {
			resultGetCommunicationNTDraftDocument = communicationNTDraftClient.getCommunicationNTDraftDocument(paramGetCommunicationNTDraftDocument);
			if(resultGetCommunicationNTDraftDocument!=null && resultGetCommunicationNTDraftDocument.getCommunicationNTDraftDocument()!=null){
				System.out.println("Se ha encontrado");
			} else{
				System.out.println("No se han encontrado");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}


Método 'verifySignedDocument'


Verifica la firma de un documento asociado a un borrador que esté firmado.

 Más detalles

Signatura

ResultVerifySignedDocument verifySignedDocument(String applicationId, ParamVerifySignedDocument paramVerifySignedDocument) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamVerifySignedDocumentObjeto para verificar la firma de un documento asociado a un borrador firmado

documentId

Long

Identificador del documento que se desee verificar

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo

Parámetros de respuesta


NombreTipoDescripción

ResultVerifySignedDocument

Objeto de resultado de la verificación de la firma de un documento asociado a un borrador firmado

certList

Cert[]

Lista de los certificados que han firmado el documento

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
		ParamVerifySignedDocument paramVerifySignedDocument = new ParamVerifySignedDocument();
		
		paramVerifySignedDocument.setDocumentId("CSV");
		paramVerifySignedDocument.setInvokingId("00000000T");
		 
		//Se consume el servicio
		try {
			ResultVerifySignedDocument resultVerifySignedDocument = communicationNTDraftClient.verifySignedDocument(paramVerifySignedDocument);
			if(resultVerifySignedDocument!=null&& resultVerifySignedDocument.getCertList()!=null){
				System.out.println("Se han encontrado: " +resultVerifySignedDocument.getCertList().length);
			}else{
				System.out.println("No se han encontrado");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}
		 

Método 'sendRegisterCommunicationNTDraft'


Emite una solicitud de comunicación, pasando esta a ser una notificación propiamente dicha.
Con la invocación de este servicio se genera un recibo de emisión que se asocia a la nueva comunicación y se genera y consume un evento de tipo emisión. Por defecto, este evento envía un correo electrónico al receptor y a la lista de comunicación que tenga el borrador. Además, se genera y guarda y sello de tiempo con la fecha de emisión. Internamente se conecta con el sistema de registro telemático para generar el asiento registral salida de la notificación a emitir.

 Más detalles

Signatura

ResultSendRegisterCommunicationNTDraft sendRegisterCommunicationNTDraft(String applicationId, ParamSendRegisterCommunicationNTDraft paramSendRegisterCommunicationNTDraft) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamSendRegisterCommunicationNTDraftObjeto para emitir la comunicación

communicationNTDraftId

Long

Identificador de la solicitud de comunicación creada anteriormente

organismRegister

String

Código de organismo en cuyo libro registral de salida se realizará el asiento de la notificación a emitir

issuerId

String

Identificador (NIF) del empleado público que realiza la emisión de la notificación y que será el representante del organismo emisor en el asiento registral correspondiente

invokingId

String

No

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo

Parámetros de respuesta


NombreTipoDescripción

ResultSendRegisterCommunicationNTDraft

Objeto de resultado de la emisión de la comunicación

communicationNTId

Long

Identificador de la notificación

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
		ParamSendRegisterCommunicationNTDraft paramSendRegisterCommunicationNTDraft = new ParamSendRegisterCommunicationNTDraft();
		
		// Se indica el Id de la solicitud a actualizar
		paramSendRegisterCommunicationNTDraft.setCommunicationNTDraftId(new Long(5000)); // ID del borrador de la comunicacion
		paramSendRegisterCommunicationNTDraft.setOrganismRegister("ORG14668"); // Organismo de registro de la comunicacion
		paramSendRegisterCommunicationNTDraft.setIssuerId("00000000T"); // NIF del emisor de la notificación
		paramSendRegisterCommunicationNTDraft.setInvokingId("00000000T"); // NIF de la persona que invoca
		 
		// Se hace la invocación
		try {
			ResultSendRegisterCommunicationNTDraft resultSendRegisterCommunicationNTDraft = communicationNTDraftClient.sendRegisterCommunicationNTDraft(paramSendRegisterCommunicationNTDraft);
			if(resultSendRegisterCommunicationNTDraft!=null && resultSendRegisterCommunicationNTDraft.getCommunicationNTId()!=null){
				System.out.println("Se ha emitido correctamente la comunicacion con ID: " + resultSendRegisterCommunicationNTDraft.getCommunicationNTId());
			} else {
				System.out.println("No se ha emitido la comunicación");
			}
		} catch (SNTException e) {
			System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
		}

Servicios CommunicationNTService

Servicios de gestión de comunicaciones enviadas.

Método 'getCommunicationNT@deprecated


Obtiene los metadatos de una comunicación dada de alta en el sistema.

En la comunicación obtenida no se obtiene la lista de organismos de visibilidad

Método deprecado, es recomendable usar el servicio → 4.- Servicios de SNT#getCommunicationNTWithOrganism() para obtener la visibilidad de las comunicaciones.


 Más detalles

Signatura

ResultGetCommunicationNT getCommunicationNT(String applicationId, ParamGetCommunicationNT paramGetCommunicationNT) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetCommunicationNTObjeto para obtener la comunicación

notificationId

Long

Identificador de la notificación

Parámetros de respuesta


NombreTipoDescripción

ResultGetCommunicationNT

Objeto de resultado 

communicationNT

CommunicationNT

Objeto comunicación

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objectos del servicio
ParamGetCommunicationNT paramGetCommunicationNT = new ParamGetCommunicationNT();

// Se añade el id de la notificación
paramGetCommunicationNT.setCommunicationNTId(new Long(5000)); // ID de la comunicacion

// Se hace la invocación
try {
	ResultGetCommunicationNT resultGetCommunicationNT = communicationNTClient.getCommunicationNT(paramGetCommunicationNT);
	if(resultGetCommunicationNT!=null && resultGetCommunicationNT.getCommunicationNT()!=null){
		System.out.println("Se ha encontrado la comunicacion");
	} else{
		System.out.println("No se ha encontrado la comunicacion");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}

Método 'getCommunicationNTWithOrganism'


Obtiene los metadatos de una comunicación dada de alta en el sistema.

En la comunicación obtenida se obtiene una lista de organismos de visibilidad con el organismo productor y los organismos gestores (en caso de que sea de visibilidad compartida ya que en las de visibilidad limitada solamente se obtiene el organismo productor)


 Más detalles

Signatura

ResultGetCommunicationNTWithOrganism getCommunicationNT(String applicationId, ParamGetCommunicationNT paramGetCommunicationNT) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetCommunicationNTObjeto para obtener la comunicación

notificationId

Long

Identificador de la notificación

Parámetros de respuesta


NombreTipoDescripción

ResultGetCommunicationNTWithOrganism

Objeto de resultado 

communicationNTWithOrganism

CommunicationNTWithOrganism

Objeto comunicación

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objectos del servicio
ParamGetCommunicationNT paramGetCommunicationNT = new ParamGetCommunicationNT();

// Se añade el id de la notificación
paramGetCommunicationNT.setCommunicationNTId(new Long(5000)); // Id del borrador de la comunicacion

// Se hace la invocación
try {
	ResultGetCommunicationNTWithOrganism resultGetCommunicationNT = communicationNTClient.getCommunicationNTWithOrganism(paramGetCommunicationNT);
	if(resultGetCommunicationNT!=null && resultGetCommunicationNT.getCommunicationNT()!=null){
		System.out.println("Se ha encontrado la comunicacion");
	} else{
		System.out.println("No se ha encontrado la comunicacion");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}

Método 'getCommunicationNTList@deprecated


Obtiene una lista de comunicaciones dadas de alta en el sistema según unos criterios de búsqueda.

En las comunicaciones obtenidas se obtiene una lista de organismos de visibilidad con el organismo productor y los organismos gestores (en caso de que sean de visibilidad compartida ya que las de visibilidad limitada solamente tienen organismo productor)

Método deprecado, es recomendable usar el servicio → getCommunicationNTWithOrganismList() para obtener la visibilidad de las comunicaciones.


 Más detalles

Signatura

ResultGetCommunicationNTList getCommunicationNTList(String applicationId, ParamGetCommunicationNTList paramGetCommunicationList) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetCommunicationListObjeto para obtener la comunicación

communicationNTSearch

CommunicationNTSearch

Objeto relativo a la búsqueda de una comunicación

Parámetros de respuesta


NombreTipoDescripción

ResultGetCommunicationNTList

Objeto de resultado 

communicationNTList

CommunicationNT[]

Lista de comunicaciones

sizeIntegerNúmero de elementos concidentes con la búsqueda que se encuentran en la base de datos. Este parámetro se devuelve ya que con los parámetros de paginación se pueden solicitar que devuelva un máximo de objetos independientemente de cuántos haya en la base de datos.

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
CommunicationNTSearch communicationNTSearchBean = new CommunicationNTSearch();
	
String[] listOrgGestor = new String[1];
listOrgGestor[0] = "ORG14668"; // Organismo gestor a consultar
communicationNTSearchBean.setOrgListVisibility(listOrgGestor);

ParamGetCommunicationNTList paramGetCommunicationNTList = new 	ParamGetCommunicationNTList(communicationNTSearchBean);

ResultGetCommunicationNTList resultGetCommunicationNTList;
try {
	resultGetCommunicationNTList = communicationNTClient.getCommunicationNTList(paramGetCommunicationNTList);
	if(resultGetCommunicationNTList!=null && resultGetCommunicationNTList.getSize()>0){
		for(int k=0;k<resultGetCommunicationNTList.getCommunicationNTList().length;k++){
			if(resultGetCommunicationNTList .getCommunicationNTList(k)!=null){
				System.out.println("Comunicación con ID: " + resultGetCommunicationNTList .getCommunicationNTList(k));
			}
		}
	}else{
		System.out.println("No se han encontrado resultados");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}

Método 'getCommunicationNTWithOrganismList'


Obtiene una lista de comunicaciones dadas de alta en el sistema según unos criterios de búsqueda.

En las comunicaciones obtenidas se obtiene una lista de organismos de visibilidad con el organismo productor y los organismos gestores (en caso de que sean de visibilidad compartida ya que las de visibilidad limitada solamente tienen organismo productor)


 Más detalles

Signatura

ResultGetCommunicationNTWithOrganismList getCommunicationNTList(String applicationId, ParamGetCommunicationNTList paramGetCommunicationList) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetCommunicationListObjeto para obtener la comunicación

communicationNTSearch

CommunicationNTSearch

Objeto relativo a la búsqueda de una comunicación

Parámetros de respuesta


NombreTipoDescripción

ResultGetCommunicationNTWithOrganismList

Objeto de resultado 

communicationNTWithOrganismList

CommunicationNTWithOrgansim[]

Lista de comunicaciones

sizeIntegerNúmero de elementos coincidentes con la búsqueda que se encuentran en la base de datos. Este parámetro se devuelve ya que con los parámetros de paginación se pueden solicitar que devuelva un máximo de objetos independientemente de cuántos haya en la base de datos.

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
CommunicationNTSearch  communicationNTSearchBean = new CommunicationNTSearch();

String[] listOrgGestor = new String[1];
listOrgGestor[0] = "ORG14668"; // Organismo gestor a consultar
communicationNTSearchBean.setOrgListVisibility(listOrgGestor);

ParamGetCommunicationNTList paramGetCommunicationNTList = new ParamGetCommunicationNTList(communicationNTSearchBean);

try {
	ResultGetCommunicationNTWithOrganismList resultGetCommunicationNTList = communicationNTClient.getCommunicationNTWithOrganismList(paramGetCommunicationNTList);
	if(resultGetCommunicationNTList!=null && resultGetCommunicationNTList.getSize()>0){
		for(int k=0;k<resultGetCommunicationNTList.getCommunicationNTList().length;k++){
			if(resultGetCommunicationNTList .getCommunicationNTList(k)!=null){
				System.out.println("Comunicación con ID: " + resultGetCommunicationNTList .getCommunicationNTList(k));
			}
		}
	}else{
		System.out.println("No se han encontrado resultados");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}


Método 'getAttachment'


Obtiene los metadatos de un documento adjunto relacionado con una notificación dada de alta en el sistema.

 Más detalles

Signatura

ResultGetAttachment getAttachment(String applicationId, ParamGetAttachment paramGetAttachment) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetAttachment Objeto para obtener el adjunto

documentId

Long

No

Identificador del documento adjunto a la solicitud

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultGetAttachment

Objeto de resultado 
documentAttachment

DocumentAttachment

Documento adjunto 

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
ParamGetAttachment paramGetAttachment = new ParamGetAttachment();

paramGetAttachment.setDocumentId("CSV"); // Se indica el CSV del adjunto a recuperar
paramGetAttachment.setInvokingId("00000000T");

// Se hace la invocación
try {
	ResultGetAttachment resultGetAttachment = communicationNTClient.getAttachment(paramGetAttachment);
	if(resultGetAttachment!=null && resultGetAttachment.getDocumentAttachment()!=null){
		System.out.println("Se ha encontrado el documento");
	} else {
		System.out.println("No se han encontrado el documento");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}


Método 'getAttachmentDocument'


Obtiene los datos físicos de un documento adjunto relacionado con una notificación dada de alta en el sistema.

 Más detalles

Signatura

ResultGetAttachmentDocument getAttachmentDocument(String applicationId, ParamGetAttachmentDocument paramGetAttachmentDocument) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetAttachmentDocument Objeto para obtener el documento

documentId

Long

No

Identificador del documento adjunto a la solicitud

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultGetAttachmentDocument

Objeto de resultado 

document

DataHandler

Documento adjunto 

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objectos del servicio
ParamGetAttachmentDocument paramGetAttachmentDocument = new ParamGetAttachmentDocument();
 
// Se incluye el documento a obtener
paramGetAttachmentDocument.setDocumentId("CSV"); // Se indica el CSV del adjunto a recuperar
paramGetAttachmentDocument.setInvokingId("00000000T");
// Se hace la invocación
try {
	ResultGetAttachmentDocument resultGetAttachmentDocument = communicationNTClient.getAttachmentDocument(paramGetAttachmentDocument);
	if(resultGetAttachmentDocument!=null && resultGetAttachmentDocument.getDocument()!=null){
		System.out.println("Se ha encontrado el documento asociado a la comunicación");
	}else{
		System.out.println("No se han encontrado documentos asociados a la comunicación");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}


Método 'getAttachmentList'


Obtiene una lista de documentos adjuntos según unos criterios de búsqueda.

 Más detalles

Signatura

ResultGetAttachmentList getAttachmentList(String applicationId, ParamGetAttachmentList paramGetAttachmentList) throws RemoteException, InternalCoreException;

Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetAttachmentList Objeto para obtener la lista de documentos

documentAttachmentsearch

DocumentAttachmentsearch

Parámetros de búsqueda relativos al documento adjunto a la notificación

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultGetAttachmentList

Objeto de resultado 

documentAttachmentList

DocumentAttachmentList[]

Lista de documentos adjuntos

size

Integer

Número de elementos concidentes con la búsqueda que se encuentran en la base de datos. Este parámetro se devuelve ya que con los parámetros de paginación se pueden solicitar que devuelva un máximo de objetos independientemente de cuántos haya en la base de datos

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del Agente de Acceso
ParamGetAttachmentList paramGetAttachmentList = new ParamGetAttachmentList();
DocumentAttachmentSearch documentAttachmentSearch = new DocumentAttachmentSearch();
documentAttachmentSearch.setParentId(new Long(5000)); // ID de la comunicación
paramGetAttachmentList.setDocumentAttachmentSearch(documentAttachmentSearch);

paramGetAttachmentList.setInvokingId("00000000T");


// Obtenemos la lista de documentos adjuntos
ResultGetAttachmentList resultGetAttachmentList;
try {
	resultGetAttachmentList = notificationClient.getAttachmentList(paramGetAttachmentList);
	if(resultGetAttachmentList!=null && resultGetAttachmentList.getDocumentAttachmentList()!=null && resultGetAttachmentList.getDocumentAttachmentList().length>0){
		// setSize((Integer) resultGetAttachmentList.getSize());
		for(int k=0;k<resultGetAttachmentList.getDocumentAttachmentList().length;k++){
			if(resultGetAttachmentList.getDocumentAttachmentList(k)!=null){
				System.out.println("Se ha encontrado el adjunto: "+resultGetAttachmentList.getDocumentAttachmentList(k));
			} 
		}
	}else{
		System.out.println("No se han encontrado adjuntos");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}


Método 'verifySignedCommunicationNT'


Verifica la firma de un documento de comunicación dado de alta en el sistema.

 Más detalles

Signatura

ResultVerifySignedCommunicationNT verifySignedCommunicationNT( String applicationId, ParamVerifySignedCommunicationNT paramVerifySignedCommunicationNT) throws RemoteException, InternalCoreException;

Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamVerifySignedCommunicationNT Objeto para verificar la firma

notificationId

Long

Identificador de la comunicación

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultVerifySignedCommunicationNT

Objeto de resultado 

certList

Cert[]

Lista de los certificados con los que se firmó el documento.

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del agente de acceso
ParamVerifySignedCommunicationNT paramVerifySignedCommunicationNT = new ParamVerifySignedCommunicationNT();

// identificador de la notificación
paramVerifySignedCommunicationNT.setCommunicationId(new Long(5000));
paramVerifySignedCommunicationNT.setInvokingId("00000000T");

// Se hace la invocación
try {
	ResultVerifySignedCommunicationNT resultVerifySignedCommunicationNT = communicationNTClient.verifySignedCommunicationNT(paramVerifySignedCommunicationNT);
	if(resultVerifySignedCommunicationNT!=null && resultVerifySignedCommunicationNT.getCertList()!=null){
		System.out.println("Se han encontrado cert asociadas a la firma: " + resultVerifySignedCommunicationNT.getCertList().length);
	}else{
		System.out.println("No se han encontrado cert asociadas a la firma");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}


Método 'verifySignedDocument'


Verifica la firma de un documento adjunto asociado a una comunicación dada de alta en el sistema.

 Más detalles

Signatura

ResultVerifySignedDocument verifySignedDocument(String applicationId, ParamVerifySignedDocument paramVerifySignedDocument) throws RemoteException, InternalCoreException;

Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamVerifySignedDocument Objeto para verificar la firma

documentId

Long

Identificador del documento adjunto

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultVerifySignedDocument

Objeto de resultado 

certList

Cert[]

Lista de los certificados con los que se firmó el documento.

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
ParamVerifySignedDocument paramVerifySignedDocument = new ParamVerifySignedDocument ();

paramVerifySignedDocument.setDocumentId("CSV");
paramVerifySignedDocument.setInvokingId("00000000T");

// Se hace la invocación
try {
	ResultVerifySignedDocument resultVerifySignedDocument = communicationNTClient.verifySignedDocument(paramVerifySignedDocument);
	if(resultVerifySignedDocument!=null && resultVerifySignedDocument.getCertList()!=null){
		System.out.println("Se han encontrado cert asociadas a la firma: " + resultVerifySignedDocument.getCertList().length);
	}else{
		System.out.println("No se han encontrado cert asociadas a la firma");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}


Método 'getCommunicationNTDocument'


Obtiene los datos físicos del documento de comunicación.

 Más detalles

Signatura

ResultGetCommunicationNTDocument getCommunicationNTDocument(String applicationId, ParamGetCommunicationNTDocument paramGetCommunicationNTDocument) throws RemoteException, InternalCoreException;

Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetCommunicationNTDocument Objeto para obtener el documento de la comunicación

communicationNTId

Long

Identificador de la comunicación

invokingId

StringNo

Identificador (NIF) de la persona que origina la petición desde la aplicación invocante. Si se trata de una aplicación web será la persona autenticada en el mismo.

Parámetros de respuesta


NombreTipoDescripción

ResultGetCommunicationNTDocument

Objeto de resultado 

CommunicationNTDocument

DataHandler

Fichero documento de la comunicación

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
ParamGetCommunicationNTDocument paramGetCommunicationNTDocument = new ParamGetCommunicationNTDocument();
 
// Se indica el id de la notificación del documento 
paramGetCommunicationNTDocument.setCommunicationNTId(new Long(5000));
paramGetCommunicationNTDocument.setInvokingId("00000000T");

// Se hace la invocación
try {
	ResultGetCommunicationNTDocument resultGetCommunicationNTDocument = communicationNTClient.getCommunicationNTDocument(paramGetCommunicationNTDocument);
	if(resultGetCommunicationNTDocument!=null && resultGetCommunicationNTDocument.getCommunicationNTDocument()!=null){
		System.out.println("Se ha encontrado el documento");
	}else{
		System.out.println("No se ha encontrado el documento");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}


Método 'readCommunicationNT'


Actualiza el estado de una comunicación a “Leída”

 Más detalles

Signatura

Result readCommunicationNT(String applicationId, ParamReadCommunicationNT paramReadCommunicationNT) throws RemoteException, InternalCoreException;

Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamReadCommunicationNT Objeto para obtener el documento de la comunicación

communicationNTId

Long

Identificador del documento adjunto a la solicitud

Parámetros de respuesta


NombreTipoDescripción

Result

Objeto devuelto sin ningún parámetro

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del agente de acceso
ParamReadCommunicationNT paramReadCommunicationNT = new ParamReadCommunicationNT();

//Se rellena el objeto
paramReadCommunicationNT.setCommunicationId(new Long(5000));

// Se hace la invocación
try {
	communicationNTClient.readCommunicationNT(paramReadCommunicationNT);
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
} 




Servicios MailBoxService

Servicios de manejo de datos del buzón de notificaciones del ciudadano e identificador del ciudadano que los relaciona.

Método 'getMailBoxList'


Obtiene una lista de buzones de notificaciones dados de alta en el sistema según unos criterios de búsqueda.

 Más detalles

Signatura

ResultGetMailBoxList getMailBoxList(String applicationId, ParamGetMailBoxList paramGetMailBoxList) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetMailBoxListObjeto para obtener la lista de buzones de notificaciones

mailBox

MailBox

Filtros de búsqueda

Parámetros de respuesta


NombreTipoDescripción

ResultGetMailBoxList

Objeto de resultado 

mailBoxList

MailBox[]

Lista de objetos buzón

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
ParamGetMailBoxList paramGetMailBoxList = new ParamGetMailBoxList();

// Se rellena el objeto a buscar
MailBox objMailBox = new MailBox();
objMailBox.setReceiverId("00000000T");
paramGetMailBoxList.setMailBox(objMailBox);

// Se hace la invocación
try {
	ResultGetMailBoxList resultGetMailBoxList = mailBoxClient.getMailBoxList((paramGetMailBoxList));
	if(resultGetMailBoxList!=null && resultGetMailBoxList.getMailBoxList()!=null){
		System.out.println("Se han obtenido : "+resultGetMailBoxList.getMailBoxList()[0].getDestination());
	} else{
		System.out.println("No se han obtenido resultados");
	}
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}

Método 'updateMailBoxList'


Actualiza la información de un buzón asociado a un ciudadano. El comportamiento de este método es el
siguiente:

  • Si el buzón es nuevo (no se envía identificador) se inserta.
  • En caso de que el buzón exista (se envía su identificador) puede tener dos comportamientos:
    • Si se envía un destino para la comunicación (correo electrónico, teléfono…) en el parámetro
      “destination” el buzón se actualizara.
    • Si no se envía nada en el parámetro “destination” el buzón se eliminará.
 Más detalles

Signatura

Result updateMailBoxList(String applicationId, ParamUpdateMailBoxList paramUpdateMailBoxList) throws RemoteException, InternalCoreException;


Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamUpdateMailBoxListObjeto para actualizar la lista de buzones de notificaciones

mailBoxList

MailBox[]

Lista de objetos buzón

Parámetros de respuesta


NombreTipoDescripción

Result

Objeto de resultado sin parámetros

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
ParamUpdateMailBoxList paramUpdateMailBoxList = new ParamUpdateMailBoxList();

// Buzón a insertar
MailBox mailBox = new MailBox();
mailBox.setMethod(new Long(SNTClientConstants.METHOD_MAIL));
mailBox.setDestination("correo@mail.com");
mailBox.setReceiverId("00000000T");

// Se añade el buzón a la lista
MailBox[] mailBoxList = new MailBox[1];
mailBoxList[0] = mailBox;
paramUpdateMailBoxList.setMailBoxList(mailBoxList);

// Se hace la invocación
try {
	mailBoxClient.updateMailBoxList(paramUpdateMailBoxList);
} catch (SNTException e) {
	System.out.println("Error:"+e.getCode()+" Mensaje:"+e.getExtraInfo());
}


Servicios SignatureService

Servicios de validación de la operación de firma y obtención de CA's


Método 'validateSignature'


Servicio que valida un documento firmado.

 Más detalles

Signatura

ResultValidateSignature validateSignature(String applicationId, ParamValidateSignature paramValidateSignature) throws RemoteException, InternalCoreException;

Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamValidateSignatureObjeto para validar la firma

signedData

String

Datos firmados. Documento firmado.

formatSignatureLongFormato de la firma

Parámetros de respuesta


NombreTipoDescripción

ResultValidateSignature

Objeto de resultado sin parámetros
CertcertObjeto certificado con los datos del firmante.

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del servicio
ParamValidateSignature paramValidateSignature = new ParamValidateSignature();
ResultValidateSignature resultValidateSignature ;

// Se rellenan los parámetros
paramValidateSignature.setSignedData(signedData);
Long signatureType = new Long(SNTClientConstants.SIGN_TYPE_PKCS7);
paramValidateSignature.setFormatSignature(signatureType);

// Se hace la invocación
resultValidateSignature = signatureClient.validateSignature(paramValidateSignature);


Método 'getCAs'


Obtiene las entidades de confiaza dadas de alta en el sistema mediante la plataforma de firma.

 Más detalles

Signatura

ResultGetCAs getCAs(String applicationId, ParamGetCAs paramGetCAs) throws RemoteException, InternalCoreException;

Parámetros de invocación


NombreTipoObligatorioDescripción
applicationIdStringAplicación que ejecuta el método
ParamGetCAsObjeto para obtener las entidades de confianza

operationType

Integer

Tipo de CA’s que desea recuperar según operación.

Parámetros de respuesta


NombreTipoDescripción

ResultGetCAs

Objeto de resultado
arrayCAsCA[]Vector de los CA’s obtenidos

Excepciones


TipoDescripción

InternalCoreException

Error en una operación del núcleo

RemoteException

Error remoto

Ejemplo de invocación


Ejemplo de invocación
// Objetos del agente de acceso
ParamGetCAs paramGetCAs = new ParamGetCAs ();
ResultGetCAs resultGetCAs = new ResultGetCAs ();
Integer operationType = new Integer(SNTClientConstants.VERIFY_CAS);
paramGetCAs.setOperationType(operationType);

// Se hace la invocación
resultGetCAs = signatureClient.getCAs(paramGetCAs);


Anexos


Códigos error

Genéricos


CódigoDescripción
0

Error en el tipo de entrada de la petición

1

Error en el tipo de salida de la petición

-1

Error desconocido

-2

Error genérico de los servicios

Errores en base de datos


CódigoDescripción
-10

Error genérico de la base de datos

-11

Error de inconsistencia de la base de datos

-12

Error de autorización de acceso a la base de datos

Errores en document manager


CódigoDescripción
-20

Error cargando el fichero

-21

Error de fichero no encontrado

-22

Error al insertar el fichero

Errores en la validación de datos genéricos


CódigoDescripción
10

Error de validación de los datos requerida

11

Error de valor no válido

12

Error de fecha no válida

13

Error de parámetro nulo

14

Error de Datahandler nulo


Errores sobre la notificación


CódigoDescripción
100

Error de notificación nula

101

Error de identificador de la notificación nulo

102

Error de identificador del usuario nulo

103

Error de identificador del responsable de la notificación nulo

104

Error de NIF nulo

105

Error de código de organismo nulo

106

Error de expediente nulo

107

Error de estado nulo

108

Error de descripción nula

109

Error de contenido nulo

110

Error de firma detached nula

111

Error de formato de la firma nulo

112

Error de mimetype nulo

113

Error de nombre del fichero nulo

114

Error de fecha de creación nula

115

Error de fecha de notificación nula

116

Error de fecha de firma nula

117

Error de fecha de expiración nula

118

Error en el nombre del fichero

120

Error de I/O de la notificación

121

Error en el parámetro número CSV del documento de aceptación/rechazo

130

Error de estado de la notificación no válido

140

Notificación no encontrada en la base de datos

141

Error en el parámetro description de la aceptación/rechazo


Errores sobre el documento adjunto de notificaciones


CódigoDescripción
200

Error de adjunto de la notificación nulo

201

Error de identificador del adjunto de la notificación nulo

202

Error de identificador padre del adjunto de la notificación nulo

203

Error de fecha de creación del adjunto de la notificación nula

204

Error de título del adjunto de la notificación nulo

205

Error de descripción del adjunto de la notificación nula

206

Error de autor del adjunto de la notificación nulo

207

Error de tipo de adjunto de la notificación nulo

208

Error de estado del adjunto de la notificación nulo

209

Error de identificador del documento del adjunto de la notificación nulo

210

Error de identificador de no repudio del adjunto de la notificación nulo

211

Error de tamaño del fichero adjunto de la notificación nulo

212

Error de nombre del fichero adjunto de la notificación nulo

213

Error de la firma detached del adjunto de la notificación nula

214

Error de formato de la firma del adjunto de la notificación nulo

215

Error de mimetype del adjunto de la notificación nulo

220

Error de I/O del adjunto de la notificación


Errores sobre la solicitud


CódigoDescripción
300

Error de solicitud nula

301

Error de identificador de la solicitud nulo

302

Error de identificador del usuario nulo

303

Error de responsable de la solicitud nulo

304

Error de NIF nulo

305

Error de código de organismo nulo

306

Error de expediente nulo

307

Error de estado nulo

308

Error de descripción nula

309

Error de contenido nulo

310

Error de firma detached nula

311

Error de formato de la firma nulo

312

Error de mimetype nulo

313

Error de nombre de fichero nulo

314

Error de fecha de creación nula

315

Error de fecha de notificación nula

316

Error de fecha de firma nula

317

Error de fecha de expiración nula

318

Error de nombre del fichero adjunto

319

Error de nombre del fichero solicitud

321

Error de lista de datos específicos nula

322

Error de validación en los datos del documento Excel

323

Error de CSV no válido

324

Error causado porque el firmante no coincide con el firmante propuesto en el borrador

320

Error de I/O de la solicitud

360Error en formato del email


Errores sobre el documento adjunto de solicitudes


CódigoDescripción
400

Error de adjunto de la solicitud nulo

401

Error de identificador del adjunto de la solicitud nulo

402

Error de identificador padre del adjunto de la solicitud nulo

403

Error de fecha de creación del adjunto de la solicitud nula

404

Error de título del adjunto de la solicitud nulo

405

Error de descripción del adjunto de la solicitud nula

406

Error de autor del adjunto de la n solicitud nulo

407

Error de tipo de adjunto de la solicitud nulo

408

Error de estado del adjunto de la solicitud nulo

409

Error de identificador del documento del adjunto de la solicitud nulo

410

Error de identificador de no repudio del adjunto de la solicitud nulo

411

Error de tamaño del fichero adjunto de la solicitud nulo

412

Error de nombre del fichero adjunto de la solicitud nulo

413

Error de la firma detached del adjunto de la solicitud nula

414

Error de formato de la firma del adjunto de la solicitud nulo

415

Error de mimetype del adjunto de la solicitud nulo

420

Error de I/O del adjunto de la solicitud

430

Error de lectura del stream

431

DIME del adjunto no encontrado

432

Error de lectura del fichero

460Error en el formato del email


Errores en la gestión de mailbox


CódigoDescripción
500

Error de buzón nulo

501

Error de identificador de buzón nulo

502

Error de NIF nulo

503

Error de método nulo

504

Error de destino nulo


Errores en la gestión de usuarios


CódigoDescripción
600

Error de usuario nulo

601

Error de identificador de usuario nulo

602

Error de NIF de usuario nulo

603

Error de rol de usuario nulo

604

Error de código de organismo de usuario nulo

605

Error de nombre de usuario nulo

606

Error de apellido1 de usuario nulo

607

Error de apellido2 de usuario nulo

608

Error de identificador de entrada de usuario no válido

Errores en la gestión de comunicaciones


CódigoDescripción
700

Error de comunicación nula

701

Error de identificador de la comunicación nulo

702

Error de identificador de la solicitud nulo

703

Error de método nulo

704

Error de destino nulo

Errores en la gestión de aplicaciones


CódigoDescripción
800

Error de aplicación nula

801

Error de identificador de la aplicación nulo

802

Error de identificador de la aplicación de la aplicación nulo

803

Error de descripción nula

804

Error de estado nulo

805

Error de firmante nulo

806

Error de número de serie nulo

807

Error de identificador de entrada de la aplicación no válido

Errores en la gestión de organismos


CódigoDescripción
900

Error de aplicación nula

901

Error de identificador de organismo nulo

902

Error de identificador del organismo padre nulo

903

Error de nombre de organismo nulo

904

Error de código de organismo nulo

910

Error de histórico de organismo nulo

911

Error de identificador de histórico nulo

912

Error de fecha de comienzo de histórico de organismo nula

913

Error de fecha final de histórico de organismo nula

914

Error de identificador de organismo de histórico nulo

920

Error de tipo de procedimiento nulo

921

Error de identificador de tipo de procedimiento nulo

922

Error de nombre de tipo de procedimiento nulo

923

Error de identificador de organismo de tipo de procedimiento nulo

930

Error de formato de código de organismo

931

Error de organismo de entrada no válido

932

Error de organismo de salida no válido

933

Error de organismo gestor no perteneciente al procedimiento

934

Error de organismo productor no encontrado


Errores en los parámetros de búsqueda


CódigoDescripción
950

Error de aplicación nula

951

Error de índice de búsqueda “hasta”

952

Error de parámetro de ordenación por columna

953

Error de parámetro de ordenación ascendente

954

Error de parámetro de paginado demasiado largo

960

Error de formato de la fecha de creación mínima

961

Error de formato de la fecha de creación máxima

962

Error de fecha de creación mínima nula

963

Error de fecha de creación máxima nula

970

Error de formato de la fecha de notificación mínima

971

Error de formato de la fecha de notificación máxima

972

Error de fecha de notificación mínima nula

973

Error de fecha de notificación máxima nula

980

Error de formato de la fecha de firma mínima

981

Error de formato de la fecha de firma máxima

982

Error de fecha de firma mínima nula

983

Error de fecha de firma máxima nula

990

Error de formato de la fecha de expiración mínima

991

Error de formato de la fecha de expiración máxima

992

Error de fecha de expiración mínima nula

993

Error de fecha de expiración máxima nula

994

Error de formato del documento no válido


Errores producidos en otros componentes


CódigoDescripción

10000 + Cod. de error org

Offset de error del Organism Manager

20000 + Cod. de error user

Objeto de error del User Manager

30000 + Cod. de error ASF

Objeto Info con valor nulo


Errores producidos en las transacciones


CódigoDescripción

1000

Error genérico en la transacción

1001

Error al crear borrador

1002

Error al modificar borrador

1003

Error al borrar borrador

1004

Error al añadir adjunto al borrador

1005

Error al modificar adjunto del borrador

1006

Error al borrar adjunto del borrador

1007

Error al añadir metadatos al borrador

1008

Error al modificar metadatos del borrador

1009

Error al eliminar metadatos del borrador

1010

Error el emitir la notificación

1011

Error al añadir adjunto a la notificación

1012

Error al modificar adjunto de la notificación

1013

Error al añadir metadatos de la notificación

1014

Error al modificar metadatos de la notificación

1015

Error al eliminar metadatos de la notificación

1016

Error al aceptar la notificación

1017

Error al rechazar la notificación

1018

Error al insertar el email

1019

Error al modificar el email

1020

Error al eliminar el email

1021

Error al añadir una aplicación

1022

Error al modificar una aplicación

1023

Error al eliminar una aplicación

1024

Error al añadir borrador al destinatario


Errores producidos en SIU y PAU


CódigoDescripción

1100

Error de conexión de SIU

1101

Url errónea de SIU

1102

Error remoto en SIU

1103

Error de conexión de PAU

1104

Url errónea de PAU

1106

Error remoto en PAU

1107

Error de PAU al recuperar lista de procedimientos

1108

Error de PAU al recuperar lista de procedimientos nula o vacía

1109

Error de SIU al recuperar lista de organismos

1110

Error de SIU al recuperar lista de usuarios

1111

Error de autentificación en SIU

1112

Error de PAU al recuperar el xml de un procedimiento

Errores producidos en CCSV


CódigoDescripción

1150

Error en CCSV con las relaciones entre documentos

1151

Error genérico en CCSV

1152

Error al buscar un CSV en CCSV

1153

Extension erronea del archivo a insertar en CSV

Errores en la gestión de las firmas


CódigoDescripción

2000

Solicitud de firma inválida

2001

Firma detached in válida

2002

Firma atached inválida

2003

Identificación de la persona física de la firma inválida

2004

Identificación de la persona jurídica de la firma inválida

2005

Estado de la notificación de la firma inválida

2006

Certificado de logueo inválido

2007

Certificado nulo

2008

Formato del certificado inválido

2009

Formato del certificado modificado inválido

2100

Firma inválida del adjunto

2101

Error firma del adjunto

2102

Error calculando hash del adjunto

2103

Error tiempo de espera sobrepasado

2104

Error en la firma del destinatario

2105

Error en la validación del tipo de firma

2106

Error en la generación del hash

2107

Error en la validación de la fecha de la firma

2200

Error genérico en la lectura del flujo

Errores en el generador de documentos


CódigoDescripción

3000

Error de notificación del documento generador nula

3001

Error en el XML del documento generador

3002

Error de lectura de la plantilla del documento generador

3003

Error de escritura de la plantilla del documento generador

3004

Error de análisis del map del documento generador

Errores en el envío de avisos de notificaciones en papel


CódigoDescripción

150

Error al guardar un aviso en papel en base de datos

151

Error al actualizar un aviso en papel en base de datos

Objetos comunes


Objeto 'draft'


El objetivo de este bean es transportar la información relacionada con los metadatos de una solicitud de notificación. Estos metadatos hacen referencia al Identificador del destinatario, organización que emite la notificación, expediente asociado, etc.

Se utilizará en las peticiones y respuestas que hacen referencia a las solicitudes de notificación (crear, actualizar, listado, detalle).

NombreTipoTamaño máximoObligatorio en creaciónDescripción
idLong--Identificador interno de la solicitud

creatorId

String

(Es CIF/NIF)SI 

Identificador del funcionario creador de la solicitud

issuerId

String

--

Identificador del funcionario creador de la solicitud

dossier

String

250NO

Número de Expediente de la solicitud

state

Long-NO

Estado en el que se encuentra la solicitud

description

String

250SI

Asunto de la solicitud (Tamaño máximo de 250 caracteres)

content

String

4000NO

Resumen en texto del contenido de la solicitud.

detachedSigned

String

--

Firma de la solicitud en caso de que esta sea detached

formatSignature

Long--

Formato de la firma

mimeType

String

--

Formato de los datos del documento de solicitud asociado

fileSize

Long--

Tamaño del documento de solicitud asociado

fileName

String

255NO

Nombre del documento de solicitud asociado

creationDate

Calendar

--

Fecha de creación de la solicitud

notificationDate

Calendar

--

Fecha de notificación de la solicitud

signDate

Calendar

--

Fecha de firma de la solicitud

expireDate

Calendar

--

Fecha de caducidad de la solicitud

expireTime

Integer

-SI

Tiempo que tardará en caducar la solicitud

procedure

String

-SI

Procedimiento por el cual se ha realizado la notificación.

signerId

String

--

NIF del firmante de la notificación

horizontalProcedures

String[]

--

Listado de procedimientos horizontales

nonHorizontalProcedures

String[]

--

Listado de procedimientos no horizontales

orgListVisibility

String[]

--

Listado de organismos los cuáles el usuario tiene roles.

pauRoleString--Rol en PAU del usuario

organism

Organism

-SI

Objeto organismo

communicationList

Communication[]

--

Lista de comunicaciones informando de los destinatarios a los que se informará de los eventos que produzca la aplicación

specificDataList

Data[]

-NO

Lista de datos específicos

draftReceiversList

DraftReceiver[]

-SI

Lista de destinatarios de la solicitud


Objeto 'draftWithOrganism'


El objetivo de este bean es transportar la información relacionada con los metadatos de una solicitud de notificación. Estos metadatos hacen referencia al Identificador del destinatario, organización que emite la notificación, expediente asociado, etc.

Se utilizará en las peticiones y respuestas que hacen referencia a las solicitudes de notificación (crear, actualizar, listado, detalle).

Utilizado en los nuevos servicios que incluyen visibilidad.


NombreTipoTamaño máximoObligatorio en creaciónDescripción
idLong--Identificador interno de la solicitud

creatorId

String

(Es CIF/NIF)SI 

Identificador del funcionario creador de la solicitud

issuerId

String

--

Identificador del funcionario creador de la solicitud

dossier

String

250NO

Número de Expediente de la solicitud

state

Long-NO

Estado en el que se encuentra la solicitud

description

String

250SI

Asunto de la solicitud (Tamaño máximo de 250 caracteres)

content

String

4000NO

Resumen en texto del contenido de la solicitud.

detachedSigned

String

--

Firma de la solicitud en caso de que esta sea detached

formatSignature

Long--

Formato de la firma

mimeType

String

--

Formato de los datos del documento de solicitud asociado

fileSize

Long--

Tamaño del documento de solicitud asociado

fileName

String

255NO

Nombre del documento de solicitud asociado

creationDate

Calendar

--

Fecha de creación de la solicitud

notificationDate

Calendar

--

Fecha de notificación de la solicitud

signDate

Calendar

--

Fecha de firma de la solicitud

expireDate

Calendar

--

Fecha de caducidad de la solicitud

expireTime

Integer

-SI

Tiempo que tardará en caducar la solicitud

procedure

String

-SI

Procedimiento por el cual se ha realizado la notificación.

signerId

String

--

NIF del firmante de la notificación

horizontalProcedures

String[]

--

Listado de procedimientos horizontales

nonHorizontalProcedures

String[]

--

Listado de procedimientos no horizontales

orgListVisibility

String[]

--

Listado de organismos los cuáles el usuario tiene roles.

pauRoleString--Rol en PAU del usuario

organism

Organism

-SI

Objeto organismo

communicationList

Communication[]

--

Lista de comunicaciones informando de los destinatarios a los que se informará de los eventos que produzca la aplicación

specificDataList

Data[]

-NO

Lista de datos específicos

draftReceiversList

DraftReceiver[]

-SI

Lista de destinatarios de la solicitud

organismVisibilityList

OrganismVisibility[]

-NO

Listado de organismos utilizados en la visibilidad compartida/limitada


Objeto 'communicationNTDraft'


El objetivo de este bean es transportar la información relacionada con los metadatos de una solicitud de comunicación. Estos metadatos hacen referencia al Identificador del destinatario, organización que emite la notificación, expediente asociado, etc.

Se utilizará en las peticiones y respuestas que hacen referencia a las solicitudes de comunicación (crear, actualizar, listado, detalle).

NombreTipoTamaño máximoObligatorio en creaciónDescripción
idLong--Identificador interno de la solicitud

creatorId

String

(Es CIF/NIF)SI 

Identificador del funcionario creador de la solicitud

issuerId

String

--

Identificador del funcionario creador de la solicitud

dossier

String

250NO

Número de Expediente de la solicitud

state

Long-NO

Estado en el que se encuentra la solicitud

description

String

250SI

Asunto de la solicitud (tamaño máximo de 250 caracteres)

content

String

4000NO

Resumen en texto del contenido de la solicitud.

formatSignature

Long--

Formato de la firma

mimeType

String

--

Formato de los datos del documento de solicitud asociado

creationDate

Calendar

--

Fecha de creación de la solicitud

notificationDate

Calendar

--

Fecha de notificación de la solicitud

signDate

Calendar

--

Fecha de firma de la solicitud

procedure

String

-SI

Procedimiento por el cual se ha realizado la notificación.

signerId

String

--

NIF del firmante de la notificación

horizontalProcedures

String[]

--

Listado de procedimientos horizontales

nonHorizontalProcedures

String[]

--

Listado de procedimientos no horizontales

orgListVisibility

String[]

--

Listado de organismos los cuáles el usuario tiene roles.

organism

Organism

-SI

Objeto organismo

communicationList

Communication[]

--

Lista de comunicaciones informando de los destinatarios a los que se informará de los eventos que produzca la aplicación

specificDataList

Data[]

-NO

Lista de datos específicos

draftReceiversList

DraftReceiver[]

-SI

Lista de destinatarios de la solicitud


Objeto 'communicationNTDraftWithOrganism'


El objetivo de este bean es transportar la información relacionada con los metadatos de una solicitud de comunicación. Estos metadatos hacen referencia al Identificador del destinatario, organización que emite la notificación, expediente asociado, etc.

Se utilizará en las peticiones y respuestas que hacen referencia a las solicitudes de comunicación (crear, actualizar, listado, detalle).

Utilizado en los nuevos servicios que incluyen visibilidad.


NombreTipoTamaño máximoObligatorio en creaciónDescripción
idLong--Identificador interno de la solicitud

creatorId

String

(Es CIF/NIF)SI 

Identificador del funcionario creador de la solicitud

issuerId

String

--

Identificador del funcionario creador de la solicitud

dossier

String

250NO

Número de Expediente de la solicitud

state

Long-NO

Estado en el que se encuentra la solicitud

description

String

250SI

Asunto de la solicitud (tamaño maximo de 250 caracteres)

content

String

4000NO

Resumen en texto del contenido de la solicitud.

formatSignature

Long--

Formato de la firma

mimeType

String

--

Formato de los datos del documento de solicitud asociado

creationDate

Calendar

--

Fecha de creación de la solicitud

notificationDate

Calendar

--

Fecha de notificación de la solicitud

signDate

Calendar

--

Fecha de firma de la solicitud

procedure

String

-SI

Procedimiento por el cual se ha realizado la notificación.

signerId

String

--

NIF del firmante de la notificación

horizontalProcedures

String[]

--

Listado de procedimientos horizontales

nonHorizontalProcedures

String[]

--

Listado de procedimientos no horizontales

orgListVisibility

String[]

--

Listado de organismos los cuáles el usuario tiene roles.

organism

Organism

-SI

Objeto organismo

communicationListCommunication[]--Lista de comunicaciones informando de los destinatarios a los que se informará de los eventos que produzca la aplicación

specificDataList

Data[]

-NO

Lista de datos específicos

draftReceiversList

DraftReceiver[]

-SI

Lista de destinatarios de la solicitud

organismVisibilityListOrganismVisibility[]-NOListado de organismos utilizados en la visibilidad compartida/limitada


Objeto 'communicationNT'


El objetivo de este bean es transportar la información relacionada con los metadatos de una comunicación. Estos metadatos hacen referencia al Identificador del destinatario, organización que emite la comunicación, expediente asociado, etc.

Se utilizará en las peticiones y respuestas que hacen referencia a la comunicación (actualizar, listado, detalle, aceptar, rechazar).

NombreTipoDescripción
idLongIdentificador interno de la solicitud

creatorId

String

Identificador del funcionario creador de la solicitud

issuerId

String

Identificador del funcionario creador de la solicitud

dossier

String

Número de Expediente de la solicitud

state

Long

Estado en el que se encuentra la solicitud

description

String

Asunto de la solicitud (tamaño máximo de 250 caracteres)

content

String

Resumen en texto del contenido de la solicitud.

formatSignature

Long

Formato de la firma

mimeType

String

Formato de los datos del documento de solicitud asociado

fileName

String

Nombre del documento de solicitud asociado

creationDate

Calendar

Fecha de creación de la solicitud

notificationDate

Calendar

Fecha de notificación de la solicitud

signDate

Calendar

Fecha de firma de la solicitud

procedure

String

Procedimiento por el cual se ha realizado la notificación.

signerId

String

NIF del firmante de la notificación

horizontalProcedures

String[]

Listado de procedimientos horizontales

nonHorizontalProcedures

String[]

Listado de procedimientos no horizontales

orgListVisibility

String[]

Listado de organismos los cuáles el usuario tiene roles.

organism

Organism

Objeto organismo

specificDataList

Data[]

Lista de datos específicos

notificationReceiverList

NotificationReceiver[]

NotificationReceiver Object


Objeto 'communicationNTWithOrganism'


El objetivo de este bean es transportar la información relacionada con los metadatos de una comunicación. Estos metadatos hacen referencia al Identificador del destinatario, organización que emite la comunicación, expediente asociado, etc.

Se utilizará en las peticiones y respuestas que hacen referencia a la comunicación (actualizar, listado, detalle, aceptar, rechazar).

Utilizado en los nuevos servicios que incluyen visibilidad.

NombreTipoDescripción
idLongIdentificador interno de la solicitud

creatorId

String

Identificador del funcionario creador de la solicitud

issuerId

String

Identificador del funcionario creador de la solicitud

dossier

String

Número de Expediente de la solicitud

state

Long

Estado en el que se encuentra la solicitud

description

String

Asunto de la solicitud (tamaño máximo de 250 caracteres)

content

String

Resumen en texto del contenido de la solicitud.

formatSignature

Long

Formato de la firma

mimeType

String

Formato de los datos del documento de solicitud asociado

fileName

String

Nombre del documento de solicitud asociado

creationDate

Calendar

Fecha de creación de la solicitud

notificationDate

Calendar

Fecha de notificación de la solicitud

signDate

Calendar

Fecha de firma de la solicitud

procedure

String

Procedimiento por el cual se ha realizado la notificación.

signerId

String

NIF del firmante de la notificación

horizontalProcedures

String[]

Listado de procedimientos horizontales

nonHorizontalProcedures

String[]

Listado de procedimientos no horizontales

orgListVisibility

String[]

Listado de organismos los cuáles el usuario tiene roles.

organism

Organism

Objeto organismo

specificDataList

Data[]

Lista de datos específicos

notificationReceiverList

NotificationReceiver[]

NotificationReceiver Object

organismVisibilityList

OrganismVisibility[]

Listado de organismos utilizados en la visibilidad compartida/limitada


Objeto 'draftSearch'


El objetivo de este bean es transportar la información relacionada con la búsqueda de solicitudes de notificaciones dadas de alta en el sistema.


NombreTipoDescripción

sortColumn

String

Identificador de la columna a ordenar

ascending

Boolean

Indica si el orden de los elementos es ascendente o descendente

fromIndex

Integer

Índice del primer elemento de paginación

toIndexInteger

Índice del último elemento de paginación

minCreationDate

Calendar

Fecha mínima de creación de la solicitud utilizada para el filtrado

maxCreationDate

Calendar

Fecha máxima de creación de la solicitud utilizada para el filtrado

minNotificacionDate

Calendar

Fecha mínima de notificación de la solicitud utilizada para el filtrado

maxNotificacionDate

Calendar

Fecha máxima de notificación de la solicitud utilizada para el filtrado

minSignDate

Calendar

Fecha mínima de firma de la solicitud utilizada para el filtrado

maxSignDate

Calendar

Fecha máxima de firma de la solicitud utilizada para el filtrado

minExpireDate

Calendar

Fecha mínima de caducidad de la solicitud utilizada para el filtrado

maxExpireDate

Calendar

Fecha máxima de caducidad de la solicitud utilizada para el filtrado

stateList

Long

Lista de estados

organismList

Organism[]

Lista de organismos

receiverIdStringIdentificador del receptor
anotherReceiverIdString[]Identificador de otros receptores
typeReceiverIdString[]

Filtro por persona física,persona jurídica o ambas

typeOrganismVisibilityIdInteger

Filtro por tipo de visibilidad

Extiende de Draft

Objeto 'communicationNTDraftSearch'


El objetivo de este bean es transportar la información relacionada con la búsqueda de solicitudes de comunicaciones dadas de alta en el sistema.


NombreTipoDescripción

sortColumn

String

Identificador de la columna a ordenar

ascending

Boolean

Indica si el orden de los elementos es ascendente o descendente

fromIndex

Integer

Índice del primer elemento de paginación

toIndexInteger

Índice del último elemento de paginación

minCreationDate

Calendar

Fecha mínima de creación de la solicitud utilizada para el filtrado

maxCreationDate

Calendar

Fecha máxima de creación de la solicitud utilizada para el filtrado

minNotificacionDate

Calendar

Fecha mínima de notificación de la solicitud utilizada para el filtrado

maxNotificacionDate

Calendar

Fecha máxima de notificación de la solicitud utilizada para el filtrado

minSignDate

Calendar

Fecha mínima de firma de la solicitud utilizada para el filtrado

maxSignDate

Calendar

Fecha máxima de firma de la solicitud utilizada para el filtrado

stateList

Long

Lista de estados

organismList

Organism[]

Lista de organismos

receiverIdStringIdentificador del receptor
anotherReceiverIdString[]Identificador de otros receptores
typeReceiverIdString[]

Filtro por persona física,persona jurídica o ambas

typeOrganismVisibilityIdInteger

Filtro por tipo de visibilidad

Extiende de CommunicationNTDraft


Objeto 'communicationNTSearch'


El objetivo de este bean es transportar la información relacionada con la búsqueda de comunicaciones.


NombreTipoDescripción

sortColumn

String

Identificador de la columna a ordenar

ascending

Boolean

Indica si el orden de los elementos es ascendente o descendente

fromIndex

Integer

Índice del primer elemento de paginación

toIndexInteger

Índice del último elemento de paginación

minCreationDate

Calendar

Fecha mínima de creación de la solicitud utilizada para el filtrado

maxCreationDate

Calendar

Fecha máxima de creación de la solicitud utilizada para el filtrado

minNotificacionDate

Calendar

Fecha mínima de notificación de la solicitud utilizada para el filtrado

maxNotificacionDate

Calendar

Fecha máxima de notificación de la solicitud utilizada para el filtrado

minSignDate

Calendar

Fecha mínima de firma de la solicitud utilizada para el filtrado

maxSignDate

Calendar

Fecha máxima de firma de la solicitud utilizada para el filtrado

stateList

Long

Lista de estados

organismList

Organism[]

Lista de organismos

receiverIdStringIdentificador del receptor
anotherReceiverIdString[]Identificador de otros receptores
typeReceiverIdString[]

Filtro por persona física,persona jurídica o ambas

typeOrganismVisibilityIdInteger

Filtro por tipo de visibilidad

Extiende de CommunicationNT



Objeto 'documentAttachment'


El objetivo de este bean es transportar la información relacionada a un documento adjunto de solicitud o notificación.


NombreTipoDescripción
idLongIdentificador interno de la solicitud

parentId

Long

Identificador del borrador o solicitud al que pertenece el documento.

creationDate

Calendar

Fecha de creación del documento adjunto

description

String

Descripción del documento adjunto

author

String

Autor del documento adjunto

type

Long

Tipo de documento adjunto

state

Long

Estado del documento adjunto

nonRepudationId

String

Identificador de no repudio

fileSize

Long

Tamaño del documento adjunto

fileName

String

Nombre del documento adjunto

csv

String

CSV del adjunto

attId

String

Identificador del adjunto

detachedSigned

String

Firma del documento adjunto cuando esta sea detached

formatSignature

Long

Formato de firma

mimeType

String

Formato de los datos del documento adjunto


Objeto 'documentAttachmentSearch'


El objetivo de este bean es transportar la información relacionada con la búsqueda de documentos adjuntos asociados a una solicitud o notificación.


NombreTipoDescripción

sortColumn

String

Identificador de la columna a ordenar

ascending

Boolean

Indica si el orden de los elementos es ascendente o descendente

fromIndex

Integer

Índice del primer elemento de paginación

toIndex

Integer

Índice del último elemento de paginación

stateList

Long[]

Lista de los estados de documentos adjuntos

typeList

Long[]

Lista de los tipos de documentos adjuntos

Extiende de DocumentAttachment

Objeto 'cert'


El objetivo de este bean es transportar la información relacionada con los datos recuperados de un certificado al validar una firma.


NombreTipoDescripción

issuer

String

Identificador de la CA del certificado

signerStringFirmante

serialNumber

String

Número de serie del certificado

idNonRepudiation

String

Identificador de no repudio en la validación

elements

Item[]

Lista de elementos que simulan un Map con los elementos que retorna ASF recuperados de un certificado

status

Integer

Estado que indica si el certificado es o no válido

caChain

CA[]

Lista de objetos de tipo CA con las posibles CA’s recuperadas para el certificado

validFrom

Calendar

Válido desde

validTo

Calendar

Válido hasta

signDate

Calendar

Fecha de la firma

Objeto 'mailBox'


El objetivo de este bean es transportar los datos referentes al buzón de notificaciones del ciudadano junto con el identificador del ciudadano que los relaciona.


NombreTipoDescripción

id

Long

Identificador interno de buzón del ciudadano

receiverId

String

Identificador del ciudadano propietario de la información del buzón

method

Long

Método de comunicación al que se hace referencia en el buzón del ciudadano

destination

String

Referencia que se usará para enviar la notificación mediante los eventos de comunicación


Objeto 'notification'


El objetivo de este bean es transportar los datos referentes al buzón de notificaciones del ciudadano junto con el identificador del ciudadano que los relaciona.


NombreTipoDescripción

id

Long

Identificador interno de la notificación

creatorId

String

Identificador del funcionario creador de la notificación

issuerId

String

Identificador del funcionario emisor de la notificación

dossier

String

Número de Expediente de la notificación

state

Long

Estado en el que se encuentra la notificación

description

String

Asunto de la notificación (tamaño máximo de 250 caracteres)

content

String

Resumen en texto del contenido de la notificación.

detachedSigned

String

Firma de la notificación en caso de que esta sea detached

formatSignature

Long

Formato de la firma

mimeType

String

Formato de los datos del documento de notificación asociado

fileSize

Long

Tamaño del documento de notificación asociado

fileName

String

Nombre del documento de notificación asociado

creationDate

Calendar

Fecha de creación de la solicitud

notificationDate

Calendar

Fecha de puesta a disposición de la notificación

signDate

Calendar

Fecha de firma de la notificación en el momento de ser aceptada o rechazada por el ciudadano

expireDate

Calendar

Fecha de caducidad de la notificación

expireTime

Integer

Tiempo que tardará en caducar la solicitud

specificDataList

Data[]

Lista de los datos específicos

procedure

String

Procedimiento por el cual se ha realizado la notificación.

signerId

String

NIF del firmante de la notificación

finalReceiverId

String

NIF del destinatario que acepta o rechaza la notificación.

horizontalProcedures

String[]

Listado de procedimientos horizontales

nonHorizontalProcedures

String[]

Listado de procedimientos no horizontales

orgListVisibility

String[]

Listado de organismos los cuáles el usuario tiene roles.

pauRoleStringRol del usuario
organismOrganismOrganismo aportador de la notificación
specificDataListData[]Datos específicos de la notificación

notificationReceiverList

NotificationReceiver[]

NotificationReceiver Object


Objeto 'notificationWithOrganism'


El objetivo de este bean es transportar los datos referentes al buzón de notificaciones del ciudadano junto con el identificador del ciudadano que los relaciona.


NombreTipoDescripción

id

Long

Identificador interno de la notificación

creatorId

String

Identificador del funcionario creador de la notificación

issuerId

String

Identificador del funcionario emisor de la notificación

dossier

String

Número de Expediente de la notificación

state

Long

Estado en el que se encuentra la notificación

statePaperLongEstado en el que se encuentra la notificación en papel

description

String

Asunto de la notificación

content

String

Resumen en texto del contenido de la notificación.

detachedSigned

String

Firma de la notificación en caso de que esta sea detached

formatSignature

Long

Formato de la firma

mimeType

String

Formato de los datos del documento de notificación asociado

fileSize

Long

Tamaño del documento de notificación asociado

fileName

String

Nombre del documento de notificación asociado

creationDate

Calendar

Fecha de creación de la solicitud

notificationDate

Calendar

Fecha de puesta a disposición de la notificación

signDate

Calendar

Fecha de firma de la notificación en el momento de ser aceptada o rechazada por el ciudadano

expireDate

Calendar

Fecha de caducidad de la notificación

expireTime

Integer

Tiempo que tardará en caducar la solicitud

organism

Organism

Objeto organismo

specificDataList

Data[]

Lista de los datos específicos

procedure

String

Procedimiento por el cual se ha realizado la notificación.

signerId

String

NIF del firmante de la notificación

finalReceiverId

String

NIF del destinatario que acepta o rechaza la notificación.

horizontalProcedures

String[]

Listado de procedimientos horizontales

nonHorizontalProcedures

String[]

Listado de procedimientos no horizontales

orgListVisibility

String[]

Listado de organismos los cuáles el usuario tiene roles.

pauRoleStringRol del usuario
organismOrganismOrganismo aportador de la notificación
specificDataListData[]Datos específicos de la notificación
organismVisibilityListOrganismVisibility[]Lista de organismos gestores de la notificación

notificationReceiverList

NotificationReceiver[]

NotificationReceiver Object



Objeto 'notificationSearch'


El objetivo de este bean es transportar la información relacionada con la búsqueda de notificaciones.


NombreTipoDescripción

sortColumn

String

Identificador de la columna a ordenar

ascending

Boolean

Indica si el orden de los elementos es ascendente o descendente

fromIndex

Integer

Índice del primer elemento de paginación

toIndex

Integer

Índice del último elemento de paginación

minCreationDate

Calendar

Fecha mínima de creación de la solicitud utilizada para el filtrado

maxCreationDate

Calendar

Fecha máxima de creación de la solicitud utilizada para el filtrado

minNotificacionDate

Calendar

Fecha mínima de puesta a disposición de la notificación utilizada para el filtrado

maxNotificacionDate

Calendar

Fecha máxima de puesta a disposición de la notificación utilizada para el filtrado

minSignDate

Calendar

Fecha mínima de firma de la notificación en el momento de ser aceptada o rechazada por el ciudadano utilizada para el filtrado

maxSignDate

Calendar

Fecha máxima de firma de la notificación en el momento de ser aceptada o rechazada por el ciudadano utilizada para el filtrado

minExpireDate

Calendar

Fecha mínima de caducidad de la notificación utilizada para el filtrado

maxExpireDate

Calendar

Fecha máxima de caducidad de la notificación utilizada para el filtrado

stateList

Long[]

Lista de los estados

organismList

Organism[]

Lista de los organismos

receiverIdStringReceptor de la notificación

anotherReceiverId

String[]

Otros receptores de la notificación

typeReceiverId

Integer[]

Tipo de receptor de la notificación

typeOrganismVisibilityId

String

Tipo de visibilidad

notificationType

String[]

Tipo de notificación

notificationReceiversType

String[]

Tipo de receptores de la notificación

Extiende de Notification

Objeto 'organism'


El objetivo de este bean es transportar los datos de un organismo al que esta relacionado un usuario


NombreTipoObligatorio en la creaciónDescripción

code

String

SI

Código administrativo del organismo

name

String

NO

Nombre del organismo

parentCode

String

NO

Código del organismo padre

address

String

NO

Dirección del organismo

place

String

NO

Localización del organismo

provinceStringNOProvincia del organismo

postalCode

Long

NO

Código postal del organismo

city

String

NO

Ciudad del organismo

phone

Long

NO

Ciudad del organismo

fax

Long

NO

Fax del organismo

function

Function

NO

String que define la función del organismo

Objeto 'ca'


El objetivo de este bean es transportar los datos de un organismo al que esta relacionado un usuario


NombreTipoDescripción

caChain

CA[]

Lista de objetos CA implícito en el propio objeto CA

issuer

String

Identificador de la CA del certificado

restrictionsFields

String

Lista de campos que definirán las restricciones utilizado por WebSigner

restrictionsPatterns

String

Lista de campos padre que definirán las restricciones utilizado por WebSigner

Objeto 'fileInfo'


El objetivo de este bean es transportar la información relacionada con las especificaciones de los ficheros adjuntos a una solicitud o notificación


NombreTipoDescripción

name

String

Nombre del fichero

fileSize

Long

Tamaño en bytes del fichero

description

String

Descripción del fichero

detachedSignature

String

Firma electrónica del fichero, en caso de que venga firmado y sea de tipo detached. Codificada en Base64

formatSignature

Long

Formato de la firma electrónica

mimeType

String

Valor MIME-type del contenido del fichero (http://www.iana.org/assignments/media-types/ )

Objeto 'function'


El objetivo de este bean es transportar la información de una función asociada a un usuario.


NombreTipoDescripción

function

String

Nombre de la función de un usuario

Objeto 'data'


El objetivo de este bean es transportar los posibles elementos definidos como clave y valor en los objetos en los que sea necesario o definidos.


NombreTipoObligatorioDescripción

name

String

SI

Clave del elemento HashMap (No repetible)

value

StringSI

Valor del elemento HashMap

Objeto 'comunication'


El objetivo de este bean es transportar la información relacionada con los canales a los que se va a enviar el aviso de notificación.


NombreTipoDescripción

id

Long

Identificador interno de la comunicación

draftId

Long

Identificador de la solicitud asociada a la comunicación

destination

String

Destino de la comunicación

method

Long

Método de comunicación al que se hace referencia en el envío de eventos

Objeto 'draftReceiver'


El objetivo de este bean es transportar los posibles elementos definidos como clave y valor en los objetos en los que sea necesario o definidos.


NombreTipoTamaño máximoObligatorio en creaciónDescripción

id

Long

--

Id del objeto

draftId

Long

--

Id del draft al que va asociado el receiver

receiverId

String

-SI

DNI del receiver

name

String

60SI

Nombre del receiver

surname1

String

30NO

Apellido del receiver

surname2

String

30NO

Apellido del receiver

address

String

120NO

Dirección del receiver

email

String

100NO

Dirección de correo del receiver, en caso de ser nula se buscará la que tenga configurada en el portal.

Objeto 'notificationReceiver'


El objetivo de este bean es transportar la información relacionada con los canales a los que se va a enviar el aviso de notificación.


NombreTipoDescripción

id

Long

Id del objeto

idNotification

Long

Id de la notificación al que va asociado el receiver

receiverId

String

DNI del receiver

name

String

Nombre del receiver

surname1

String

Apellido del receiver

surname2

String

Apellido del receiver

address

String

Dirección del receiver

email

String

Dirección de correo del receiver, en caso de ser nula se buscará la que tenga configurada en el portal.

Objeto 'notificationSendMail'


El objetivo de este bean es transportar la información relacionada con los envíos de avisos por correo de las notificaciones.


NombreTipoDescripción

id

Long

Id del objeto

idNotification

Long

Id de la notificación al que va asociado el envio en papel

sendId

String

Referencia del envío del aviso por correo

sendDate

Date

Fecha del envío del aviso por correo

name

String

Nombre y apellidos del destinatario

address

String

Dirección del destinatario

receiptId

String

Referencia del envío de la recepción del aviso por correo

receiptDate

String

Fecha del envío de la recepción del aviso por correo

state

String

Estado del envío en papel

Objeto 'organismVisibility'


El objetivo de este bean es transportar la información relacionada con los envíos de avisos por correo de las notificaciones.


NombreTipoDescripción

idElemento

String

Id de la notificación o comunicación a la que se le asocia el organismo de visibilidad

tipoElemento

String

Indica si el elemento (notificación o comunicación) al que se asocia el organismo de visibilidad es un borrador o no

fechaInicio

Calendar

Momento en el que se guarda el organismo de visibilidad

fechaFin

Calendar

Momento en el que se da de baja el organismo de visibilidad

organismCode

String

Código del organismo de visibilidad que se asocia a la notificación o comunicación

organismName

String

Nombre del organismo de visibilidad que se asocia a la notificación o comunicación

tipoRelacion

String

Sirve para indicar el tipo de organismo utilizado en la visibilidad: organismo gestor u organismo productor

  • No labels