Sample XML Payloads for Events in the Product Class

Last updated
Save as PDF

Sample Payload 1: New Plan Creation Event
1. Notes
Sample Payload 2: Service Modification Event
1. Notes
General Observations

Sample Payload 1: New Plan Creation Event

This payload represents a notification triggered by the creation of a new product plan, including basic plan details and descriptors.

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
    <request>
        <version>2.0</version>
        <sender>A</sender>
        <transaction_id>98765432</transaction_id>
        <action>A</action>
        <class>P</class>
        <auth_key>productkey123</auth_key>
    </request>
    <object_category>Plan</object_category>
    <object_action>A</object_action>
    <object_fields>
        <object_no>10001</object_no>
        <object_client_def_id>PLAN-001</object_client_def_id>
        <object_descriptors>
            <object_locale_descriptors>
                <locale_name>English</locale_name>
                <locale_no>1</locale_no>
                <object_name>Premium Subscription Plan</object_name>
                <object_description>Monthly premium subscription with full access</object_description>
            </object_locale_descriptors>
        </object_descriptors>
        <object_status>Active</object_status>
        <object_type>Recurring</object_type>
        <product_fields>
            <field_name>Billing Interval</field_name>
            <value_text>Monthly</value_text>
            <field_name>Price</field_name>
            <value_text>49.99</value_text>
        </product_fields>
    </object_fields>
    <event_data>
        <event_no>1201</event_no>
    </event_data>
</apf2doc>

Notes

The <action> and <object_action> are set to "A" for "add," indicating a new plan creation.
The class is "P" to identify this as a "Product" event.
The <object_category> is "Plan," specifying the type of product.
The <object_fields> section includes a unique <object_no>, a client-defined ID, and descriptive fields in <object_descriptors> and <product_fields>.
The <event_data> includes a hypothetical event number (1201), which could correspond to "Plan Created."

Sample Payload 2: Service Modification Event

This payload represents a notification triggered by a modification to an existing service (e.g., updating its description or status), with minimal descriptors.

<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
    <request>
        <version>2.0</version>
        <sender>A</sender>
        <transaction_id>98765433</transaction_id>
        <action>M</action>
        <class>P</class>
    </request>
    <object_category>Service</object_category>
    <object_action>M</object_action>
    <object_fields>
        <object_no>20001</object_no>
        <object_client_def_id>SVC-001</object_client_def_id>
        <object_descriptors>
            <object_locale_descriptors>
                <locale_name>English</locale_name>
                <locale_no>1</locale_no>
                <object_name>Cloud Storage Service</object_name>
                <object_description>Updated: 1TB cloud storage with encryption</object_description>
            </object_locale_descriptors>
        </object_descriptors>
        <object_status>Active</object_status>
        <object_type>One-Time</object_type>
        <product_fields>
            <field_name>Storage Capacity</field_name>
            <value_text>1TB</value_text>
        </product_fields>
    </object_fields>
    <event_data>
        <event_no>1202</event_no>
    </event_data>
</apf2doc>

Notes

The <action> and <object_action> are set to "M" for "modify," indicating an update to an existing service.
The class remains "P" for this event class.
The <object_category> is "Service," specifying the type of product being modified.
The <object_fields> section includes updated details (e.g., a revised description), with <product_fields> showing a specific attribute (storage capacity).
The <event_data> includes a hypothetical event number (1202), which could correspond to "Service Updated."

General Observations

Both payloads adhere to the XSD structure, with request, object_category, object_action, and object_fields as required elements, and event_data included to specify the triggering event.
The version is set to "2.0" as specified in the schema, and sender is "A" (Aria).
The <object_descriptors> and <product_fields> sections are optional but included to provide meaningful product details, with <object_locale_descriptors> offering localized descriptions.
The <event_data> uses a choice structure, here simplified to a single <event_no>, though multiple events could be listed if needed.
Values in <product_fields> (e.g., "49.99" or "1TB") are typed as strings per the XSD, reflecting flexibility in content.
The <auth_key> is included in the first example but omitted in the second to demonstrate its optional nature.