Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleMás información

URL de invocación

La URL de invocación del servicio REST es la siguiente:

http://{entorno}/tto_core/rest/tramite/list


Info

Para invocar a este servicio se debe utilizar el método GET de HTTP.


Parámetros de entrada

Parámetros

Tipo

Descripción

applicationId

String

ID de la aplicación que invoca el servicio.

Obligatorio

signature

Array de integer

Lista con las signatura de cada procedimiento a consultar.

Obligatorio utilizar como mínimo una

requestSignatureIntegerEn los casos en los que un tramite pueda ser multiprocedimiento, signatura del procedimiento efectivo del tramite a efectos de metadatado y registro.

user.nif

String

Identificador (NIF) de la persona que ha creado el trámite.

summaryInfo

boolean

Parámetro para el filtrado de la respuesta.

  • true: sólo es enviará la información resumida del trámite (applicant, beneficiary, requestInformation)

  • false: se envía toda la información del tramite

Por defecto será true.

originEnum

Origen del trámite.

creationStartDate1

Date

Fecha de creación del tramite. 

Formato dd/MM/yyyy

creationEndDate2

Date

Fecha fin para incluir rango de la fecha de creación.

Para utilizarlo es obligatorio especificar el parámetro creationStartDate

Formato dd/MM/yyyy

updateStartDate1

Date

Fecha de la ultima modificación del trámite. Si no se indica ninguna fecha, se tomará por defecto esta fecha como la actual. 

Formato dd/MM/yyyy

updateEndDate2

Date

Fecha fin para incluir rango de la fecha de modificación. 

Para utilizarlo es obligatorio especificar el parámetro updateStartDate

Formato dd/MM/yyyy

registered

boolean

Permite filtrar los trámites según su estado de registro.

  • true: filtra por trámites que estén registrados

  • false: filtra por tramites que no estén registrados

Si no se indica, se devuelven todos.

registerStartDate1

Date

Fecha en la que se registraron los trámites. 

Formato dd/MM/yyyy

registerEndDate2

Date

Fecha fin para incluir rango de la fecha de registro. 

Para utilizarlo es obligatorio especificar el parámetro registerStartDate.

Formato dd/MM/yyyy

receiverOrgCode

String

Código de Organismo SIU que corresponde al organismo de BENT al que se envía la solicitud.

registerOrgCodeStringCódigo de Organismo SIU que corresponde al organismo en el que se registra la solicitud.

beneficiary.nif

String

Identificador (NIF) de la persona beneficiaria el trámite. Solo para tramites con representación.

representation

Boolean

Permite filtrar los trámites por representación.

  • true: solo trámites donde se ejerza una representación.

  • false:  solo trámites donde no se ejerza una representación.

Si no se indica, se devuelven todos.

excludedCodesArray de StringsLista de requestCode referentes a tramites que se quieren excluir del resultado final.


Note

1 En caso de que no se incluya ninguna fecha inicial (creationStartDate, registerStartDate, updateStartDate), se devolverán únicamente los trámites que se hayan actualizado el mismo día en el que se hace la invocación. Si se incluyen varias, se tomará la más posterior.

2 En caso de que no se incluya ninguna fecha final (creationEndDate, registerEndDate, updateEndDate), se devolverán todos los trámites que se hayan actualizado hasta el mismo día en el que se hace la invocación. Si se incluyen varias, se tomará la más anterior.


Parámetros de respuesta

Tipo

Descripción

Array de Tramite

Lista con los datos de los trámites consultados, en codificación UTF-8.


Note

En caso de que el formulario de los trámites consultados tenga un valor nulo, no se devolverá en la respuesta.



Códigos de respuesta

El resultado de la operación viene reflejado en el estado de la respuesta HTTP.

Código

Nombre

Descripción

202

Accepted

La lista de trámites se ha recuperado correctamente. Si no se ha encontrado ninguno, devuelve una lista vacía.

400

Bad request

Consulta especificada erróneamente.

500

Internal Server Error

Error interno del servidor.


Ejemplos de invocación

Ejemplo de integración

Utilizando Java 8, GSON y la librería de cliente.

Code Block
languagejava
themeConfluence
// Id de la aplicación que está accediendo a TTO
String APPLICATION_ID = "XXX";

// Signaturas de los procedimientos a consultar
int signature1 = ...;
int signature2 = ...;
int signature3 = ...;


// Paso 1. Preparar la conexión
URL url = new URL("http://preaplicaciones.aragon.es/tto_core/rest/tramite/list?" +
        "applicationId=" + APPLICATION_ID +
        "&signature=" + signature1 + "," + signature2 + "," + signature3 +
        "&registered=false" +
        "&summaryInfo=false");
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("Accept", "application/json");

// Paso 2. Comprobar respuesta correcta
if (connection.getResponseCode() != 202) {
  // Gestionar respuesta incorrecta
}  
  
// Paso 3. Recuperamos la respuesta del servicio en formato String
StringBuilder responseStrBuilder = new StringBuilder();
BufferedReader streamReader = new BufferedReader(
        new InputStreamReader(connection.getInputStream(), "UTF-8"));
