GlobalUsageRule

Version: 1.33

GlobalUsageRule is queried and used through GlobalProductUsageRule, GlobalOrderItemUsageRule, and GlobalServiceUsageRule.

Usage Events are governed by Usage Rules. Usage Rules detect a condition within a Usage Event and evaluate whether that condition is true or false. If the Usage Rule evaluates the condition as "true," an action occurs that could lead to a Customer charge. If the Usage Rule evaluates as "false," no action is taken and the event that is being evaluated passes to the next Usage Rule for evaluation.

To evaluate an event in the correct order, Usage Rules must be in a hierarchical order that you determine and change as needed. The customized Usage Rules and the order in which they are listed make up the Rate Plan. Gotransverse has three types of Usage Rules:

  • Global Usage Rules -- complex Usage Rules that can be associated with, and used by any Product

  • Formula Usage Rules -- created as part of a Product definition and associated only with that Product, and uses equations and may use lookup tables

  • Match-All Usage Rules -- uses one of the following rates:

    • FlatUsageRate

    • PassThroughUsageRate - with the rate in the event

    • Table including RateTable and UsageLookupTable

Usage Rules process events using the amount of usage reported, applying conditions and predefined Rates to the usage, and adding the results to the Customer's Billing Account for invoicing.

Further Gotransverse API information for this entity of GlobalUsageRule:

Parameters

When you query a GlobalUsageRule, the following table provides information about the values returned from the query:

Elements
Element Name Query
Key		 Element
Type		 Field
Length		 Description

queryScope

QueryScope

 - -

Whether default query results are
overridden by QueryScope resulting
in SHALLOW or DEEP query results.
See QueryScope for details.

eid

Y

Long

System
Generated

System generated unique identity number
assigned to the GlobalUsageRule.

name

String

40

The name of the GlobalUsageRule.

status

Y

GlobalUsageRuleStatus

 - -

The status of the GlobalUsageRule.
See GlobalUsageRuleStatus.

Entity GlobalUsageRules

The entity GlobalUsageRules enables you to see multiple pages of the entity GlobalUsageRule.

GlobalUsageRule
Element Name Element
Type		 Field
Length		 Description

pageNumber

 

Integer

as needed

Shows the current page number.

pageSize

 

Integer

 

as needed

 

Shows the page size.

 

totalElements

 

Long

as needed

 

Shows the total number of items found.

elementCount

Integer

as needed

Shows the current count of the item
in the number of items that were found.

totalPages

 

Integer

as needed

Shows the total number of pages.

 

globalUsageRule

GlobalUsageRule

 - -

 

Shows the list of GlobalUsageRules.

How to Query for a GlobalUsageRule

Query Key Information for SOAP and REST

To query for all GlobalUsageRules, use the SimpleDataQuery with no parameters.

To query for more specific infomation, use the SimpleDataQuery with the parameter of one of the following Query Keys:

GlobalUsageRule
Query Key Value Definition

eid

Long

The unique eid number for the GlobalUsageRule.

isGlobal

Boolean

Is the GlobalUsageRule global (yes, true) or not (false)?

status

The status of the GlobalUsageRule
(refer to GlobalUsageRuleStatus).
ACTIVE, SUSPENDED, or DRAFT.

Want To See All GlobalUsageRules

To get a list of all GlobalUsageRules without knowing the EID

Query Query for Returns

SimpleDataQuery

GlobalUsageRule

List of your GlobalUsageRules.

SOAP Example Query and Response

The following SOAP example is a query for all GlobalUsageRules and shows the first 50 of them:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:query xmlns="http://www.tractbilling.com/billing/1_31/domain"xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:queryRequest>
                <simpleDataQuery startIndex="0" size="50">
                    <type>GlobalUsageRule</type>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

The response shows that there are no GlobalUsageRules yet. 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:queryResponse xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:return successful="true">
                <globalUsageRules pageNumber="1" pageSize="50" 
totalElements="0" elementCount="0" totalPages="0"/>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

REST Mount Point and Parameters

Query
GET https://my.tractbilling.com/t/s/r/1.33/globalUsageRules

GET https://my.tractbilling.com/t/s/r/1.33/globalUsageRules/<eid>
GET https://my.tractbilling.com/t/s/r/1.33/globalUsageRules?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/globalUsageRules?isGlobal=<isGlobal>
GET https://my.tractbilling.com/t/s/r/1.33/globalUsageRules?status=<status>

REST Example Query and Response

The following REST example is a query for all GlobalUsageRules and shows the first 50 of them:

Query
GET https://my.tractbilling.com/t/s/r/1.33/globalUsageRules

The response shows that there are no GlobalUsageRules yet.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<globalUsageRules  
   xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" 
   pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>