A continuación se describen todos los servicios REST de TTO, junto con los parámetros de invocación, resultado y ejemplo de integración de cada servicio.

ÍNDICE DE SERVICIOS

1 1. Servicios IRequestService
- 1.1 1.1 - Servicio get
- 1.2 1.2 - Servicio getXml
- 1.3 1.3 - Servicio list
- 1.4 1.4 - Servicio listExcel
2 2. Servicios obsoletos
- 2.1 2.1 - Servicio getTramite
- 2.2 2.2 - Servicio getTramiteList
3 3. Anexos
- 3.1 3.1 - Objetos comunes
  - 3.1.1 3.1.1 - Tramite
  - 3.1.2 3.1.2 - RequestInformation
  - 3.1.3 3.1.3 - Beneficiary
  - 3.1.4 3.1.4 - Applicant
  - 3.1.5 3.1.5 - Document
  - 3.1.6 3.1.6 - Autorizacion
  - 3.1.7 3.1.7 - Category
  - 3.1.8 3.1.8 - Data
  - 3.1.9 3.1.9 - Agents
  - 3.1.10 3.1.10 - Person
  - 3.1.11 3.1.11 - Notification
  - 3.1.12 3.1.12 - Address

1. Servicios IRequestService

Permiten recuperar solicitudes realizadas por los usuarios.

1.1 - Servicio get

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

Obtiene los datos de un solo trámite en formato JSON.

URL de invocación

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

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

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

Parámetros de entrada

Parámetros	Tipo	Descripción

Parámetros	Tipo	Descripción
applicationId	String	ID de la aplicación que invoca el servicio Obligatorio
requestCode¹	String	Identificador que se le asigna al trámite
csvRequest¹	String	CSV de la solicitud
csvRegisterReceipt¹	String	CSV de registro
registerId¹	String	ID de registro
docsInProcess	Boolean	Parámetro opcional que indica si se retornan los tramites no terminados, por defecto será no.

¹ Es obligatorio especificar uno y sólo uno de estos parámetros en una misma petición.

Parámetros de respuesta

Tipo	Descripción

Tipo	Descripción
Tramite	JSON con los datos del trámite consultado, en codificación UTF-8.

Códigos de respuesta

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

Código	Nombre	Descripción

Código	Nombre	Descripción
202	Accepted	El trámite se ha recuperado correctamente.
400	Bad request	Consulta especificada erróneamente.
404	Not found	No se ha encontrado el trámite solicitado.
500	Internal Server Error	Error interno del servidor.

Ejemplos de invocación

http://preaplicaciones.aragon.es/tto_core/rest/tramite/get?applicationId=TTO&requestCode=XXXXXXXXXXXX

http://preaplicaciones.aragon.es/tto_core/rest/tramite/get?applicationId=TTO&csvRequest=CSVXXXXXXXXXXXXX

Ejemplo de integración

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

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

// Número del trámite del usuario.
// P.E.: el obtenido desde SGA en el evento que se emite cuando un
// usuario finaliza un trámite
String requestCode = ...;


// Paso 1. Conectar
URL url = new URL("http://preaplicaciones.aragon.es/tto_core/rest/tramite/get?" +
        "applicationId=" + APPLICATION_ID +
        "&requestCode=" + requestCode);
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 con tiempo 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
ResultTramiteBean tramite = gson.fromJson(responseStrBuilder.toString(),
        ResultTramiteBean.class);

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

1.2 - Servicio getXml

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

Obtiene los datos de un trámite en formato XML.

URL de invocación

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

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

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

Parámetros de entrada

Parámetros	Tipo	Descripción

Parámetros	Tipo	Descripción
applicationId	String	ID de la aplicación que invoca el servicio Obligatorio
requestCode¹	String	Identificador que se le asigna al trámite
csvRequest¹	String	CSV de la solicitud
csvRegisterReceipt¹	String	CSV de registro
registerId¹	String	ID de registro
docsInProcess	Boolean	Parámetro opcional que indica si se retornan los tramites no terminados, por defecto será no.

¹ Es obligatorio especificar uno y sólo uno de estos parámetros en una misma petición.

Parámetros de respuesta

Tipo	Descripción

Tipo	Descripción
Trámite en XML	XML con los datos del trámite consultado, en codificación UTF-8.

Códigos de respuesta

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

Código	Nombre	Descripción

Código	Nombre	Descripción
202	Accepted	El trámite se ha recuperado correctamente.
400	Bad request	Consulta especificada erróneamente.
404	Not found	No se ha encontrado el trámite solicitado.
500	Internal Server Error	Error interno del servidor.

Ejemplos de invocación

http://preaplicaciones.aragon.es/tto_core/rest/tramite/getXml?applicationId=TTO&requestCode=XXXXXXXXXXXX

http://preaplicaciones.aragon.es/tto_core/rest/tramite/getXml?applicationId=TTO&csvRequest=CSVXXXXXXXXXXXXX

Ejemplo de integración

Utilizando Java 8 y la librería de cliente.

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

// Número del trámite del usuario.
// P.E.: el obtenido desde SGA en el evento que se emite cuando un
// usuario finaliza un trámite
String requestCode = ...;


// Paso 1. Conectar
URL url = new URL("http://preaplicaciones.aragon.es/tto_core/rest/tramite/getXml?" +
        "applicationId=" + APPLICATION_ID +
        "&requestCode=" + requestCode);
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. Convertir la respuesta al objeto del trámite
TransformXMLToObject transformer = new TransformXMLToObject();
ResultTramiteBean tramite = transformer.parseTramiteBeanFromFile(
            connection.getInputStream());
            
// Paso 4. Desconectar
connection.disconnect();

1.3 - Servicio list

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

Método que obtiene un listado de tramites en formato JSON filtrado por parámetros

URL de invocación

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

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

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

Parámetros de entrada

Parámetros	Tipo	Descripción

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.
docsInProcess	Boolean	Parámetro opcional que indica si se retornan los tramites no terminados, por defecto será no.

¹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

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

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

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.

// 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();

1.4 - Servicio listExcel

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

Recupera un listado de tramites y los representa en un fichero excel.

URL de invocación

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

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

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

Parámetros de entrada

Parámetros	Tipo	Descripción

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

4.- Servicios de TTO

1. Servicios IRequestService

1.1 - Servicio get

1.2 - Servicio getXml

1.3 - Servicio list

1.4 - Servicio listExcel