These calls makes a request to retrieve information about balance templates, balance
classes, and balance thresholds in the pricing database.
REST Example
Table 1. Request to Query a Specific Balance
| URL |
GET http://host:port/rsgateway/data/v3/pricing/balance/21177
|
| Request XML |
None |
| Response |
<MtxResponsePricingBalance>
<BalanceInfo>
<MtxPricingBalanceDetailInfo>
<Category>3</Category>
<Precision>3</Precision>
<QuantityUnit>hours</QuantityUnit>
<IsPeriodic>true</IsPeriodic>
<Period>4</Period>
<IntervalCount>4</IntervalCount>
<IsOnDemand>false</IsOnDemand>
<IsRenewable>false</IsRenewable>
<IsPrepaid>false</IsPrepaid>
<IsAggregate>true</IsAggregate>
<StartType>Relative</StartType>
<EndType>Relative</EndType>
<EndRelativeUnit>5</EndRelativeUnit>
<EndRelativeCount>1</EndRelativeCount>
<CreateNotificationType>None</CreateNotificationType>
<PeriodInterval>1</PeriodInterval>
<MeterQuantity>Usage</MeterQuantity>
<ServiceTypeId>0</ServiceTypeId>
<MeterBalanceClassId>0</MeterBalanceClassId>
<MeterBalanceId>0</MeterBalanceId>
<IsTurnstile>false</IsTurnstile>
<PerBalanceInstanceMeter>false</PerBalanceInstanceMeter>
<ChargeType>Remaining</ChargeType>
<RatingUsageQuantityMeter>true</RatingUsageQuantityMeter>
<UsageQuantityType>actual duration</UsageQuantityType>
<EndTimeAdjustType>Allow</EndTimeAdjustType>
<Priority>0</Priority>
<InstanceCreatePolicy>1</InstanceCreatePolicy>
<IsMainBalance>false</IsMainBalance>
<IsCost>false</IsCost>
<IsActualCurrency>false</IsActualCurrency>
<IsDeviceSpecific>false</IsDeviceSpecific>
<BalanceId>21177</BalanceId>
<Name>Duration Meter (Hours) - Device Type + Weekend</Name>
<ClassId>0</ClassId>
<ClassName>meter</ClassName>
</MtxPricingBalanceDetailInfo>
</BalanceInfo>
<RouteId>1</RouteId>
<Result>0</Result>
<ResultText>OK</ResultText>
<ResultType>GET</ResultType>
</MtxResponsePricingBalance>
|
