Sample XML Payloads for Events in the Account and Master Plan Instances Notifications Class

Use Case 1: New Notification for Account Creation

This payload represents a new notification event (action="A") triggered by Aria (sender="A") for an account creation message. Developers should note the mandatory fields in <request> (e.g., version, sender, transaction_id, action) and the class="N" designation, which identifies this as an account/MPI notification. The <account> section includes optional <master_plan_instances> to link the notification to specific plans, while <message> provides details about the notification itself. The <event_data> section ties the notification to a specific triggering event.

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
    <request>
        <version>3.1</version>
        <sender>A</sender>
        <transaction_id>2001</transaction_id>
        <action>A</action>
        <class>N</class>
        <auth_key>abc123</auth_key>
    </request>
    <account>
        <client_no>6001</client_no>
        <acct_no>789012</acct_no>
        <client_acct_id>ACCT-ABC-001</client_acct_id>
        <userid>jane.smith</userid>
        <master_plan_instances>
            <master_plan_instance>
                <master_plan_instance_no>10001</master_plan_instance_no>
                <client_plan_instance_id>MPI-ABC-001</client_plan_instance_id>
                <resp_level_cd>1</resp_level_cd>
                <in_event_scope_ind>1</in_event_scope_ind>
            </master_plan_instance>
        </master_plan_instances>
    </account>
    <message>
        <msg_id>5001</msg_id>
        <msg_class>E</msg_class>
        <msg_class_label>Email Notification</msg_class_label>
        <msg_creation_date>2025-03-25</msg_creation_date>
        <msg_sent_date>2025-03-25</msg_sent_date>
        <msg_subject>Welcome to Your New Account</msg_subject>
        <msg_recipient_email_address>jane.smith@example.com</msg_recipient_email_address>
    </message>
    <event_data>
        <event>
            <event_id>4001</event_id>
            <event_label>Account Created</event_label>
        </event>
    </event_data>
</apf2doc>

Use Case 2: Modified Notification with Sequential Statement ID

This payload illustrates a modification event (action="M") for a notification tied to a statement, including the <sequential_statement_id> element. Developers should focus on the <message> section, where <sequential_statement_id> provides a unique identifier for tracking statements sequentially, alongside optional fields like <statement_no> and <invoice_no> for additional context. The <master_plan_instances> section includes multiple instances, leveraging the maxOccurs="unbounded" capability, which is useful for notifications affecting multiple plans. Ensure the msg_id aligns with Aria's API for retrieving full message details.

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
    <request>
        <version>3.1</version>
        <sender>A</sender>
        <transaction_id>2002</transaction_id>
        <action>M</action>
        <class>N</class>
        <auth_key>xyz789</auth_key>
    </request>
    <account>
        <client_no>6001</client_no>
        <acct_no>789012</acct_no>
        <client_acct_id>ACCT-ABC-001</client_acct_id>
        <master_plan_instances>
            <master_plan_instance>
                <master_plan_instance_no>10001</master_plan_instance_no>
                <client_plan_instance_id>MPI-ABC-001</client_plan_instance_id>
                <resp_level_cd>1</resp_level_cd>
                <in_event_scope_ind>1</in_event_scope_ind>
            </master_plan_instance>
            <master_plan_instance>
                <master_plan_instance_no>10002</master_plan_instance_no>
                <client_plan_instance_id>MPI-ABC-002</client_plan_instance_id>
                <resp_level_cd>1</resp_level_cd>
                <in_event_scope_ind>1</in_event_scope_ind>
            </master_plan_instance>
        </master_plan_instances>
    </account>
    <message>
        <msg_id>5002</msg_id>
        <msg_class>I</msg_class>
        <msg_class_label>Statement/Invoice Message</msg_class_label>
        <msg_creation_date>2025-03-25</msg_creation_date>
        <msg_sent_date>2025-03-25</msg_sent_date>
        <msg_subject>Your Updated Billing Statement</msg_subject>
        <msg_recipient_email_address>jane.smith@example.com</msg_recipient_email_address>
        <statement_no>123456789</statement_no>
        <invoice_no>987654321</invoice_no>
        <sequential_statement_id>STMT-2025-03-001</sequential_statement_id>
    </message>
    <event_data>
        <event>
            <event_id>4002</event_id>
            <event_label>Statement Updated</event_label>
        </event>
    </event_data>
</apf2doc>

Use Case 3: Notification Deletion

This payload represents a deletion event (action="D") for a notification associated with an account. Developers should note that <message> still requires mandatory fields like msg_id, msg_class, msg_class_label, and msg_creation_date, even for deletion, to identify the notification being removed. The absence of <master_plan_instances> is valid since it’s optional (minOccurs="0"), but including it can provide context if the notification was tied to specific plans. The <event_data> section lists multiple events, showcasing the maxOccurs="unbounded" flexibility.

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
    <request>
        <version>3.1</version>
        <sender>A</sender>
        <transaction_id>2003</transaction_id>
        <action>D</action>
        <class>N</class>
        <auth_key>def456</auth_key>
    </request>
    <account>
        <client_no>6001</client_no>
        <acct_no>789012</acct_no>
        <client_acct_id>ACCT-ABC-001</client_acct_id>
        <senior_acct_no>789000</senior_acct_no>
    </account>
    <message>
        <msg_id>5003</msg_id>
        <msg_class>E</msg_class>
        <msg_class_label>Email Notification</msg_class_label>
        <msg_creation_date>2025-03-20</msg_creation_date>
        <msg_sent_date>2025-03-20</msg_sent_date>
        <msg_subject>Account Termination Notice</msg_subject>
        <msg_recipient_email_address>jane.smith@example.com</msg_recipient_email_address>
    </message>
    <event_data>
        <event>
            <event_id>4003</event_id>
            <event_label>Notification Cancelled</event_label>
        </event>
        <event>
            <event_id>4004</event_id>
            <event_label>Account Deactivated</event_label>
        </event>
    </event_data>
</apf2doc>

Key Notes for Developers

1. Schema Compliance: Ensure payloads match the XSD, with version="3.1" and class="N" for this event class. Required fields in <request>, <account>, and <message> must always be present.
2. Message Context: The <message> element’s msg_id can be used with Aria APIs (e.g., get_account_message) to fetch additional details, making it a critical identifier.
3. Master Plan Instances: The <master_plan_instances> section is optional but useful for linking notifications to specific plans. The in_event_scope_ind field indicates relevance to the triggering event.
4. Sequential Statement ID: When using <sequential_statement_id>, ensure it aligns with your statement tracking system, as it’s a client-defined identifier.
5. Event Flexibility: The <event_data> section supports multiple events, allowing detailed tracking of what triggered the notification.

These samples cover addition, modification with a sequential statement ID, and deletion scenarios, providing a robust starting point for working with the Accounts and Master Plan Instances Notifications Event Class.