send_client_event_m
Summary
| API Name | send_client_event_m |
|---|---|
| Class | account_services_m |
| Update Version | 75 |
Description
Triggers a standard Aria event notification on behalf of an authorized client system, using a caller-provided event_id and a JSON payload of content for the event message. Supports client-customizable event classes only (e.g. Allegro operational alerts); legacy/core event classes are not eligible.
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. |
| acct_no | long | No |
Aria-assigned account identifier. Optional -- leave blank for operational alerts that are not tied to a specific account. |
|
| event_id | long | 22 | Yes |
The event to trigger for provisioning. Must be one of the client-customizable event IDs the client is enabled for. |
| notification_content | string | Yes |
Dynamic content for the event message, in JSON format. The exact fields expected vary by event_id. |
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. |
|
| prov_id | long | No |
Aria-assigned provisioning record id (ProvID) for the triggered event. |