Saltar al contenido principal

Consultar paquetes de documentos

Este método permite consultar los paquetes de documentos asociados a un sistema integrado, identificado mediante el parámetro GuidIntegratedSystem. La respuesta incluye el socio de negocio relacionado, las cantidades contratadas y consumidas, las fechas de vigencia, el estado y los límites de consumo por tipo de servicio.

GET https://micro.conexusit.com/corp/demo/api/Service.svc/ViewDocumentPackage/{guidIntegratedSystem}

Endpoint​

DatoValor
Método HTTPGET
OperaciónViewDocumentPackage

Parámetros de entrada​

ParámetroTipoObligatorioDescripción
GuidIntegratedSystemstringSíIdentificador único del sistema integrado cuyos paquetes se desean consultar.

Ejemplo de solicitud​

Ambiente: demostración.

GET https://micro.conexusit.com/corp/demo/api/Service.svc/ViewDocumentPackage/e17dee4de2a14f03b4f18cda698e263f

Consultar paquetes de documentos en el ambiente de demostración

Ejemplo de solicitud a ViewDocumentPackage

Estructura de la respuesta​

CampoDescripción
StatusEstado del resultado de la consulta.
StatusDetailsInformación adicional sobre el resultado de la operación o los posibles errores.
DocumentPackagesLista de paquetes de documentos asociados al sistema integrado. Ver DocumentPackageType.

Cada paquete incluye la suscripción relacionada (SuscripcionType) y los límites por servicio (DocumentPackageLimitType), identificados con los códigos de tipo de servicio.

Consideraciones importantes​

  • TotalQuantity indica el cupo total configurado; ConsumedQuantity, el consumo registrado, y RemainingQuantity, el saldo disponible.
  • StartDate y EndDate permiten identificar el período de vigencia configurado.
  • Los valores de Status deben interpretarse de acuerdo con las reglas y los estados definidos por el servicio.