UsageLookupTable

Version: 1.32

Query UsageLookupTable directly for information, or query and use through FormulaOrderItemUsageRule, FormulaProductUsageRule, and FormulaServiceUsageRule.

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.

Parameters

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

Elements
Element Name	Query Key	Element Type	Field Length	Description
queryScope		QueryScope	- -	The depth of the query results, whether they are SHALLOW or DEEP. See QueryScope for details.
eid	Y	Long	System Generated	System generated unique identity number assigned to all entities in Gotransverse.
entries		UsageLookupTableEntry	- -	The entries in the Usage Lookup Table. See UsageLookupTableEntry for details.
name	Y	String	255	Name you have given the Usage Lookup Table.
status	Y	UsageLookupTableStatus	- -	The status of the Usage Lookup Table. See UsageLookupTableStatus for details.

Entity UsageLookupTables

The entity UsageLookupTables enables you to see multiple pages of the entity UsageLookupTable.

Elements
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.
usageLookupTable	UsageLookupTable	- -	Shows the list of UsageLookupTables

Information for the related entity of UsageLookupTables:

Entity UsageLookupTables

How to Query for a UsageLookupTable

Query Key Information for SOAP and REST

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

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

UsageLookupTable
Query Key	Value	Definition
eid	Long	The unique eid number for the UsageLookupTable.
name	String	The name of the Usage Lookup Table.
status		The status of the Usage Lookup Table.

Want To See All UsageLookupTables
Query	Query for	Returns
SimpleDataQuery	UsageLookupTable	List of your UsageLookupTables.

SOAP Example Query and Response

In the following SOAP example is a query for all UsageLookupTables.

<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>UsageLookupTable</type>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

The response shows that no UsageLookupTables are set up 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">
                <usageLookupTables 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/usageLookupTables
GET https://my.tractbilling.com/t/s/r/1.33/usageLookupTables?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/usageLookupTables?name=<name>
GET https://my.tractbilling.com/t/s/r/1.33/usageLookupTables?status=<status>

REST Example Query and Response

The following example is a Query in REST for UsageLookupTables.

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

The response shows that no UsageLookupTables are set up yet:

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