Saltar al contenido principal

Método para descargar un archivo adjunto específico (DownloadDocumentAttachment)

Este método permite descargar un archivo adjunto específico de un documento utilizando el servicio GET DownloadDocumentAttachment.

Por medio de este método, se obtiene el archivo adjunto especificado en los parámetros, codificado en base 64 del documento consultado. El método recupera el archivo adjunto especificado.

Para conectarse a esta funcionalidad será necesario que ingrese la URL de acuerdo con el ambiente a consumir:

PRODUCCIÓNhttps://developers.gosocket.net/api/v1/File/DownloadDocumentAttachment
SANDBOXhttps://developers-sbx.gosocket.net/api/v1/File/DownloadDocumentAttachment

¿Cómo funciona el método DownloadDocumentAttachment?​

Para realizar la petición, el método tiene los siguientes parámetros:

DownloadDocumentAttachment (request)
ParámetroTipoDescripciónValores permitidos
globalDocumentId*StringIdentificación de documento en Gosocket.UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
AttachmentId*StringIdentificación única del archivo adjunto (se obtiene con el método GetDocumentattachments)UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

*Requerido

Ejemplo de petición​

image-20240503-040214.png

Al ser un método GET, utilizamos la pestaña Params en Postman para formar el query.

  1. Seleccione el tipo de método. En este caso, se debe seleccionar GET.
  2. Ingrese la URL del método.
  3. Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes.
  4. Presione Send.

Ejemplo de respuesta​

image-20240503-040412.png

Para interpretar adecuadamente la respuesta de la API, tome en cuenta los siguientes parámetros:

DownloadDocumentAttachment (request)
ParámetroTipoDescripciónValores permitidos
globalDocumentId*StringIdentificación de documento en Gosocket.UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
AttachmentId*StringIdentificación única del archivo adjunto (se obtiene con el método GetDocumentAttachments)UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Características del método DownloadDocumentAttachment​

  • Cuando no existe el Id del documento (globalDocumentId), el sistema responde un mensaje de error:

    image-20240503-040610.png

  • Se pueden descargar los archivos tantas veces como sea necesario.

  • Se pueden descargar todos los archivos adjuntos que tenga el documento uno por uno.

  • Al momento de decodificar el archivo descargado se debe tener en cuenta que cada archivo viene con codificación sencilla, por lo tanto, es necesario decodificarlo solo una vez para poder ver el archivo.