/
4.- Servicios de SRT

4.- Servicios de SRT

INDICE

 

1.- Registro Electrónico General (servicios SOAP)

1.1.- Servicio EntryService

En los siguientes apartados se especifican tanto los tipos de datos utilizados, como los métodos que la componen, detallando los parámetros y mostrando ejemplos de uso.

1.1.1- Método 'listEntry'

Devuelve el listado con los datos de los asientos registrales que se corresponden a los criterios de búsqueda especificados.

1.1.1.1- Signatura

ResultListEntries listEntry(String idApplication, ParamListEntries param) throws RemoteException, SRTException

1.1.1.2.- Parámetros de invocación

Nombre

Tipo

Longitud máxima

Descripción

Obligatorio

Nombre

Tipo

Longitud máxima

Descripción

Obligatorio

info

Info

-

Filtro de búsqueda en función de la información básica del asiento. Son obligatorios los campos organism, requestType y register.

Sí

consolidatedValue

Int

-

Filtro para seleccionar los asientos consolidados (en Registro Físico), los no consolidados ó indistinto
INDISTINTO = 0
NO CONSOLIDADOS = 1
CONSOLIDADOS = 2

No

sender

Actor

-

Interesado que envía el asiento

No

senderAgent

Actor

-

Aportador (Agente emisor)

No

receiver

Actor

-

Destinatario al que va dirigido el asiento

No

receiverAgent

Actor

-

Representante del destinatario al que va dirigido el asiento

No

dateStart

Date

-

Fecha (y hora) de presentación a partir de la cual se desea listar los asientos

No

dateEnd

Date

-

Fecha (y hora) de presentación hasta la que se desea listar los asientos

No

specificData

Data[]

-

Datos específicos asociados

No

sortColumn

String

-

Ordenación por el nombre de la columna

Sí

ascending

Boolean

-

Ordenación de las columnas

ASCENDENTE = true

DESCENDENTE = false

Sí

fromIndex

Int

-

Valor desde el cual se busca

Sí

toIndex

Int

-

Valor de búsqueda

Sí

El emisor (Sender), representante del emisor (SenderAgent), receptor/es (Receivers) y representante del receptor(ReceiverAgent) pueden ser de tipo Person, Organism, Company y UndefinedActor

Solamente se debería utilizar UndefinedActor para el Sender.

Person extends Actor

Tipo

Longitud máxima

Descripción

Obligatorio

Person extends Actor

Tipo

Longitud máxima

Descripción

Obligatorio

Nif

String

255 caracteres

 

Sí

Name

String

255 caracteres

Nombre

No

Surname1

String

255 caracteres

Primer apellido

No

Surname2

String

255 caracteres

Segundo apellido

No

Mail

String

255 caracteres

Correo

No

Address

String

255 caracteres

Dirección

No

 

Organism extends Actor

Tipo

Longitud máxima

Descripción

Obligatorio

Organism extends Actor

Tipo

Longitud máxima

Descripción

Obligatorio

Code

String

255 caracteres

Código del organismo

Sí

Name

String

255 caracteres

Descripción del organismo

Sí

 

Company extends Actor

Tipo

Longitud máxima

Descripción

Obligatorio

Company extends Actor

Tipo

Longitud máxima

Descripción

Obligatorio

Cif

String

255 caracteres

Cif

Sí

Name

String

255 caracteres

Nombre

Sí

UndefinedActor extends Actor

Tipo

Longitud máxima

Descripción

Obligatorio

UndefinedActor extends Actor

Tipo

Longitud máxima

Descripción

Obligatorio

NOTA: En métodos en los que se cree un asiento registral, solamente se debería utilizar este tipo UndefinedActor para el Sender. Por ejemplo, en un caso en el que el interesado es menor, el Sender (el menor) sería de tipo UndefinedActor y el representante del menor  (SenderAgent) que presenta el documento sería de tipo Person.

code

String

255 caracteres

Código

Sí

name

String

255 caracteres

Nombre

Sí

1.1.1.3.- Parámetros de respuesta

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

entries

Entry[]

Listado de asientos que cumplen los filtros de búsqueda establecidos.

1.1.1.4.- Validaciones

Nombre

Descripción

Nombre

Descripción

InternalCoreException

Se agrupan todos aquellos errores internos de funcionamiento del SRT.

1.1.1.5.- Códigos error

Tipo

Descripción

Tipo

Descripción

SRTException

Error en la operación.

RemoteException

Error remoto.

1.1.1.6.- Ejemplo de invocación

