subscribe_events_m
Summary
| API Name | subscribe_events_m |
|---|---|
| Class | system_services_m |
| Update Version | 3.5 |
Description
Subscribes a client to a specified group of event notifications. Please note: In order for this call to work, the client must already be subscribed to the event class to which the specified events belong.
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. |
| event_list | object | Yes |
event_list fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| event_list | long | 38 | Yes |
The event IDs to which this client would like to subscribe |
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. |