Método para descargar archivos adjuntos (DownloadDocumentAttachments)
Este método permite descargar los archivos adjuntos de un documento utilizando el servicio GET DownloadDocumentAttachments.
Por medio de este método, se obtienen los archivos adjuntos codificados en base 64 del documento consultado. El método recupera todos los archivos adjuntos.
Para conectarse a esta funcionalidad será necesario que ingrese la URL de acuerdo con el ambiente a consumir:
https://developers.gosocket.net/api/v1/File/DownloadDocumentAttachmentshttps://developers-sbx.gosocket.net/api/v1/File/DownloadDocumentAttachments¿Cómo funciona el método DownloadDocumentAttachments?
Para realizar la petición, el método tiene los siguientes parámetros:
| DownloadDocumentAttachments (request) | |||
|---|---|---|---|
| Parámetro | Tipo | Descripción | Valores permitidos |
| globalDocumentId* | String | Identificación de documento en Gosocket. | UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
*Requerido
Ejemplo de petición
Nota: Recuerde que antes de utilizar el método, debe realizar su autenticación dentro de la pestaña Authorization.
Al ser un método GET, utilizamos la pestaña Params en Postman para formar el query.
- Seleccione el tipo de método. En este caso, se debe seleccionar GET.
- Ingrese la URL del método.
- Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes.
- Presione Send.
Ejemplo de respuesta
Para interpretar correctamente la respuesta de la API, tome en cuenta los siguientes criterios:
| UploadDocumentAttachment (response) | |||
|---|---|---|---|
| Parámetro | Tipo | Descripción | Valores permitidos |
| Success | Boolean | Indica si la petición se ejecutó correctamente. | true: La petición se ejecutó sin errores. false: La petición ejecutó algún error. |
| GlobalDocumentId | String | Identificación de documento en Gosocket. | UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| CountryDocumentId | String | Identificador fiscal del documento a nivel país, conocido también como CUFE, CLAVE, UUID, ID | Ver tabla Estructura Country Document ID |
| OtherData { AttachmentId } | String | Identificación única para el archivo adjunto | UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| Messages | Array | Mensajes en caso de que haya errores. | |
| ResponseValue | String | Identificador de la respuesta del proceso. | UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| Code | String | Código de respuesta del proceso. | 200: La petición se ejecutó correctamente 500: la petición se ejecutó con errores 307: documento no encontrado |
| Description | String | Descripción del evento realizado. | Upload Success Error uploading File Document Not Found, System Automatic Retry in 1 minute |
| ErrorException | String | Descripción del error de tipo excepción. |
Puede verificar los adjuntos descargados con los que se muestran en la sección de adjuntos de la vista previa del documento.
Características del método DownloadDocumentAttachments
- Cuando no existe el Id del documento (globalDocumentId), el sistema responde un mensaje de error:
- Se pueden descargar los archivos tantas veces como sea necesario.
- Se descargarán todos los archivos adjuntos que tenga el documento.