Método para descargar el JSON (DownloadDocumentJson)
Este método permite descargar el archivo XML de un documento utilizando el servicio GET DownloadDocumentJson.
Por medio de este método, se obtiene el archivo JSON codificado en base 64 del documento consultado.
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/DownloadDocumentJsonhttps://developers-sbx.gosocket.net/api/v1/File/DownloadDocumentJson¿Cómo funciona el método DownloadDocumentJson?
Para realizar la petición, el método tiene los siguientes parámetros:
| DownloadDocumentJson (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 |
| Type* | String | Tipo de Json a descargar. En la respuesta se mostrará el tipo definido. | default: descarga el Json del documento. |
*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:
| DownloadDocumentJson (response) | |||
|---|---|---|---|
| Parámetro | Tipo | Descripción | Valores permitidos |
| Name | String | Nombre del archivo Json descargado | globalDocumentId.json |
| Description | String | Descripción del evento realizado. | JsonContent for paramétro_type GlobalDocumentId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| Base64Content | String | Archivo Json codificado en base 64 | |
| TimeStamp | String | Fecha y hora de creación del documento | aaaa-mm-ddThh:mm:ss |
| Type | String | Tipo de archivo | “json” |
Una vez que se decodificó la respuesta, se mostrará el contenido del documento en el lenguaje de la decodificación.
