Descarga
Consultar estado carga
Descripción
Permite consultar el estado de una carga.
Estructura de la URL
https://api.cnmc.gob.es/carga/v1/consultar_estado_carga/<uuidCarga>
Petición
Esta petición se debe enviar utilizando el método HTTP GET.
Este método no tiene ningún documento JSON asociado en el cuerpo, sino que el identificador de la carga se debe incluir en la URI de la petición.
Ejemplo Petición
https://api.cnmc.gob.es/carga/v1/consultar_estado_carga/550e8400-e29b-41d4-a716-446655440000
Respuesta
El cuerpo de la respuesta contendrá un documento JSON que contendrá un estado descrito en: Estados de una carga y la información adicional necesaria, en caso de haber sido rechazada:
- estado: estado de la carga, valores posibles: Estados de una carga
- registrosProcesados: parámetro opcional, con el número de entradas recibidas por el procesador de la carga
- registrosErrores: parámetro opcional, informa del número de entradas erróneas detectadas
- numeroRegistroGeneral: parámetro opcional, informa del identificador del registro de entrada de la carga en el registro general de la CNMC
- posicionEnColaCargas: en caso de que la carga esté en estado CONFIRMADA se rellena con la posición ordinal en dicha cola
- justificante: fichero de justificante de presentación de los ficheros remitidos en la carga
- uuidUpload. Identificación del fichero del justificante.
- url. URL de descarga del fichero del justificante
- longitudBytes. Con el tamaño del fichero en bytes
- mensajeError: En caso de que exista un error general en el tratamiento del fichero se incluirá en este atributo
- errores: parámetro opcional. Lista de información de los errores asociados a los ficheros correspondientes a una carga:
- uuidUpload. Identificación del fichero subido, sobre el que se listan los errores.
- url. URL de descarga del fichero de descripción de los errores
- longitudBytes. Con el tamaño del fichero de errores en bytes
Ejemplo documento JSON Respuesta
1 2 3 4 5 6 7 8 9 10 11 12 |
|
Descargar
Descripción
Descarga un fichero identificado por su identificador de descarga, NO equivale al identificador de ficheros de subida. Para obtener estos identificadores hay que utilizar los métodos de consulta consultar o listar_pendientes.
Se accederá a este servicio por https sin autenticación explícita, con el sólo conocimiento del enlace, por lo tanto los enlaces tienen una validez finita que puede consultarse en los métodos anteriores.
Estructura de la url
https://api.cnmc.gob.es/ficheros/v1/descarga/<id> |
Petición
Esta petición se debe enviar utilizando el método HTTP GET. Esta petición aceptará http byte-range para gestión de descargas de grandes ficheros.
El parámetro:
- id: identificador del fichero que queremos descargar, obtenido de otro método de consulta
Respuesta
Retorna como BodyResponse los bytes del fichero solicitado.
Errores
| Status | Title | Detail |
| 404 | No existe el fichero |
Listar pendientes
Descripción
Consulta de ficheros pendientes de descarga, es decir en estado DISPONIBLE.
Estructura de la url
https://api.cnmc.gob.es/ficheros/v1/listar_pendientes/<idProcedimiento>/<idEmpresa> |
Petición
Esta petición recibirá los parámetros codificados en la URL.
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
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.
- 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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
|