String inputStr;
while ((inputStr = streamReader.readLine()) != null) {
  responseStrBuilder.append(inputStr);
}

// Paso 4. Configurar GSON para recuperar las fechas desde formato UNIX
GsonBuilder builder = new GsonBuilder();
builder.registerTypeAdapter(Date.class, (JsonDeserializer<Date>) (json, typeOfT, context) ->
        new Date(json.getAsJsonPrimitive().getAsLong()));
Gson gson = builder.create();

// Paso 5. Convertir la respuesta al objeto del trámite
JsonArray json = gson.fromJson(responseStrBuilder.toString(), JsonArray.class);
ResultTramiteBean tramite = gson.fromJson(responseStrBuilder.toString(),
        ResultTramiteBean.class);
ResultTramiteBean tramiteList[] = gson.fromJson(json, ResultTramiteBean[].class);

// Paso 6. Desconectar
connection.disconnect();


...

Expand
titleMás información

URL de invocación

La URL de invocación del servicio REST es la siguiente:

http://{entorno}/tto_core/rest/tramite/listExcel


Info

Para invocar a este servicio se debe utilizar el método GET de HTTP.


Parámetros de entrada

Parámetros

Tipo

Descripción

applicationId

String

ID de la aplicación que invoca el servicio

Obligatorio

signature

Array de integer

Lista con las signatura de cada procedimiento a consultar

Obligatorio utilizar como mínimo una

requestSignatureIntegerEn los casos en los que un tramite pueda ser multiprocedimiento, signatura del procedimiento efectivo del tramite a efectos de metadatado y registro.

user.nif

String

Identificador (NIF) de la persona que ha creado el trámite.

summaryInfo

boolean

Parámetro para el filtrado de la respuesta.

  • true: sólo es se exportará la información resumida de cada trámite (hoja "resumen").

  • false: se exportarán, además del resumen, los datos de los formularios y los documentos de cada trámite. Se deberá indicar una única signatura.

Por defecto será true.

originEnum

Origen del trámite.

Note

Si se busca por origin=TODOS, sólo se exportará la información resumida de cada trámite independientemente del parámetro summaryInfo por posible incompatibilidad de formularios y documentos.


creationStartDate1

Date

Fecha de creación del tramite. 

Formato dd/MM/yyyy

creationEndDate2

Date

Fecha fin para incluir rango de la fecha de creación.

Para utilizarlo es obligatorio especificar el parámetro creationStartDate

Formato dd/MM/yyyy

updateStartDate1

Date

Fecha de la ultima modificación del trámite. Si no se indica ninguna fecha, se tomará por defecto esta fecha como la actual. 

Formato dd/MM/yyyy

updateEndDate2

Date

Fecha fin para incluir rango de la fecha de modificación. 

Para utilizarlo es obligatorio especificar el parámetro updateStartDate

Formato dd/MM/yyyy

registered

boolean

Permite filtrar los trámites según su estado de registro.

  • true: filtra por trámites que estén registrados

  • false: filtra por tramites que no estén registrados

Si no se indica, se devuelven todos.

registerStartDate1

Date

Fecha en la que se registraron los trámites. 

Formato dd/MM/yyyy

registerEndDate2

Date

Fecha fin para incluir rango de la fecha de registro. 

Para utilizarlo es obligatorio especificar el parámetro registerStartDate.

Formato dd/MM/yyyy

receiverOrgCode

String

Código de Organismo SIU que corresponde al organismo de BENT al que se envía la solicitud.

registerOrgCodeStringCódigo de Organismo SIU que corresponde al organismo en el que se registra la solicitud.

beneficiary.nif

String

Identificador (NIF) de la persona beneficiaria el trámite. Solo para tramites con representación.

representation

Boolean

Permite filtrar los trámites por representación.

  • true: solo trámites donde se ejerza una representación.

  • false:  solo trámites donde no se ejerza una representación.

Si no se indica, se devuelven todos.

excludedCodesArray de StringsLista de requestCode referentes a tramites que se quieren excluir del resultado final


Note

1 En caso de que no se incluya ninguna fecha inicial (creationStartDate, registerStartDate, updateStartDate), se devolverán únicamente los trámites que se hayan actualizado el mismo día en el que se hace la invocación. Si se incluyen varias, se tomará la más posterior.

2 En caso de que no se incluya ninguna fecha final (creationEndDate, registerEndDate, updateEndDate), se devolverán todos los trámites que se hayan actualizado hasta el mismo día en el que se hace la invocación. Si se incluyen varias, se tomará la más anterior.


Parámetros de respuesta

Tipo

Descripción

Fichero binario

Lista con los datos de los trámites consultados exportados en un fichero excel.



Códigos de respuesta

El resultado de la operación viene reflejado en el estado de la respuesta HTTP.

Código

Nombre

Descripción

202

Accepted

La lista de trámites se ha recuperado correctamente. Si no se ha encontrado ninguno, devuelve una lista vacía.

400

Bad request

Consulta especificada erróneamente.

500

Internal Server Error

Error interno del servidor.


Ejemplo de integración

Utilizando Java 8, GSON y la librería de cliente.

