Borrar un documento firmado

Última revisión: 30 Enero 2020

Se parte del siguiente caso de uso:

  • Propietario del proceso: API
  • Estado del documento: solo aplica a documentos firmados. Recuerda que puedes conocer el estado de un proceso y el estado de sus documentos con el servicio GET status.
Descripción
SERVICIO REMOVE SIGNED DOCUMENT
URL /api/v3/documents/remove/{messageCode}
SEGURIDAD SÍ
METHOD DELETE
CONTENT/APPLICATION URL PARAM
PARAMS messageCode: código del proceso de firma asociado al documento firmado que se desea eliminar. El API que lo consume debe ser propietario del proceso.
RESPONSE 200: HTTP status code 200/OK
RESPONSE BODY string con el messageCode de la operación

Códigos de error

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"
    }

Ejemplo:

   {
      "code": 91,
      "type": "Error",
      "message": "Sorry, this application is not allowed."
    }

El API ha usado unas credenciales que no son propietarias del proceso de firma asociado al documento que se pretende borrar.

    {
      "code": 236,
      "type": "Error",
      "message": "No es posible recuperar la información del mensaje solicitado",
      "trace": "com.viafirma.documents.api.model.exception.ApiException: no es posible recuperar la información del mensaje solicitado"
    }

El messageCode informado no existe o tiene un parámetro incorrecto.

results matching ""

    No results matching ""