aria-ux

(0 reviews)

postEvent

/event [POST]

This operation will send notifications to customer based on Aria Events that is subscribed by ESB . Event payload from Aria will have complete information related to notification. This information will be used to sent notification email messages or SMS to customer.

As of now this integration support for two eventIds (event_id - 744 & 901)

event_id - 744

resources/image-21830f49-9310-45ad-a03c-0b1469e0f9fe.png

event_id - 901

Process sequence diagram

resources/aria-ux-42635d0c-7e0a-4a18-a877-1d6bc5e5a99e.png

Uses Cases

The internal use cases to the method are defined.

Case	Description
1	Dunning Notification
2	Invoice Notification

URL

https://[localhost]:[port]/aria-ux/v1/{businessId}/event

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit.	Y

name	value	description	required
client_id	string	Client Id value for Client Id Enforcement policy. Environment Specific value	Y
client_secret	string	Client secret value for Client Id Enforcement policy. Environment Specific Value	Y
X-Correlation-ID	string	An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Minimum characters: 16 Maximum characters: 64	N

Request

744 Event Request:

curl --location 'https://nonprod.esb.cloud.lla.com/dev/aria-ux/aria-ux/v1/PR/event' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92cDD' \
--header 'Content-Type: application/xml' \
--header 'Authorization: Basic ZjI2OTYwNzgwMzIxNDUxYmIxODUwODk1Y2U1MDIzYzE6NDI0M2VmYzdmQjJFNEMzNThhOEVjMjMyOGM4MUNlZDI=' \
--data-raw '<apf2doc>
    <request>
        <version>3.3</version>
        <sender>A</sender>
        <transaction_id>322544891</transaction_id>
        <action>M</action>
        <class_name>A</class_name>
    </request>
    <acct_data>
        <client_no>3760769</client_no>
        <acct_no>36669641</acct_no>
        <client_acct_id>41000268-40000107</client_acct_id>
        <userid>21517653-21518857</userid>
        <password>$SH1$5000$8$6478788F7A25D246$32$D796A92DED94883CC1DB94D0122C3E3729EB64F188E5DA1530BD5FA2FAB70607</password>
        <status_cd>1</status_cd>
        <notify_method>13</notify_method>
        <currency>usd</currency>
        <test_acct>N</test_acct>
        <last_acct_comment>Email message of type "Dunning" with subject "FINAL NOTICE" created but not (or not yet) sent to account holder "peacockmediumrisk@gmail.com" on 6/13/2023 at 01:59:48</last_acct_comment>
    </acct_data>
    <acct_contact>
        <first_name>Medium Risk</first_name>
        <last_name>Dunning</last_name>
        <address1>126 Calle Aponte</address1>
        <city>San Juan</city>
        <state_prov>PR</state_prov>
        <postal_code>00911</postal_code>
        <country>US</country>
        <phone>17876041971</phone>
        <email>pooja-m.asangi@capgemini.com</email>
    </acct_contact>
    <notify_tmplt_group_data>
        <notify_tmplt_group>
            <notify_tmplt_group_id>LLA_PR_ENGLISH_NTG</notify_tmplt_group_id>
            <notify_tmplt_group_label>LLA Puerto Rico English NTG</notify_tmplt_group_label>
            <notify_tmplt_group_assign_lvl>ACCOUNT</notify_tmplt_group_assign_lvl>
        </notify_tmplt_group>
    </notify_tmplt_group_data>
    <master_plan_instance_data>
        <master_plan_instance>
            <master_plan_instance_no>49321146</master_plan_instance_no>
            <client_master_plan_instance_id>MPI-41000268-40000107</client_master_plan_instance_id>
            <plan_no>10429164</plan_no>
            <client_plan_id>Account_Master_Plan</client_plan_id>
            <plan_name>Account Master Plan</plan_name>
            <plan_activation_date>2023-06-06</plan_activation_date>
            <status_cd>1</status_cd>
            <resp_level_cd>1</resp_level_cd>
            <plan_units>1</plan_units>
            <billing_group_no>18340652</billing_group_no>
            <client_billing_group_id>21517653-21518857_BG</client_billing_group_id>
            <dunning_group_no>20391637</dunning_group_no>
            <client_dunning_group_id>21517653-21518857_DG</client_dunning_group_id>
            <dunning_state>1</dunning_state>
            <dunning_step>6</dunning_step>
            <dunning_step_description>Due Date Notice|PRE|PRE|PRE|PRE|ES</dunning_step_description>
            <mpi_billing_dates>
                <bill_day>7</bill_day>
                <created_date>2023-06-06</created_date>
                <next_bill_date>2023-07-07</next_bill_date>
                <last_bill_date>2023-06-07</last_bill_date>
                <recurring_bill_thru_date>2023-07-06</recurring_bill_thru_date>
                <usage_bill_thru_date>2023-06-06</usage_bill_thru_date>
                <plan_date>2023-06-06</plan_date>
                <status_date>2023-06-06</status_date>
                <next_dunning_date>2023-06-14</next_dunning_date>
            </mpi_billing_dates>
            <mpi_unit_instance_data>
                <mpi_unit_instance>
                    <plan_unit_inst_no>52994301</plan_unit_inst_no>
                    <client_plan_unit_inst_id>52994301</client_plan_unit_inst_id>
                    <plan_unit_inst_status>Active</plan_unit_inst_status>
                </mpi_unit_instance>
            </mpi_unit_instance_data>
            <supp_plan_instance_data>
                <supp_plan_instance>
                    <plan_instance_no>49321147</plan_instance_no>
                    <client_plan_instance_id>8027d000001pATeAAM</client_plan_instance_id>
                    <plan_no>10434801</plan_no>
                    <client_plan_id>PR_B2C_Unlimited_Your_Way</client_plan_id>
                    <plan_name>Liberty U-Pick Mobile</plan_name>
                    <plan_activation_date>2023-06-06</plan_activation_date>
                    <status_cd>1</status_cd>
                    <plan_units>1</plan_units>
                    <spi_billing_dates>
                        <bill_day>7</bill_day>
                        <next_bill_date>2023-07-07</next_bill_date>
                        <last_bill_date>2023-06-07</last_bill_date>
                        <recurring_bill_thru_date>2023-07-06</recurring_bill_thru_date>
                        <usage_bill_thru_date>2023-06-06</usage_bill_thru_date>
                    </spi_billing_dates>
                    <spi_unit_instance_data>
                        <spi_unit_instance>
                            <plan_unit_inst_no>52994302</plan_unit_inst_no>
                            <client_plan_unit_inst_id>52994302</client_plan_unit_inst_id>
                            <plan_unit_inst_status>Active</plan_unit_inst_status>
                        </spi_unit_instance>
                    </spi_unit_instance_data>
                    <spi_supp_fields_data>
                        <spi_supp_field>
                            <field_name>MSISDN</field_name>
                            <field_value>17874051530</field_value>
                        </spi_supp_field>
                        <spi_supp_field>
                            <field_name>User Name</field_name>
                            <field_value>Medium Risk,Dunning</field_value>
                        </spi_supp_field>
                        <spi_supp_field>
                            <field_name>Store ID</field_name>
                            <field_value>755</field_value>
                        </spi_supp_field>
                        <spi_supp_field>
                            <field_name>Device Type</field_name>
                            <field_value>Mobile Phone</field_value>
                        </spi_supp_field>
                    </spi_supp_fields_data>
                </supp_plan_instance>
            </supp_plan_instance_data>
        </master_plan_instance>
    </master_plan_instance_data>
    <event_data>
        <event>
            <event_id>744</event_id>
            <event_label>Account Master Plan Instance Dunning Degrade Date Changed</event_label>
        </event>
    </event_data>
