...
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.
...
Expand |
---|
|
URL de invocación La URL de invocación del servicio REST es la siguiente: http://{entorno}/tto_core/rest/tramite/get
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 | requestCode1 | String | Identificador que se le asigna al trámite | csvRequest1 | String | CSV de la solicitud | csvRegisterReceipt1 | String | CSV de registro | registerId1 | String | ID de registro | docsInProcess | Boolean | Parámetro opcional que indica si se retornan los tramites no terminados, por defecto será no. |
Note |
---|
1 Es obligatorio especificar uno y sólo uno de estos parámetros en una misma petición. |
Parámetros de respuesta 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 |
---|
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. Code Block |
---|
language | java |
---|
theme | Confluence |
---|
| // 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(); |
|
...
Expand |
---|
|
URL de invocación La URL de invocación del servicio REST es la siguiente: http://{entorno}/tto_core/rest/tramite/getXml
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 | requestCode1 | String | Identificador que se le asigna al trámite | csvRequest1 | String | CSV de la solicitud | csvRegisterReceipt1 | String | CSV de registro | registerId1 | String | ID de registro |
Note |
---|
1 Es obligatorio especificar uno y sólo uno de estos parámetros en una misma petición. |
docsInProcess | Boolean | Parámetro opcional que indica si se retornan los tramites no terminados, por defecto será no. |
Note |
---|
1 Es obligatorio especificar uno y sólo uno de estos parámetros en una misma petición. |
Parámetros de respuesta 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 |
---|
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 Ejemplo de integración Utilizando Java 8 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";
// 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(); |
|
...
Expand |
---|
|
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. | 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. 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. | 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. 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. |
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 |
---|
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 +
"®istered=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 |
---|
|
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. |
| 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. 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. | 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. 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. |
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 |
---|
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 +
"®istered=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. |
form1Array | de CategoryList<Map<String, Object>> | 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. |
notification | Notification | Bloque con los de contacto que se utilizarán a efectos de notificación. |
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 |
---|
| 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
|
|
...
Atributo | Tipo | Descripcion |
---|
registerId | String | Identificador del registro. Aparecerá sólo en el caso de que el trámite se haya enviado a registro. |
csvRegisterReceipt | String | CSV del justificante de registro. Aparecerá sólo en el caso de que el trámite se haya enviado a registro. |
registerDate | Long | Fecha en la que se ha realizado el registro del trámite. Aparecerá sólo en el caso de que el trámite se haya enviado a registro (representación en tiempo UNIX). |
bentId1 | Long | Identificador del envío a BENT. |
...
legalEntityCert | Boolean | Indica cuando el trámite se realiza con un certificado de persona jurídica. |
Note |
---|
1 Se puede dar el caso en el que se haya completado el trámite pero no se haya especificado el identificador de BENT. Las causas pueden ser las siguientes: Caída de BENT. Reinicio de BENT en el servidor. Un error ajeno a las aplicaciones como, por ejemplo, un problema en la conexión en la red. Para solucionar este contratiempo y recuperar dicho identificador, TTO tiene programada una llamada diaria al servicio de BENT en horario nocturno. Una vez obtenido el identificador de BENT, estará disponible como valor de este mismo atributo. |
...
Ejemplos JSON | Ejemplos XML |
---|
Expand |
---|
|
Code Block |
---|
| {
"number": 11889,
"csvRequest": "CSVBA83A3O46R1X01TTO",
"signature": 1862,
"requestSignature": 1996,
"entity": 0,
"denomination": "Solicitud General",
"receiverOrgCode": "ORG11214",
"registerOrgCode": "ORG11197",
"requestCode": "11889GRZWV8V5",
"requestCodeAssociated": "20303R2LMD0S69V",
"creationDate": 1571666310573,
"sendEventSGA": false,
"eventSGA": "",
"version": 4,
"onlineOnly": false,
"updateDate": null,
"origin": "SOLICITUD",
"registerInfo: {
"registerId": "RT_000005695/2019",
"csvRegisterReceipt": "CSVTA77QJP15D1P00SRT",
"registerDate": 1571666477478,
"bentId": 515,
"legalEntityCert": true
}
} |
|
|
Expand |
---|
|
Code Block |
---|
| <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>
<requestCodeAssociated>20303R2LMD0S69V</requestCodeAssociated>
<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>
<legalEntityCert>true</legalEntityCert>
</registerInfo>
</requestInformation> |
|
|
...
Atributo | Tipo | Descripción |
---|
representativeIdentifier | String | Campo de identificación la entidad física, que actúa en nombre de la entidad jurídica. |
representativeName | String | Nombre de la persona física, que actúa en nombre de una entidad jurídica. |
representativeSurname | String | Primer apellido de la persona física, que actúa en nombre de la entidad jurídica. |
representativeSurname2 | String | Segundo apellido de la persona física, que actúa en nombre de la entidad jurídica. |
tipoRepresentacionrepresentation | Integer | Indica el tipo de representación. Los posibles valores son: Tutor legal Documento específico representación Documento público REA |
...
Ejemplos JSON | Ejemplos XML |
---|
Expand |
---|
|
Code Block |
---|
| {
"nif": "Q0100000I",
"name": "FUFASA",
"surname": "",
"surname2": "",
"notificationMail": "correo@ejemplo.com",
"notificationPhone": "974000000",
"address": "C/Ejemplo nº1",
"postalCode": 0,
"city": "Zaragoza",
"province": "Zaragoza",
"country": "España",
"documentType": "NIF",
"naturalPerson": true,
"representativeIdentifier": "10000322Z",
"representativeName": "MANUELA",
"representativeSurname": "BLANCO",
"representativeSurname2": "VIDAL",
"tipoRepresentacionrepresentation": 0
} |
|
|
Expand |
---|
|
Code Block |
---|
| <applicant>
<nif>Q0100000I</nif>
<name>FUFASA</name>
<surname/>
<surname2/>
<notificationMail>asdf@ho.es</notificationMail>
<postalCode>0</postalCode>
<representativeIdentifier>10000322Z</representativeIdentifier>
<representativeName>MANUELA</representativeName>
<representativeSurname>BLANCO</representativeSurname>
<representativeSurname2>VIDAL</representativeSurname2>
<representation>0</representation>
</applicant> |
|
|
3.1.5 - Document
...
Atributo | Tipo | Descripción |
---|
id | String | Identificador calculado del documento. |
name | String | Nombre del fichero subido. Aparecerá sólo en el caso del que el documento se haya aportado. |
document | String | CSV del documento. Aparecerá sólo en el caso de que el documento se haya aportado y no sea un documento múltiple. |
documentListInteger | Array de Document | Lista de ficheros aportados por el ciudadano (en caso de ser un documento múltiple). |
description |
| Descripción del documento. |
sign |
| Indica si el documento esta firmado. |
isAuthorized |
| Indica si el usuario ha dado permiso para la consulta del documento. |
...
Contiene los datos de los agentes que actúan sobre el trámite.
Atributos
Ejemplos JSON | Ejemplos XML |
---|
Expand |
---|
|
Code Block |
---|
language | js |
---|
Atributo | Tipo | Descripción |
---|
identifier | String | Campo de identificación de la persona física o jurídica (NIF/NIE/CIF). |
name | String | Campo con el nombre o razón social. |
surname | String | Campo con el apellido de la persona física. No aparecerá informado en caso de persona jurídica. |
mail |
Info |
---|
No todos los campos aparecen en todas las casuísticas, en cuyo caso vendrán con valor null o vacíos. |
String | Campo con la dirección de correo electrónico. |
phone | String | Campo con el número de teléfono. |
personType | String | Campo con el tipo de persona. FISICA, JURIDICA y ENTIDAD. . |
documentType | String | Campo con el tipo de documento. NIF/CIF/NIE. |
Info |
---|
No todos los campos aparecen en todas las casuísticas, en cuyo caso vendrán con valor null o vacíos. |
Ejemplos JSON | Ejemplos XML |
---|
Expand |
---|
|
Code Block |
---|
| {
"identifier": "10000322Z",
"name": "MANUELA",
"surname": "BLANCO VIDAL"
"mail": "ejemplo@ejemplo.com",
"phone": "974123456",
"personType": "FISICA",
"documentType": "NIF"
} |
|
|
Expand |
---|
|
Code Block |
---|
| <identifier>10000322Z</identifier>
<name>MANUELA</name>
<surname>BLANCO VIDAL</surname>
<mail>ejemplo@ejemplo.com</mail>
<phone>974123456</phone>
<personType>FISICA</personType>
<documentType>NIF</documentType> |
|
|
3.1.11 - Notification
Contiene los datos de contacto a efectos de notificación.
Atributos
Atributo | Tipo | Descripción |
---|
addresses | Array de Address | Lista de direcciones postales |
Ejemplos JSON | Ejemplos XML |
---|
Expand |
---|
|
Code Block |
---|
| {
"notification": {
"addresses": [
...
]
}
} |
|
|
Expand |
---|
|
Code Block |
---|
| <notification>
<addresses>
...
</addresses>
</notification> |
|
|
3.1.12 - Address
Contiene los datos de una dirección postal
Atributos
Atributo | Tipo | Descripción |
---|
country | String | Pais. |
province | String | Provincia. |
city | String | Ciudad. |
address | String | Dirección. |
postalCode | String | Código postal. |
Ejemplos JSON | Ejemplos XML |
---|
Expand |
---|
|
Code Block |
---|
| {
"identifieraddress": "C/ Ejemplo nº1",
"10000322ZpostalCode": 50005,
"namecity": "MANUELAZaragoza",
"surnameprovince": "BLANCO VIDAL"Zaragoza",
"country": "España"
} |
|
|
Expand |
---|
|
Code Block |
---|
| <identifier>10000322Z</identifier>
<name>MANUELA</name>
<surname>BLANCO VIDAL</surname><address>
<address>C/ Ejemplo nº1</address>
<postalCode>50005</postalCode>
<city>Zaragoza</city>
<province>Zaragoza</province>
<country>España</country>
</address> |
|
|