UsagePool

Version: 1.33

UsagePool represents a Usage Allocation Pool. UsagePool is an optional entity. You create Usage Allocation pools in the ____ module in Gotransverse. You can query and update UsagePools through the API.

Available commands:

deactivateUsagePool, activateUsagePool, addServiceToUsagePool, addUsagePoolToBillingAccount.

Parameters

Elements

Element Name	Query Key	Element Type	Field Length	Required to Create	Description
queryScope		QueryScope	- -	N	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	System generated unique identity number assigned to the Usage Pool.
uom	N	usageDurationUOM		Y	Unit of measure used to measure usage in this pool.
name	N	String	255	Y	Name of this usage allocation pool.
billingAccount	Y	billingAccount		N	Billing Account
usagePoolPeriods	N	usagePoolPeriods		N
description	N	String	255	N	Description for this usage allocation pool.
status	Y	UsagePoolStatus		Y	- ACTIVE - DRAFT - DEACTIVATED
applicabilityLevel	Y	UsagePoolApplicabilityLevel		Y	Is this usage allowance pool applied to an account hierarchy or to individual accounts? - ACCOUNT - ACCOUNT HIERARCHY

Querying UsagePool

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

Query for all UsagePools

Query to Use	Query for	Returns
SimpleDataQuery	UsagePool	Complete information for all of your usage allocation pools.

To retrieve paged results, use UsagePools.

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

UsagePool

Query Key	Value	Definition
eid	Long	The eid of the usage pool.
name	String	The name of the usage pool.
serviceEid	Long	The eid of the service included in the usage pool.
billingAccountEid	Long	Billing Account eid associated

name, eid, serviceEid, validFrom, billingAccountEid.

Do Not Know Query Key Information

If you do not know the entity Name's eid,or other query keys, or you want to see all Billing Accounts (increments of 50):

Query to Use

Query to Use	Query for	Returns
SimpleDataQuery	UsagePool	List of all of your Entity Name.

REST Endpoints

Commands include:

Commands Include

GET	https://tract-qa2.gotransverse.com/t/s/r/1.32/usagePools/<eid>
PUT	https://tract-qa2.gotransverse.com/t/s/r/1.32/usagePools/<eid>

Sample Requests and Responses

SOAP

SOAP Example Query and Response

The following SOAP example is a query of UsagePool:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_27/service" xmlns:dom="http://www.tractbilling.com/billing/1_27/domain">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:query>
         <!--Optional:-->
         <ser:queryRequest >
           <dom:simpleDataQuery >
               <dom:type>UsagePool</dom:type>
<parameter parameter="eid" parameterValue="1"/>
               <!--Zero or more repetitions:-->
               
            </dom:simpleDataQuery>
         </ser:queryRequest>
      </ser:query>
   </soapenv:Body>
</soapenv:Envelope>        

REST

UsagePool

The following example is the REST query for a usage allowance pool with an eid of "1"

GET https://my.tractbilling.com/t/s/r/1.33/UsagePools/1