getSubscriptionUsageAlertGroups()

SubscriptionUsageAlertGroups getSubscriptionUsageAlertGroups(string usn)

This method returns information about the current state of each usage alert group associated with a subscription. Use this method to retrieve and display information about a subscription's usage alert groups.

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

Parameters

usn
Format: string
Purpose: Specifies the subscription associated with the usage alert groups.

Results

This method returns a SubscriptionUsageAlertGroups XML document that lists information about the current state of the subscription's usage alert groups, 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 SubscriptionUsageAlertGroups XML document

This example shows a SubscriptionUsageAlertGroups document for a subscription with a single usage alert group for mobile data usage. The subscription has exceeded the usage alert group limit for the current rating period.

<SubscriptionUsageAlertGroups xmlns="http://xml.inomial.com/smile/2.xsd">
  <SubscriptionUsageAlertGroup>
    <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>
</SubscriptionUsageAlertGroups>

Faults

NoSuchItemException


This fault is returned when the subscription does not exist.

Java client syntax

java -cp build/smilewsv2-client.jar [options] com.inomial.smile.client.v2.examples.GetSubscriptionUsageAlertGroups usn
usn
Purpose: Specifies the subscription associated with the usage alert groups.
Note: For more information about the Java client and the options it accepts, see Java client syntax.