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

 

Home > Aria6 core api > unsubscribe_event_class

unsubscribe_event_class

Unsubscribes a client from 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 event class number to unsubscribe from.   Allowable Values
  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.   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 being unsubscribed to.  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
14:42, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.