Ejemplo de invocación
ParamListEntries paramListEntries = new ParamListEntries(); ResultListEntries entries = new ResultListEntries(); Info info = new Info(); // Código de organismo, es un atributo que el integrador deberá pedir al responsable funcional que le ha solicitado la aplicación info.setOrganism("ORGXXXXX"); //Código de Libro de registro info.setRegister("REG_XXX"); // Código de procedimiento, es un atributo que el integrador deberá pedir al responsable funcional que le ha solicitado la aplicación info.setProcessType("xxx"); //Tipo de Entry (Entrada(0), Salida(1)) info.setRequestType(SRTClientConstants.REQUEST_TYPE_INPUT); //Fecha de creación del Entry Calendar requestTime = Calendar.getInstance(); info.setRequestTime(requestTime); paramListEntries.setInfo(info); entries = entryClient.listEntry(paramListEntries);

1.1.2.- Método 'getEntryDetails'

Obtiene los datos sobre un asiento registral, a partir del identificador de su libro de registro y del número de asiento registral.

1.1.2.1.- Signatura

ResultGetEntryDetails getEntryDetails(String idApplication, ParamGetEntryDetails param) throws RemoteException, SRTException

1.1.2.2.- Parámetros de invocación

Nombre

Tipo

Longitud máxima

Descripción

Obligatorio

Nombre

Tipo

Longitud máxima

Descripción

Obligatorio

registerId

String

-

Identificador del libro de registro en el que se va a realizar la consolidación de los asientos.

Sí

requestType

Int

-

Tipo de asiento
ENTRADA = 0
SALIDA = 1

Sí

entryId

String

-

Nº de registro del asiento asociado al sistema telemático

Sí

consolidatedId

String

-

Nº de registro del asiento asociado al sistema físico con el que se consolida

No

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.

No

1.1.2.3.- Parámetros de respuesta

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

entry

Entry

Información general del asiento y datos específicos en 'specificdata'

request

String

Contenido del documento de solicitud de alta de asiento (fichero PDF, XML, etc.) codificado en Base64

receipt

String

Contenido del documento de justificante de asiento (fichero PDF, XML, etc.) codificado en Base64 y firmado electrónicamente por el sistema telemático

attachments

AttachmentInfo[]

Datos generales de los documentos adjuntos

1.1.2.4.- Validaciones

Nombre

Descripción

Nombre

Descripción

idApplication

Se valida que existe una aplicación dada de alta con ese código.

1.1.2.5.- Códigos error

Tipo

Descripción

Tipo

Descripción

SRTException

Error en la operación.

RemoteException

Error remoto.

1.1.2.6.- Ejemplo de invocación

Ejemplo de invocación
ParamGetEntryDetails paramGetEntryDetails = new ParamGetEntryDetails(); ResultGetEntryDetails resultGetEntryDetails = new ResultGetEntryDetails(); //Identificador de Libro de Registro paramGetEntryDetails.setRegisterId("REG_XXX"); //Código del Asiento Registral paramGetEntryDetails.setEntryId("PREF_XXXXXXXXXX/SUF"); //Tipo de Entry (Entrada(0), Salida(1)) paramGetEntryDetails.setRequestType(SRTClientConstants.REQUEST_TYPE_INPUT); //paramGetEntryDetails.setInvokginId(null); paramGetEntryDetails.setInvokginId("NIF")); resultGetEntryDetails = entryClient.getEntryDetails(paramGetEntryDetails);

1.1.3.- Método 'getEntryAttachmentByFileRef'

1.1.3.1.- Signatura

String getEntryAttachmentByFileRef(String idApplication,ParamGetEntryAttachment param) throws RemoteException, SRTException

1.1.3.2.- Parámetros de invocación

Nombre

Tipo

Longitud máxima

Descripción

Obligatorio

Nombre

Tipo

Longitud máxima

Descripción

Obligatorio

registerId

String

-

Identificador del libro de registro en el que se va a realizar la consolidación de los asientos.

Sí

requestType

int

-

Tipo de la solicitud
Entrada = 0
Salida = 1

Sí

entryId

String

-

Identificador del tramite

Sí

idAttachment

String

-

Identificador del documento adjunto

Sí

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.

No

1.1.3.3.- Parámetros de respuesta

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

idRef

String

Identificador (“id”) del contenido del fichero dentro de la petición SOAP de invocación

1.1.3.4.- Validaciones

Nombre

Descripción

Nombre

Descripción

idApplication

Se valida que existe una aplicación dada de alta con ese código.

1.1.3.5.- Códigos error

Tipo

Descripción

Tipo

Descripción

SRTException

Error en la operación.

RemoteException

Error remoto.

1.1.3.6.- Ejemplo de invocación

Ejemplo de invocación