Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > 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
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
class_no long 8 The class to assign to the client   Allowable Values
  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

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
event_id long The unique ID for the individual event
event_name string The name of this event
event_description string The long description of this event
event_state string The current state of this event for this client

You must to post a comment.
Last modified
10:40, 9 May 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.