consultaDocumentos

[[TOC]]

Uso General

Permite recuperar hasta 999 registros con información de los documentos. La respuesta muestra el número de entradas devueltas. Si el numeroRegistros es mayor que de 999 se debe entender que la consulta ha encontrado ese nº de coincidencias aunque solo devolverá los 999 primeros. Si el numeroRegistros es 0 se entiende que no se han encontrado coincidencias con esa selección.

Esta operación no devuelve documentos sino que devuelve un conjunto de metadatos asociados a cada documento. Entre estos metadatos devuelve la referenciaDocumento que sirve para recuperar el documento (por ejemplo con obtenDocumento)

Parámetros de invocación

Las credenciales (aplicacion, apikey e idTransacción) y los parámetros codigoProcedimiento, departamentoTramitador son validados como se indica [aquí](/Credenciales y Validación) . Excepto idTransaccion, estos campos son obligatorios en cualquier consulta.

Cualquiera de los parámetros siguientes o su combinación, puede servir para recuperar la información asociada a los documentos. Los parámetros de consulta son los siguientes:

referenciaDocumento: Referencia ENI del documento electrónico.
nombreFichero: Nombre del fichero + "." + extensión, si se ha indicado en el alta (Con los atributos del campo fichero en las operaciones de alta de documentos).
referenciaExpediente: indica el expediente al que pertenece el documento.

Consultando por referenciaExpediente se pueden obtener todos los documentos de un expediente.

organo: referencia DIR3 del productor del documento.
fechaDesde: Menor fecha de creación del documento.
fechaHasta: Mayor fecha de creación del documento.
origenCiudadanoAdministracion: origen "administración" o "cuidadano".
tipoDocumental: cualquier tipo documental ENI admitido.
csv: Si es una copia autentica o un documento firmado con CSV debe contener su valor. Este campo es el que debe utilizar la sede para recuperar el documento.
referenciaOrigen: Campo para agrupar un conjunto de documentos.

Por ejemplo: Para consultar todos los documentos asociados a una presentación, primero hay que obtener la referenciaOrigen del evento. Con la operación consultaDocumentos se pueden recuperar todos los documentos asociados a esa referencia origen.

claseDocumento: cualquier clase de documento asociada al procedimiento en DEXEL.
clasificacion: código SIA asociado al procedimiento.
sensibilidad: nivel de sensibilidad (alto, medio, bajo) asociado al documento.
tipoAcceso: nivel de accceso permitido (restringido, parcialmente restringido, libre).
estadoDocumentoMaestro:

• presandra (documentos en el sistema que no han sido aún presentados),
• entregado (documentos correctamente subidos al sistema por aplicaciones sectoriales o presentados por ciudadanos no incorporado a un expediente),
• incorporado (documento incorporado a un expediente) y
• eliminado (aún no disponible)

En caso de éxito

Se indica que la operación se ha realizado con éxito y devuelve hasta 999 registros con los mismo campos que se han descrito en la consulta (salvo fechaDesde y fechaHasta, que solo se devuelve la fecha de creación del documento.

En caso de error

En caso de error devuelve alguno de los errores indicados aquí