get_acct_groups_by_acct_m
Summary
| API Name | get_acct_groups_by_acct_m |
|---|---|
| Class | account_services_m |
| Update Version | 55 |
Description
Returns the list of account groups to which an account belongs.
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 | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: user_id or client_acct_id |
| user_id | string | 32 | Yes |
Account's user ID. Alternative to using acct_no. Alternative required field: acct_no or client_acct_id |
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no or user_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. |
|
| acct_groups | object | No |
Note: This field is deprecated. Aria no longer supports acct_groups. |
|
| acct_groups_by_acct | object | No |
acct_groups_by_acct fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| group_no | long | No |
The unique ID of the account group |
|
| group_name | string | No |
The name of the account group |
|
| group_desc | string | No |
The long description of the account group |
|
| group_type | string | No |
Whether this is a functional (F) or collections (C) account group |
|
| client_acct_group_id | string | No |
The client-assigned group ID |
|
| assigned_by | string | No |
The name of the user who assigned the account group to the account |
|
| assigned_date | string | No |
Date when the account group was assigned to the account |