Cancelar un Lote

Actualizado: 05-sep-2023

Método que cancela un lote a partir de su operationId, y podrá usar cuando el integrador decida abortar el proceso, por ejemplo, cuando no hay podido añadir todos los elementos deseados al lote por no haber superado algunas de las validaciones previstas.

Un lote de igual forma podrá ser cancelado por el usuario final, cerrando Viafirma Desktop.

Request

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

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.

Response

Response Code 200 OK

{
    "message": "string"
}

Donde:

• message: (string) valdrá "ok" si la cancelación se realizó correctamente.

Ejemplo:

{
    "message": "ok"
}

Respuestas Error

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

Lote no encontrado

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.