Sample XML Payloads for Events in the Usage Monitoring Class

Sample Payload 1: New Usage Summary Update Event

This payload represents a notification triggered by a new unbilled usage summary update, including account details and usage summary data.

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
    <request>
        <version>2.0</version>
        <sender>A</sender>
        <transaction_id>12345678</transaction_id>
        <action>A</action>
        <class>U</class>
        <auth_key>usagekey456</auth_key>
    </request>
    <account>
        <client_no>1001</client_no>
        <acct_no>50001</acct_no>
        <client_acct_id>ACCT-001</client_acct_id>
        <userid>johndoe</userid>
        <master_plan_instances>
            <master_plan_instance>
                <master_plan_instance_no>60001</master_plan_instance_no>
                <client_plan_instance_id>MPI-001</client_plan_instance_id>
                <resp_level_cd>1</resp_level_cd>
                <resp_plan_instance_no>60001</resp_plan_instance_no>
            </master_plan_instance>
        </master_plan_instances>
    </account>
    <unbilled_usage_summary_data>
        <currency_cd>usd</currency_cd>
        <currency_label_english>US Dollar</currency_label_english>
        <mtd_cli_threshold_amt>100.00</mtd_cli_threshold_amt>
        <mtd_acct_bal_true>75.50</mtd_acct_bal_true>
        <mtd_acct_bal_measured>75.50</mtd_acct_bal_measured>
        <mtd_cli_threshold_delta_true>-24.50</mtd_cli_threshold_delta_true>
        <mtd_cli_threshold_delta_meas>-24.50</mtd_cli_threshold_delta_meas>
        <ptd_cli_threshold_amt>200.00</ptd_cli_threshold_amt>
        <ptd_acct_bal_true>150.75</ptd_acct_bal_true>
        <ptd_acct_bal_measured>150.75</ptd_acct_bal_measured>
        <ptd_cli_threshold_delta_true>-49.25</ptd_cli_threshold_delta_true>
        <ptd_cli_threshold_delta_meas>-49.25</ptd_cli_threshold_delta_meas>
        <acct_unapp_svc_credit_bal>10.00</acct_unapp_svc_credit_bal>
        <acct_unapp_svc_credit_delta>140.75</acct_unapp_svc_credit_delta>
        <unbilled_usage_cli_th_adj_pct>75</unbilled_usage_cli_th_adj_pct>
    </unbilled_usage_summary_data>
    <event_data>
        <event>
            <event_id>1101</event_id>
            <event_label>Unbilled Usage Summary Updated</event_label>
        </event>
    </event_data>
</apf2doc>

Sample Payload 2: Modified Usage Threshold Crossing Event

This payload represents a notification triggered by a modification in usage monitoring, specifically when a usage threshold is crossed, including threshold details.

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
    <request>
        <version>2.0</version>
        <sender>A</sender>
        <transaction_id>12345679</transaction_id>
        <action>M</action>
        <class>U</class>
    </request>
    <account>
        <client_no>1001</client_no>
        <acct_no>50001</acct_no>
        <client_acct_id>ACCT-001</client_acct_id>
        <userid>johndoe</userid>
        <senior_acct_no>40001</senior_acct_no>
        <master_plan_instances>
            <master_plan_instance>
                <master_plan_instance_no>60001</master_plan_instance_no>
                <client_plan_instance_id>MPI-001</client_plan_instance_id>
                <resp_level_cd>1</resp_level_cd>
                <resp_plan_instance_no>60001</resp_plan_instance_no>
            </master_plan_instance>
        </master_plan_instances>
    </account>
    <unbilled_usage_summary_data>
        <currency_cd>usd</currency_cd>
        <currency_label_english>US Dollar</currency_label_english>
        <mtd_cli_threshold_amt>100.00</mtd_cli_threshold_amt>
        <mtd_acct_bal_true>105.25</mtd_acct_bal_true>
        <mtd_acct_bal_measured>105.25</mtd_acct_bal_measured>
        <mtd_cli_threshold_delta_true>5.25</mtd_cli_threshold_delta_true>
        <mtd_cli_threshold_delta_meas>5.25</mtd_cli_threshold_delta_meas>
    </unbilled_usage_summary_data>
    <usage_unit_threshold>
        <plan_no>101</plan_no>
        <usage_type>1</usage_type>
        <notice_dest_type>Email</notice_dest_type>
        <notice_balance_type>Measured</notice_balance_type>
        <threshold_units>1000</threshold_units>
        <usage_bal_true>1025.5</usage_bal_true>
        <usage_bal_measured>1025.5</usage_bal_measured>
        <threshold_levels>
            <threshold_level>
                <level_no>1</level_no>
                <threshold_value>1000</threshold_value>
                <delta_amt_true>25.5</delta_amt_true>
                <delta_amt_measured>25.5</delta_amt_measured>
            </threshold_level>
        </threshold_levels>
    </usage_unit_threshold>
    <event_data>
        <event>
            <event_id>1102</event_id>
            <event_label>Usage Threshold Exceeded</event_label>
        </event>
    </event_data>
</apf2doc>

General Observations

• Both payloads conform to the XSD structure, with <request>, <account>, and <unbilled_usage_summary_data> as required elements, and <usage_unit_threshold> and <event_data> included as optional but contextually relevant.
• The version is set to "2.0" as per the schema, and sender is "A" (Aria).
• The <unbilled_usage_summary_data> provides monetary usage metrics, while <usage_unit_threshold> focuses on unit-based thresholds (e.g., MB, minutes), reflecting different monitoring aspects.
• Numeric values (e.g., <mtd_acct_bal_true>, <threshold_units>) are typed as decimals per the XSD, shown here with realistic precision (e.g., "75.50").
• The <event_data> includes a single event, though multiple events could be listed if applicable.
• The <auth_key> is included in the first example but omitted in the second to demonstrate its optional nature.