</apf2doc>'

901 Event Request:

curl --location 'https://nonprod.esb.cloud.lla.com/dev/aria-ux/aria-ux/v1/PR/event' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92cDD' \
--header 'Content-Type: application/xml' \
--header 'Authorization: Basic ZjI2OTYwNzgwMzIxNDUxYmIxODUwODk1Y2U1MDIzYzE6NDI0M2VmYzdmQjJFNEMzNThhOEVjMjMyOGM4MUNlZDI=' \
--data-raw '<apf2doc>
    <request>
        <version>3.3</version>
        <sender>A</sender>
        <transaction_id>689108777</transaction_id>
        <action>M</action>
        <class>T</class>
    </request>
    <account>
        <client_no>5025549</client_no>
        <acct_no>33345845</acct_no>
        <client_acct_id>41000268-40000107</client_acct_id>
        <userid>DAVE2023050201</userid>
        <master_plan_instances>
            <master_plan_instance_data>
                <plan_instance_no>2267076</plan_instance_no>
                <client_plan_instance_id>2267076</client_plan_instance_id>
                <resp_level_cd>1</resp_level_cd>
            </master_plan_instance_data>
        </master_plan_instances>
    </account>
    <notify_tmplt_group_data>
        <notify_tmplt_group>
            <notify_tmplt_group_id>lla_pr_english_ntg</notify_tmplt_group_id>
            <notify_tmplt_group_label>LLA Puerto Rico English NTG</notify_tmplt_group_label>
            <notify_tmplt_group_assign_lvl>ACCOUNT</notify_tmplt_group_assign_lvl>
        </notify_tmplt_group>
    </notify_tmplt_group_data>
    <financial_transaction_groups>
        <financial_transaction_group>
            <object_type>Invoice</object_type>
            <object_no>1199243698</object_no>
            <billing_group_no>1014975</billing_group_no>
            <client_billing_group_id>1014975</client_billing_group_id>
            <total_amount>0</total_amount>
        </financial_transaction_group>
    </financial_transaction_groups>
    <financial_transactions>
        <financial_transaction>
            <financial_trans_id>-1</financial_trans_id>
            <financial_trans_granular_id>1199243698</financial_trans_granular_id>
            <financial_trans_type_no>0</financial_trans_type_no>
            <financial_trans_type_label>Invoice Created</financial_trans_type_label>
            <financial_trans_gl_type>D</financial_trans_gl_type>
            <financial_trans_date>2024-03-13 12: 40: 33</financial_trans_date>
            <financial_trans_amount>0</financial_trans_amount>
            <financial_trans_inv_type_cd>F</financial_trans_inv_type_cd>
        </financial_transaction>
    </financial_transactions>
    <posting_info>
        <posting_status_cd>1</posting_status_cd>
        <posting_user>System</posting_user>
        <posting_date>2024-03-13 12: 40: 38</posting_date>
    </posting_info>
    <event_data>
        <event>
            <event_id>901</event_id>
            <event_label>Invoice Created</event_label>
        </event>
    </event_data>
