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:

PRODUCCIÓNhttps://developers.gosocket.net/api/v1/Document/ConfirmReceivedDocument

SANDBOXhttps://developers-sbx.gosocket.net/api/v1/Document/ConfirmReceivedDocument

Nota: 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

Datos ficticios

Los identificadores (globalDocumentId) de estos ejemplos son ficticios; reemplácelos por los valores reales obtenidos con el método GetReceivedDocument.

POST https://developers-sbx.gosocket.net/api/v1/Document/ConfirmReceivedDocument

Body (raw, JSON)

[
  "00000000-0000-0000-0000-000000000001",
  "00000000-0000-0000-0000-000000000002"
]

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.

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

---

Ejemplo de respuesta

{
  "ErrorMessage": null,
  "IsValid": true,
  "StatusCode": "200",
  "StatusDescription": null,
  "StatusMessage": "OK",
  "XmlBase64Bytes": null,
  "XmlBytes": null,
  "XmlDocumentKey": null,
  "XmlFileName": null,
  "ResponseType": null,
  "OtherData": {
      "00000000-0000-0000-0000-000000000001": "OK",
      "00000000-0000-0000-0000-000000000002": "OK"
  },
  "GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
  "Timestamp": null,
  "Response": null,
  "TaxDocument": null
}

Para interpretar correctamente la respuesta de la API, tome en cuenta los siguientes criterios:

ConfirmReceivedDocument (response)
Parámetro	Tipo	Descripción	Valores permitidos
ErrorMessage	String	Descripción del error en caso de que la petición se ejecute con errores o se detecte una excepción.
IsValid	Boolean	Indica si el proceso se ejecutó correctamente	true: El proceso se ejecutó correctamente. false: El proceso se ejecutó con error.
StatusCode	String	Código de respuesta o estado del proceso.	Ejemplo: 200: La petición se ejecutó correctamente 500: El proceso se ejecutó con error
StatusMessage	String	Descripción del estado de ejecución del proceso	Ejemplos: OK La información recibida no tiene el formato correcto
OtherData	Array	Lista de documentos a marcar como recibidos o descargados con su respectiva respuesta en el proceso	Ejemplos: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx: OK Document with GlobalDocumentId 00000000-0000-0000-0000-000000000001 not found. Document with GlobalDocumentId 00000000-0000-0000-0000-000000000002 downloaded
GlobalDocumentId	String	Identificación de documento en Gosocket.	00000000-0000-0000-0000-000000000000

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 00000000-0000-0000-0000-000000000002 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”.