Saltar al contenido principal

Consultar suscripciones

Este método permite consultar las suscripciones registradas para un emisor a partir de su identificador único (GuidEmpresa). La respuesta contiene las cantidades contratadas y consumidas, el saldo disponible, las fechas de vigencia y el estado de cada suscripción.

GET https://micro.conexusit.com/corp/demo/api/Service.svc/ConsultarSuscripcion/{guidEmpresa}

Endpoint​

DatoValor
Método HTTPGET
OperaciónConsultarSuscripcion

Parámetros de entrada​

ParámetroTipoObligatorioDescripción
GuidEmpresastringSíIdentificador único de la empresa cuyas suscripciones se desean consultar.

Ejemplo de solicitud​

Ambiente: demostración.

GET https://micro.conexusit.com/corp/demo/api/Service.svc/ConsultarSuscripcion/e144e070dffb4b90a0f93bb192b0ea30

Consultar suscripciones en el ambiente de demostración

Ejemplo de solicitud a ConsultarSuscripcion

Estructura de la respuesta​

CampoDescripción
EstadoEstado del resultado de la consulta.
DetalleEstadoInformación adicional sobre el resultado de la operación o los posibles errores.
SuscripcionesLista de suscripciones asociadas al emisor. Ver SuscripcionType.

Cada suscripción incluye su paquete de documentos (DocumentPackageType), con los límites por servicio (DocumentPackageLimitType) y sus 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.