Home > Aria6 User Documentation > Aria6 core api > subscribe_event_class

subscribe_event_class

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  
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 1000 Boolean indicator informing Aria whether or not to actually perform the requested plan assignment/de-assignment. If 'false' is passed in this field Aria will, if applicable, calculate any potential proration effect that would result from this call and return that value in the output field 'proration_result_amount' described below without actually performing the requested operation or charging/crediting the account. This is useful to interfaces that wish to present the user with a 'confirmation page' informing of the would-be effects of the requested operation prior to actually performing it.  
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 
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
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.