Finalizar Lote

Actualizado: 05-sep-2023

Con este método se finaliza el lote. Podrás hacerlo siempre y cuando el número de elementos agregados sea mayor que cero, igual o menor que el total de elementos definidos en la preparación.

Al finalizar el lote, el proceso de firma por parte del usuario final en Viafirma Desktop puede comenzar, mostrándose en ese momento la lista de certificados digitales disponibles.

Request

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

Response

Response Code 200 OK

{
    "current": 0,
    "total": 0
}

Donde:

• current: número de elmentos finalmente incluidos en el lote y disponibles para la firma.
• total: máximo número de elementos con el que fue creado el lote.

Ejemplo:

{
    "current": 10,
    "total": 10
}

El total se mostrará en la UI de Viafirma Desktop durante la fase de preparación:

Preparando Documentos N / total

mientras que el current se mostrará en la UI de Viafirma Desktop en la fase de firma, es decir, el lote ya ha sido finalizado, y se mostrará el número de elementos realmente incluido.

Firmando Documentos N / current

Respuestas Error

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

Lote ya finalizado

Response Code 400 Bad Request

{
    "current": 0,
    "total": 0,
    "error": "OperationId <operationId> was already prepared."
}

Lote sin elementos

Un lote puede cerrarse con un número inferior al previsto, pero no puede cerrarse sin elementos. Este error se da cuando ningún elemento pudo ser añadido al lote por no superar algunas de las validaciones previstas.

Response Code 400 Bad Request

{
    "current": 0,
    "total": 3,
    "error": "Total and added files are inconsistent"
}

Identificador de Lote no encontrado

Response Code 400 Bad Request

{
    "current": 0,
    "total": 0,
    "error": "OperationId <operationId> not found."
}

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