subscribe_event_class_m
Summary
| API Name | subscribe_event_class_m |
|---|---|
| Class | system_services_m |
| Update Version | 3.5 |
Description
Subscribes a client to a specified event class.
Inputs
| Name | Type | Length | Required | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||||||||
| class_no | long | 8 | Yes |
The class to assign to the client Allowed values:
|
||||||||||||
| do_write | string | 5 | No |
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' Allowed values:
|
Outputs
| Name | Type | Length | Required | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|||||||||||||
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|||||||||||||
| events | object | No |
An array of events returned from the successful completion of this API call Allowed values:
|
events fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| event_id | long | No |
The unique ID for the individual event |
|
| event_name | string | No |
The name of this event |
|
| event_description | string | No |
The long description of this event |
|
| event_state | string | No |
The current state of this event for this client |