</apf2doc>'

Definitions

Each of the request parameters is detailed.

name	type	description	required
request	object	request	N
sender	string	Sender is Aria so value always "A"	Y
transaction_id	string	transaction_id	N
action	string	action	N
class_name	string	class_name	N
acct_data	object	acct_data	N
client_no	string	client_no	N
acct_no	string	acct_no	N
client_acct_id	string	client_acct_id	Y
userid	string	userid	N
password	string	password	N
status_cd	string	status_cd	N
notify_method	string	notify_method	N
currency	string	currency	N
test_acct	string	test_acct	N
last_acct_comment	string	last_acct_comment	N
acct_contact	object	acct_contact	N
first_name	string	first_name	N
last_name	string	last_name	N
company_name	string	company_name	N
address1	string	address1	N
city	string	city	N
state_prov	string	state_prov	N
postal_code	string	postal_code	N
country	string	country	N
phone	string	phone	N
email	string	email	N
notify_tmplt_group_data	object	notify_tmplt_group_data	N
notify_tmplt_group	object	notify_tmplt_group	N
notify_tmplt_group_assign_lvl	string	notify_tmplt_group_assign_lvl	N
notify_tmplt_group_id	string	notify_tmplt_group_id	Y*
notify_tmplt_group_label	string	notify_tmplt_group_label	N
master_plan_instance_data	object	master_plan_instance_data	N
master_plan_instance	object	master_plan_instance	N
master_plan_instance_no	string	master_plan_instance_no	N
client_master_plan_instance_id	string	client_master_plan_instance_id	Y
plan_no	string	plan_no	N
client_plan_id	string	client_plan_id	N
plan_name	string	plan_name	N
plan_activation_date	string	plan_activation_date	N
status_cd	string	status_cd	N
resp_level_cd	string	resp_level_cd	N
plan_units	string	plan_units	N
billing_group_no	string	billing_group_no	N
client_billing_group_id	string	client_billing_group_id	N
dunning_group_no	string	dunning_group_no	N
client_dunning_group_id	string	client_dunning_group_id	N
dunning_state	string	dunning_state	Y
dunning_step	string	dunning_step	N
dunning_step_description	string	dunning_step_description	Y
mpi_billing_dates	object	mpi_billing_dates	N
bill_day	string	bill_day	N
created_date	string	created_date	N
next_bill_date	string	next_bill_date	N
last_bill_date	string	last_bill_date	N
recurring_bill_thru_date	string	recurring_bill_thru_date	N
usage_bill_thru_date	string	usage_bill_thru_date	N
plan_date	string	plan_date	N
status_date	string	status_date	N
next_dunning_date	string	next_dunning_date	N
mpi_unit_instance_data	object	mpi_unit_instance_data	N
mpi_unit_instance	object	mpi_unit_instance	N
plan_unit_inst_no	string	plan_unit_inst_no	N
client_plan_unit_inst_id	string	client_plan_unit_inst_id	N
plan_unit_inst_status	string	plan_unit_inst_status	N
supp_plan_instance_data	object	supp_plan_instance_data	N
supp_plan_instance	object	supp_plan_instance	N
plan_instance_no	string	plan_instance_no	N
client_plan_instance_id	string	client_plan_instance_id	N
plan_no	string	plan_no	N
client_plan_id	string	client_plan_id	N
plan_name	string	plan_name	N
plan_activation_date	string	plan_activation_date	N
status_cd	string	status_cd	N
plan_units	string	plan_units	N
spi_billing_dates	string	spi_billing_dates	N
bill_day	string	bill_day	N
next_bill_date	string	next_bill_date	N
last_bill_date	string	last_bill_date	N
recurring_bill_thru_date	string	recurring_bill_thru_date	N
usage_bill_thru_date	string	usage_bill_thru_date	N
spi_unit_instance_data	object	spi_unit_instance_data	N
spi_unit_instance	object	spi_unit_instance	N
plan_unit_inst_no	string	plan_unit_inst_no	N
client_plan_unit_inst_id	string	client_plan_unit_inst_id	N
plan_unit_inst_status	string	plan_unit_inst_status	N
spi_supp_fields_data	object	spi_supp_fields_data	N
spi_supp_field	object	spi_supp_field	N
field_name [MSISDN]	string	"MSISDN"	Y*
field_value	string	MSISDN number	Y*
event_data	object	event_data	N
event	object	event	N
event_id	string	event_id	Y
event_label	string	event_label	N

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - POST request processed and Item Created.

SUCCESS