Home > Aria Crescendo Documentation > Aria Crescendo core api > subscribe_event_class_m

subscribe_event_class_m

Subscribes a client to a specified event class.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png class_no long 8

The class to assign to the client. 

Allowable values for class_no: 

Values Description
1 Accounts: Creation and modification of accounts and their logically related data elements
2 Orders: Creation and modificaion of orders for inventory items
3 Financial Transactions: Creation of financial transactions on accounts
4 Account Notifications: Distillation and/or sending of account holder-facing email messages
5 Usage Monitoring: Monitoring of account usage values, balances and thresholds
  do_write string 5

Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, if applicable, any potential effects from this call such as proration, plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that want to present the user with a 'confirmation page' informing them of the potential effects of the requested operation prior to actually performing it. Do_write defaults to 'true'  

Allowable values for do_write: 

Values Description
true true
false false

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
events hash

An array of events returned from the successful completion of this API call.

Allowable values for events: 

Values Description
1 Accounts: Creation and modification of accounts and their logically related data elements
2 Orders: Creation and modification of orders for inventory items
3 Financial Transactions: Creation of financial transactions on accounts
4 Account Notifications: Distillation and/or sending of account holder-facing email messages
5 Usage Monitoring: Monitoring of account usage values, balances and thresholds
brd_arrow.gif event_id long The unique ID for the individual event
brd_arrow.gif event_name string The name of this event
brd_arrow.gif event_description string The long description of this event
brd_arrow.gif event_state string The current state of this event for this client
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®