Code Block
languagejava
themeConfluence
// Id de la aplicación que está accediendo a TTO
String APPLICATION_ID = "XXX";

// Signaturas de los procedimientos a consultar
int signature1 = ...;
int signature2 = ...;
int signature3 = ...;


// Paso 1. Preparar la conexión
URL url = new URL("http://preaplicaciones.aragon.es/tto_core/rest/tramite/listExcel?" +
        "applicationId=" + APPLICATION_ID +
        "&signature=" + signature1 + "," + signature2 + "," + signature3 +
        "&registered=false" +
        "&summaryInfo=false");
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/octet-stream");

// Paso 2. Comprobar respuesta correcta
if (conn.getResponseCode() != 200) {
  // Gestionar respuesta incorrecta
}

// Paso 3. Obtener el nombre del archivo (opcional)
String name = "Solicitudes.xls";
String contentHeader = conn.getHeaderField("Content-Disposition");
final String fileNameHeader = "filename=\"";
if (contentHeader.contains(fileNameHeader)) {
  int start = contentHeader.lastIndexOf(fileNameHeader) + fileNameHeader.length();
  int end = contentHeader.length() - 2;
  name = contentHeader.substring(start, end);
}

// Paso 4. Recuperar el fichero
InputStream is = conn.getInputStream();
byte[] buffer = new byte[is.available()];
is.read(buffer);
OutputStream outStream = new FileOutputStream(name);
outStream.write(buffer);

// Paso 5. Desconectar
conn.disconnect();


...

Atributo

Tipo

Descripción

number

Integer

Identificador del trámite.

csvRequest

String

CSV del trámite. Aparecerá sólo en el caso de que el trámite se haya firmado.

signature

Integer

Código del procedimiento al que pertenece el trámite.

requestSignatureInteger
En los casos en los que un tramite pueda ser multiprocedimiento, este campo determinará el procedimiento efectivo del tramite a efectos de metadatado y registro.

entity

Integer

Entidad a la que pertenece el procedimiento al que pertenece el trámite.

denomination

String

Nombre del procedimiento al que pertenece el trámite.

receiverOrgCode

String

Código de Organismo SIU que corresponde al organismo de BENT al que se envía la solicitud.

registerOrgCode

String

Código de Organismo SIU que corresponde al organismo en el que se registra la solicitud.

requestCode

String

Identificador que se le asigna al trámite. La manera de generar este código dependerá del procedimiento al que pertenezca, p.ej. Número de trámite + código aleatorio de 8 letras.

creationDate

Long

Fecha en la que el usuario ha accedido para crear el trámite (representación en tiempo UNIX).

sendEventSGA

Boolean

Status
titleOBSOLETO
Indica si se deberá realizar evento a SGA.

eventSGA

String

Status
titleOBSOLETO
 Evento de SGA a enviar.

version

Integer

Indica la versión del xml del trámite.

onlineOnly

Boolean

Indica si el tramite solo puede rellenarse digitalmente.

updateDate

Long

Fecha de última actualización del trámite (representación en tiempo UNIX).

originEnumOrigen del trámite.
registerInfoObjectAlberga la información de registro

...

Ejemplos JSONEjemplos XML


Expand
titleMostrar


Code Block
languagejs
themeDJango
{
  "number": 11889,
  "csvRequest": "CSVBA83A3O46R1X01TTO",
  "signature": 1862,
  "requestSignature": 1996,
  "entity": 0,
  "denomination": "Solicitud General",
  "receiverOrgCode": "ORG11214",
  "registerOrgCode": "ORG11197",
  "requestCode": "11889GRZWV8V5",
  "creationDate": 1571666310573,
  "sendEventSGA": false,
  "eventSGA": "",
  "version": 4,
  "onlineOnly": false,
  "updateDate": null,
  "origin": "SOLICITUD",
  "registerInfo: {
	  "registerId": "RT_000005695/2019",
	  "csvRegisterReceipt": "CSVTA77QJP15D1P00SRT",
	  "registerDate": 1571666477478,
	  "bentId": 515
  }
}




Expand
titleMostrar


Code Block
languagexml
themeDJango
<requestInformation>
  <number>11797</number>
  <csvRequest>CSVD17WTR616U1D01TTO</csvRequest>
  <signature>2005</signature>
  <requestSignature>1996</requestSignature>
  <entity>0</entity>
  <denomination>procedimiento prueba</denomination>
  <receiverOrgCode>ORG11214</receiverOrgCode>
  <registerOrgCode>ORG11197</registerOrgCode>
  <requestCode>00000000TOXPURE</requestCode>
  <creationDate>2019-10-15T14:10:40.463+02:00</creationDate>
  <sendEventSGA>false</sendEventSGA>
  <version>2</version>
  <onlineOnly>false</onlineOnly>
  <origin>SOLICITUD</origin>
  <registerInfo>
    <registerId>RT_000005611/2019</registerId>
    <csvRegisterReceipt>CSVFI2DH6B36S1500SRT</csvRegisterReceipt>
    <registerDate>2019-10-15T16:11:28.595+02:00</registerDate>
  </registerInfo>
</requestInformation>



...