Descripción

Lista las cargas realizadas o en proceso, dependiendo del filtro establecido.

Estructura de la url
Petición

Esta petición se debe enviar utilizando los métodos HTTP POST o PUT.

El cuerpo de la petición contendrá un documento JSON con la siguiente estructura: 

  • nifPresentador: Parámetro opcional. Identificador que representa a la persona (física o jurídica) que presenta los ficheros.
  • nifEmpresa: Parámetro opcional. Identificador de la empresa a la que pertenecen los ficheros.
  • idProcedimiento: Parámetro opcional. Identificador del procedimiento al que están asociados los ficheros.
  • uuidCarga:  Parámetro opcional. Permite la consulta del detalle de una carga.
  • estado: Parámetro opcional. Los valores permitidos se pueden consultar en Estados de una carga. También se puede usar TODAS, que es el valor por defecto.

Ejemplo documento JSON Petición

 

{
    "nifEmpresa":"11111111H",
    "idProcedimiento": 12345,
    "estado":"INICIADA"
}

 

Respuesta

Como máximo, devolverá las últimas 1000 cargas. El cuerpo de la respuesta contendrá un documento JSON que contiene una lista y cada entrada de la lista contiene los siguientes datos: 

  • uuidCarga: Identificador de la carga.
  • nifPresentador: Documento de identificación del presentador.
  • nifEmpresa: Identificador de la empresa que presenta el procedimiento.
  • idProcedimiento: Código que identifica el procedimiento para el que se esta realizando la carga.
  • estado:{INICIADA|CANCELADA|CONFIRMADA|PROCESADA|RECHAZADA}.
  • fechaInicio: Fecha de creación e inicio de la carga. 
  • fechaFin: Fecha de finalización de subida de los ficheros y confirmación de la carga, en su caso.  
  • fechaFinProceso: Fecha de procesamiento interno de la carga, en su caso.  
  • fechaEfecto: Fecha de valor de la carga, en caso de que sea periódica, en su caso.
  • expiracionSegundos: Tiempo en segundos que restan a la sesión de carga, sólo en cuando esta esté en estado iniciada.
  • ficheros: Lista de ficheros asociados a la carga. Cada entrada en la lista contendrá los siguientes datos:
    • uuidUpload: Código que identifica la subida del fichero. 
    • fechaInicioUpload: Fecha de inicio de la subida del fichero. 
    • fechaFinUpload: Fecha de fin de la subida del fichero, en su caso. 
    • tipo: Código que identifica el tipo de fichero subido. Por ejemplo "SGDA", "SIPS_GAS_CONSUMOS", etc..
    • nombre: Nombre del fichero subido, si  se indicó al llamar al método /iniciar_subida_fichero.
    • hash: Resumen fichero  MD5. Si la subida del fichero no se ha completado, el HASH corresponderá  a la parte cargada.
    • numeroBytes: Tamaño del fichero en bytes, correspondiente a la parte ya subida.
    • estado: Estado en el que se encuentra el fichero: {CARGANDO,CARGADO,RECHAZADO,EN_PROCESO,PROCESADO_OK,PROCESADO_ERROR}. 

 

[
    {
        "uuidCarga":"550e8400-e29b-41d4-a716-446655440000",
        "nifPresentador":"12345678Z",
        "nifEmpresa":"11111111H",
        "idProcedimiento":126,
        "estado":"confirmada",
        "fechaInicio":"2015-03-01 09:23:33",
        "fechaFin":"2015-03-01  09:23:56",
        "fechaEfecto":"2015-03-01",
        "ficheros": [
            {
                "uuidUpload":"550e8400-e29b-41d4-a716-446655440418",
                "fechaInicioUpload":"2015-03-01 09:23:33",
                "fechaFinUpload":"2015-03-01 09:23:37",
                "tipo":"SIPS_ELECTRICIDAD_CONSUMOS",
                "nombre":"2015-03-01_sips.zip",
                "hash": "da39a3ee5e6b4b0d3255bfef95601890afd80709"
                "numeroBytes": 162340,
                "estado":"CARGADO"
            },{
                "uuidFichero":"550e8400-e29b-41d4-a716-446655442639",
                "fechaInicioUpload":"2015-03-01 09:23:39",             
                "fechaFinUpload":"2015-03-01 09:23:54",
                "tipoFichero":"CONSUMOS_ELECTRICIDAD",
                "nombreFichero":"2015-03-01_consumos.zip",
                "hash": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
                "numeroBytes": 212000,
                "estado":"RECHAZADO"
            }
        ]
    }  
]

 

 

 

Errores específicos

 

Status
Title
Detail
   
  • No labels