Saltar al final de los metadatos
Ir al inicio de los metadatos
Descripción

Consulta genérica de ficheros descargados o descargables.

Estructura de la url

 

https://api.cnmc.gob.es/ficheros/v1/consultar?idProcedimiento=<>&nifEmpresa=<>&estado=<>&fechaDesde=<>&fechaHasta=<>

 

 

Petición

Esta petición se debe enviar utilizando el método HTTP POST.

Los parámetros de la petición son los siguientes:

  • idProcedimiento: Identificador del procedimiento sobre el que queremos consultar.
  • nifEmpresa: identificador de la empresa que solicita la descarga.
  • estado: identificador del estado en el que se encuentra el fichero {DISPONIBLE, DESCARGADO }.
  • fechaDesde: Filtro de fechas sobre la fecha de puesta a disposición del fichero. Fecha 'desde' inclusive (opcional).
  • fechaHasta: Filtro de fechas sobre la fecha de puesta a disposición del fichero. Fecha 'hasta' inclusive (opcional).
Respuesta

Retorna una lista, con formato JSON, de objetos Fichero que contienen a su vez la siguiente estructura:

  • uuid: Identificador único del fichero en el sistema.
  • idProcedimiento: Identificador del procedimiento relacionado con el fichero.
  • nifEmpresa: Identificador de la empresa.
  • numeroBytes: Tamaño del fichero en bytes.
  • tipoFichero: Identificador del tipo de fichero.
  • estado: estado en el que se encuentra el fichero { DISPONIBLE, DESCARGADO}.
  • mime: Tipo mime del fichero. http://www.iana.org/assignments/media-types/media-types.xhtml.
  • nombre: Nombre del fichero.
  • hash: hash del fichero, en formato MD5.
  • fechaDisponibilidad: Fecha desde la que el fichero está disponible para su descarga, se usará el formato especificado en: RFC-3339 http://tools.ietf.org/html/rfc3339#section-5.
  • fechaCaducidad: Fecha a partir de la que no está disponible el fichero para descargar.
  • uriDescargas: URI completa de descarga del fichero.
  • descripción: parámetro opcional. 

 

Ejemplo respuesta

 

[
    {          
                               "uuid": "29326088-ea6d-11e4-b02c-1681e6b88ec1",
                               "idProcedimiento": "22",
                               "nifEmpresa": "258",
                               "numeroBytes": "58457888",
                               "tipoFichero": "SGDA-EXPORT",
                               "estado":"DESCARGADO",
                               "mime": "text/xml",
                               "nombre": "sgda-export-2015-04.xml",
                               "hash":"0aa1ea9a5a04b78d4581dd6d17742627",
                               "fechaDisponibilidad": "2015-04-20 22:42:21",
                               "fechaCaducidad": "2015-05-20 22:42:21",
                               "uriDescarga": "https://api.cnmc.gob.es/ficheros/v1/descarga/9e6ec1e5b08a4eb1897f51b382320821",
                               "descripción":"fichero salida SGDA"
    },
                {...}
]

 


 

Errores:
  • Sin etiquetas