Estado del Lote

Actualizado: 05-sep-2023

Método que devuelve el estado de un lote a partir de un operationId.

Request

• Método: GET
• Seguridad: Basic Auth
• Servicio: /api/rest/services/operation/finished/{operationId}

Response

Response Code 200 OK

{
    "operationId": "string",
    "isFinished": false,
    "isCancelled": false,
    "isDownloaded": false,
    "isInitialized": false,
    "hasErrors": false,
    "isSignature": true
}

Donde:

• operationId: (string) operationId asociado al lote consultado.
• isFinished: (boolean) proceso de firma finalizado, estado que permite consultar identificadores individuales de firma para su descarga.
• isCancelled: (boolean) proceso cancelado por el usuario final.
• isDownloaded: (boolean) viafirma desktop ha obtenido los documentos asociados al lote.
• isInitialized: (boolean) viafirma desktop ya ha comenzado a procesar documentos.
• hasErrors: (boolean) el proceso ha registrado errores durante el proceso de firma.
• isSignature: (boolean) en procesos de firma en lote siempre devolverá true.

Ejemplo:

{
    "operationId": "1660813392255ZRMJQORR",
    "isFinished": false,
    "isCancelled": false,
    "isDownloaded": false,
    "isInitialized": false,
    "hasErrors": false,
    "isSignature": true
}

Respuestas Error

Los errores controlados durante la finalización de un lote podrán ser los siguientes:

Lote ya finalizado

Response Code 404 Not Found

{
    "message": "No operation data found with operationId: <operationId>"
}

Para cualquier otro no controlado se devolverá un Response Code 500 Server Error.