Desactivar descarga de documento firmado

Última revisión: 21 Feb 2023

Este servicio te servirá para impedir que se pueda descargar el documento firmado asociado. Esto se usa cuando el documento firmado, por ejemplo, ha quedado invalidado por otro más reciente, y suele ocurrir que usuarios, al tener el permalink (CSV) impreso en el documento, intentan acceder a él. El estado del proceso NO se cambia, en su lugar se incluye en el detalle del proceso un nuevo atributo "disabled":true" que afecta solo a la descarga del documento.

• URL del método: /messages/disabled/
• Seguridad: sí, requiere autenticación. El API que consuma el servicio debe ser propietaria del proceso que desea ser desactivado.
• Método: PUT
• ContentType/Application: URL PARAM
• Params: (string) código del proceso asociado al documento que desea ser desactivado para su descarga

Response: Status code 200 OK

Response body:

{
    "code": "string",
    "disabled": true,
    "groupCode": "string",
    "..." : "..."
}

Respuestas alternativas en caso de fallo: se devolverán HTTP status codes distintos de 200/OK. En ese caso siempre se devolverá un JSON que describe el problema:

    {
      "code": "string",
      "type": "string",
      "message": "string",
      "trace" : "string"
    }

Por ejemplo:

    {
      "code": 263,
      "type": "Error",
      "message": "Solo pueden deshabilitarse las peticiones que se encuentren en un estado final"
    }

Descarga de documentos desactivados

El servicios de descarga de documentos firmados que han sido desactivado devolverán el siguiente error controlado.

GET {{endpoint}}/documents/download/signed/{{messageCode}}

{
    "code": 264,
    "type": "Error",
    "message": "The document is no longer available in the system, consults with the process owner",
    "trace": "87acbb91-8f46-452a-81ac-5457e26186b0"
}

Audit Trail de documentos desactivados

El audit trail de un documento desactivado no mostrará el botón de descarga de documentos como habitualmente lo hace.

Postman Collection

En este enlace puedes descargar una colección postman con este caso de uso:

Documents API Borrar y Anular Documentos