Page Comparison

...

Expand

title	Má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
requestSignature	Integer	En 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.
origin	Enum	Origen del trámite. Los posibles valores son: APORTACION, RECURSO, SOLICITUD, SUBSANACION y TODOS. Si no se indica se devuelven sólo los trámites con origen SOLICITUD.
creationStartDate¹	Date	Fecha de creación del tramite. Formato dd/MM/yyyy
creationEndDate²	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
updateStartDate¹	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
updateEndDate²	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.
registerStartDate¹	Date	Fecha en la que se registraron los trámites. Formato dd/MM/yyyy
registerEndDate²	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.
registerOrgCode	String	Có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.
contributorId	String	Identificador del agente aportador.
interestedId	String	Identificador del agente interesado.
representativeId	String	Identificador del agente representante.
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.
excludedCodes	Array de Strings	Lista de requestCode referentes a tramites que se quieren excluir del resultado final.

Note

¹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.

²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

http://preaplicaciones.aragon.es/tto_core/rest/tramite/list?applicationId=TTO&signature=22&summaryInfo=false

http://preaplicaciones.aragon.es/tto_core/rest/tramite/list?applicationId=TTO&signature=2005&updateStartDate=01/11/2019&updateEndDate=07/11/2019&registered=true

Ejemplo de integración

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

Code Block

language	java
theme	Confluence

// 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

title	Má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

requestSignature

Integer

En 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 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.

origin

Enum

Origen del trámite. Los posibles valores son: APORTACION, RECURSO, SOLICITUD, SUBSANACION y TODOS.

Si no se indica se devuelven sólo los trámites con origen SOLICITUD.

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.

creationStartDate¹

Date

Fecha de creación del tramite.

Formato dd/MM/yyyy

creationEndDate²

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

updateStartDate¹

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

updateEndDate²

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.

registerStartDate¹

Date

Fecha en la que se registraron los trámites.

Formato dd/MM/yyyy

registerEndDate²

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.

registerOrgCode

String

Có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.

contributorId

String

Identificador del agente aportador.

interestedId

String

Identificador del agente interesado.

representativeId

String

Identificador del agente representante.

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.

excludedCodes

Array de Strings

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

Note

¹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.

²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.

Ejemplos de invocación

http://preaplicaciones.aragon.es/tto_core/rest/tramite/listExcel?applicationId=TTO&signature=22&summaryInfo=false

http://preaplicaciones.aragon.es/tto_core/rest/tramite/listExcel ?applicationId=TTO&signature=2005&updateStartDate=01/11/2019&updateEndDate=07/11/2019&registered=true

Ejemplo de integración

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

Code Block

language	java
theme	Confluence

// 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
progreso	Integer	Porcentaje de completado del trámite.
requestInformation	RequestInformation	Contiene la información específica de una solicitud.
applicant	Applicant	Datos del usuario que solicita el trámite. Este usuario puede ser persona física o jurídica.
documents	Array de Document	Listado de documentos que el usuario debe aportar al trámite.
otherDocuments	Array de Document	Listado de documentos que el usuario aporta voluntariamente.
authorizations	Autorizacion	Listado de autorizaciones del trámite.
form¹	Array de Category	Formulario del trámite. Cada elemento de la lista se corresponde con una sección del procedimiento al que pertenece la solicitud. Está compuesto por un único atributo, que lleva como nombre el título de dicha sección y como valor los campos de la sección.
beneficiary	Beneficiary	Datos del beneficiario del trámite. Este campo solo aparece cuando el usuario que solicita el trámite (applicant) ejerce como representante.
agents	Agents	Datos de los agentes que actúan sobre el trámite.

...

trámite.

queryParams

Mapa String-String

Parámetros de la URL con los que el usuario ha accedido al trámite.

Pueden especificarse desde las aplicaciones integradoras si estas desean asociar atributos personalizados a los trámites.

Info

title	Nota

...

Si se accede especificando un parámetro con nombre numExpediente, se reflejará el valor indicado en el título durante su tramitación con el siguiente formato:

[Nombre del trámite] del expediente [valor de numExpediente]

Por ejemplo, con nombre del trámite "Subsanaciones" y valor de numExpediente "2123":

Subsanaciones del expediente 2123

Note

title	Nota

El formulario se muestra sólo si no está vacío y si el parámetro de llamada summaryInfo aparece especificado como false.

...

Ejemplos JSON

Ejemplos XML

Expand

title	Mostrar

Code Block

language	js
theme	DJango

{
  "progreso": 100,
  "requestInformation": ...,
  "applicant": ...,
  "documents": [
    ...
  ],
  "otherDocuments": [
    ...
  ],
  "authorizations": [
    ...
  ],
  "form": [
    ...
  ],
  "beneficiary": ...,
  "agents": ...,
  "queryParams": {
    "numExpediente": "2123",
    "atributo1": "ejemplo",
	...
  }
}

Expand

title	Mostrar

Code Block

language	xml
theme	DJango

<resultTramiteBean>
  <progreso>100</progreso>
  <requestInformation>
    ...
  </requestInformation>
  <applicant>
    ...
  </applicant>
  <documents>
    <document>
      ...
    </document>
    ....
  </documents>
  <authorizations>
    <authorization>
      ...
    </authorization>
    ...
  </authorizations>
  <form>
    <categories>
      <category>
        ...
      </category>
      ...
    </categories>
  </form>
  <agents>
	...
  </agents>
  <queryParams>
    <entry>
      <key>numExpediente</key>
      <value>2123</value>
    </entry>
    <entry>
      <key>atributo1</key>
      <value>ejemplo</value>
    </entry>
    ...
  </queryParams>
</resultTramiteBean>

3.1.2 - RequestInformation

...

Versions Compared

Old Version 8

New Version 9

Key

3.1.2 - RequestInformation