UsageLookupTableEntry

Version: 1.33

Query UsageLookupTableEntry directly.

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 UsageLookupTableEntry:

Parameters

When you query a UsageLookupTableEntry, 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.
key	Y	String	255	The key in the UsageLookupTable for the UsageLookupTableEntry.
value	Y	String	255	The contents of the UsageLookupTable cell; the value.

Entity UsageLookupTableEntries

The entity UsageLookupTableEntries enables you to see multiple pages of the entity UsageLookupTableEntry.

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.
usageLookupTableEntry	UsageLookupTableEntry	- -	Shows the list of UsageLookupTableEntries

Information for the related entity of UsageLookupTableEntries:

Entity UsageLookupTableEntries

How to Query for a UsageLookupTableEntry

Query Key Information for SOAP and REST

Querying to see UsageLookupTableEntries needs to include one of the following parameters. If you do not know the value for the parameter, query separately to learn the value.

Query Key Parameters

UsageLookupTableEntry
Query Key	Value	Definition
eid	Long	The unique eid number for the UsageLookupTableEntry.
usageLookupTableEid	Long	The unique eid number for the UsageLookupTable.
key	String	The key table entry for this UsageLookupTableEntry.
value	String	The value of the UsageLookupTableEntry.

Query to Use
Query	Query for	Parameter Name and Value	Returns
SimpleDataQuery	UsageLookupTableEntry	<parameter name><parameter value>	List of your UsageLookupTableEntries for that parameter name and value.

SOAP Example Query and Response

In the following example SOAP query, the parameter of usageLookupTableEid was used. The usageLookupTable's EID value (in this example "12744"), was learned through a previous query on UsageLookupTable.

<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>UsageLookupTableEntry</type>
                    <parameter parameter="usageLookupTableEid" parameterValue="12744"/>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

The response shows that this UsageLookupTable has no UsageLookupTableEntries 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">
                <usageLookupTableEntries 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/usageLookupTableEntries/<eid>

GET https://my.tractbilling.com/t/s/r/1.33/usageLookupTableEntries?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/usageLookupTableEntries?usageLookupTableEid=<usageLookupTableEid>
GET https://my.tractbilling.com/t/s/r/1.33/usageLookupTableEntries?key=<key>
GET https://my.tractbilling.com/t/s/r/1.33/usageLookupTableEntries?value=<value>

REST Example Query and Response

In the following example REST query, the parameter of usageLookupTableEid was used. The usageLookupTable's EID value (in this example "12744"), was learned through a previous query on UsageLookupTable.

Query
GET https://my.tractbilling.com/t/s/r/1.33/usageLookupTableEntries?usageLookupTableEid=12744

The response shows that this UsageLookupTable has no UsageLookupTableEntries yet:

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