getSubscriptionUsageAlertGroup()

SubscriptionUsageAlertGroup getSubscriptionUsageAlertGroup(string usn, string usageAlertGroupId)

This method returns information about the current state of a specified usage alert group. Use this method to retrieve and display information for a specific usage alert group for a subscription.

Note: You must enable pre-rating before you use this method.

Parameters

usn: Format: string; Purpose: Specifies the subscription associated with the usage alert group.
usageAlertGroupId: Format: string; Purpose: Specifies the ID of the usage alert group for which you want to retrieve information.

Results

This method returns a SubscriptionUsageAlertGroup XML document that lists information about the current state of the usage alert group, for example, the usage alert group limit, amount consumed in the period to date, alert thresholds and reset date.

Note: Smile updates the values in this XML document each time the pre-rating process runs.

There are no messages defined by this method.

Example: A returned SubscriptionUsageAlertGroup XML document

This example shows a SubscriptionUsageAlertGroup document for the Mobile Data Usage usage alert group. The subscription has exceeded the usage alert group limit for the current rating period.

<SubscriptionUsageAlertGroup xmlns="http://xml.inomial.com/smile/2.xsd">
  <UsageAlertGroup>
    <usageAlertGroupID>3</usageAlertGroupID>
    <company>1</company>
    <name>Mobile Data Usage</name>
    <alertThresholds>
      <alertThreshold>50</alertThreshold>
      <alertThreshold>80</alertThreshold>
      <alertThreshold>100</alertThreshold>
    </alertThresholds>
  </UsageAlertGroup>
  <periodEnd>2012-08-31+09:30</periodEnd>
  <limit>1000000</limit>
  <currentUse>211929000</currentUse>
  <currentThreshold>100</currentThreshold>
</SubscriptionUsageAlertGroup>

Faults

NoSuchItemException

This fault is returned when the subscription or usage alert group does not exist.

Java client syntax

java -cp build/smilewsv2-client.jar [options] com.inomial.smile.client.v2.examples.GetSubscriptionUsageAlertGroup usn usageAlertGroupId

usn: Purpose: Specifies the subscription associated with the usage alert group.
usageAlertGroupId: Purpose: Specifies the ID of the usage alert group for which you want to retrieve information.

Note: For more information about the Java client and the options it accepts, see Java client syntax.