Método para marcar documentos como recibidos (ConfirmReceivedDocument)
Este método permite marcar los documentos como recibidos para la empresa utilizando el servicio POST ConfirmReceivedDocument.
Por medio de este método, se permite marcar uno o varios de los documentos recibidos para la empresa, utilizando el ID único (globalDocumentId) de cada documento recibido con el método GetReceivedDocument.
Para conectarse a esta funcionalidad será necesario que ingrese la URL de acuerdo con el ambiente a consumir:
https://developers.gosocket.net/api/v1/Document/ConfirmReceivedDocumenthttps://developers-sbx.gosocket.net/api/v1/Document/ConfirmReceivedDocumentNota: Este método lo debe activar a través de su consultor asignado.
¿Cómo funciona el método ConfirmReceivedDocument?
Para realizar la petición, el método tiene un parámetro de tipo arreglo en el cual el parámetro solo contiene el arreglo de los documentos a confirmar sin especificar un nombre para el parámetro como se muestra a continuación:
| ConfirmReceivedDocument (request) | ||
|---|---|---|
| Tipo | Descripción | Velores ejemplo |
| Array | Lista de Ids (globalDocumentId) de los documentos que se desean marcar como recibidos o descargados | Puede ser 1 o n [ “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”, “yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy” ] |
Ejemplo de petición
Nota: Recuerde que antes de utilizar el método, debe realizar su autenticación dentro de la pestaña Authorization.
Para este método utilizamos la pestaña Body, seleccionamos raw y verificamos o seleccionamos JSON de Postman.
- Seleccione el tipo de método. En este caso, se debe seleccionar POST.
- Ingrese la URL del método.
- Ingrese el parámetro 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:
Nota: Los parámetros de respuesta que no están especificados en el cuadro, siempre salen vacíos o nulos debido a que es un proceso en lote o masivo.
Características del método ConfirmReceivedDocument
Se permite marcar como recibidos 1 o n documentos.
- Este método debe ser utilizado junto con el método GetReceivedDocument, con el fin de obtener los Ids (globalDocumentId) de los documentos a marcar como recibidos.
- Cuando se realiza la petición para un documento válido, en el OtherData la respuesta al proceso del documento será “OK”.
- Cuando se realiza varias veces la petición al mismo documento, en el OtherData la respuesta al proceso del documento será: “Document with GlobalDocumentId 025eb8e4-9d79-59c6-a40b-87e1ad6ce320 downloaded.”.
- Cuando se realiza la petición con un Id que no existe, en el OtherData la respuesta al proceso del documento será: “Document with GlobalDocumentId 00000000-0000-0000-0000-000000000001 not found”.