Web Services Reference for Oracle Billing Insight > Examples of Web Services > Examples of the Analytics Web Services >

Example of Getting the Unbilled Usage Plan for a Service

This example shows you how to use the analytics Web service to get the unbilled usage plan for a service.

Operation

Use the following operation to get the unbilled usage plan for a service:

GET /analytics/accounts/{accountId}/serviceAgreements/{serviceNumber}/unbilledByPlan

Sample URL

The following is a sample URL for this Web service example:

http://myhost.example.com:7017/rs/api/v2/analytics/accounts/BS1%7CAC-B2B-123361-01/serviceAgreements/555-444-3301/unbilledByPlan

XML Response

The following is an example of the XML response:

<report>
<productList>
<count>1</count>
<header></header>
<product>
<Product_Name>Business Circle 2500 - 555-444-3301</Product_Name>
</product>
</productList>
<planList>
<groupName>Data .25 / Kilobytes</groupName>
<count>1</count>
<header></header>
<plan>
<tariff_name>Data Downloaded</tariff_name>
<txn_count>3</txn_count>
<total_usage>64</total_usage>
<unit_name>Kilobytes</unit_name>
/analytics/BS1%7CAC-B2B-123361-01/service_agreements/555-444-3301
/unbilledDetails?parameter(TariffKey)=102&parameter(UsageTypeKey)=103
</plan>
</planList>
<planList>
<groupName>Message 2 Messages</groupName>
<count>3</count>
<header></header>
<plan>
<tariff_name>Text Message Received</tariff_name>
<txn_count>2</txn_count>
<total_usage>2</total_usage>
<unit_name>Messages</unit_name>
<link>/analytics/BS1%7CAC-B2B-123361-01/service_agreements/555-444-3301
/unbilledDetails?parameter(TariffKey)=4</link>
</plan>
<plan>
<tariff_name>Text Message Sent</tariff_name>
<txn_count>6</txn_count>
<total_usage>6</total_usage>
<unit_name>Messages</unit_name>
<link>/analytics/BS1%7CAC-B2B-123361-01/service_agreements/555-444-3301
/unbilledDetails?parameter(TariffKey)=3</link>
</plan>
<plan>
<tariff_name>Text Message Allowance</tariff_name>
<txn_count>2</txn_count>
<total_usage>2</total_usage>
<unit_name>Messages</unit_name>
<link>/analytics/BS1%7CAC-B2B-123361-01/service_agreements/555-444-3301
/unbilledDetails?parameter(TariffKey)=113</link>
</plan>
</planList>
<planList>
<groupName>Voice 2500 Minutes</groupName>
<count>4</count>
<header></header>
<plan>
<tariff_name>Roaming Verizon</tariff_name>
<txn_count>2</txn_count>
<total_usage>74</total_usage>
<unit_name>Minutes</unit_name>
<link>/analytics/BS1%7CAC-B2B-123361-01/service_agreements/555-444-3301
/unbilledDetails?parameter(TariffKey)=104</link>
</plan>
<plan>
<tariff_name>Family Circle Minutes</tariff_name>
<txn_count>10</txn_count>
<total_usage>152</total_usage>
<unit_name>Minutes</unit_name>
<link>/analytics/BS1%7CAC-B2B-123361-01/service_agreements/555-444-3301
/unbilledDetails?parameter(TariffKey)=1</link>
</plan>
<plan>
<tariff_name>Peak call incoming</tariff_name>
<txn_count>5</txn_count>
<total_usage>63</total_usage>
<unit_name>Minutes</unit_name>
<link>/analytics/BS1%7CAC-B2B-123361-01/service_agreements/555-444-3301
/unbilledDetails?parameter(TariffKey)=106</link>
</plan>
<plan>
<tariff_name>Peak call outgoing</tariff_name>
<txn_count>2</txn_count>
<total_usage>20</total_usage>
<unit_name>Minutes</unit_name>
<link>/analytics/BS1%7CAC-B2B-123361-01/service_agreements/555-444-3301
/unbilledDetails?parameter(TariffKey)=107</link>
</plan>
</planList><planList>
<groupName>Voice Unlimited Minutes</groupName>
<count>2</count>
<header></header>
<plan>
<tariff_name>Rollover Available</tariff_name>
<txn_count>3</txn_count>
<total_usage>145</total_usage>
<unit_name>Minutes</unit_name>
<link>/analytics/BS1%7CAC-B2B-123361-01/service_agreements/555-444-3301
/ unbilledDetails?parameter(TariffKey)=114</link>
</plan>
<plan>
<tariff_name>Night / Weekend Minutes</tariff_name>
<txn_count>3</txn_count>
<total_usage>69</total_usage>
<unit_name>Minutes</unit_name>
<link>/analytics/BS1%7CAC-B2B-123361-01/service_agreements/555-444-3301
/unbilledDetails?parameter(TariffKey)=2</link>
</plan>
</planList>
</report>