Description
This API returns a list of coupons applied to an account and/or master plan instances.
Inputs
| Name |
Type |
Length |
Required |
Description |
| client_no |
long |
12 |
Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key |
string |
32 |
Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
| limit |
long |
12 |
No |
The maximum number of objects to be returned by this call. Note that Aria recommends a maximum limit of less than 1,000. Higher limits may take much longer to return data. If you do not specify a value, or specify a value of "0", this field defaults to 100. Specifying a value of "-1" returns a count of the number of matching records, but does not return any records. |
| offset |
long |
12 |
No |
The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records. |
| query_string |
string |
1000 |
Yes |
The criteria which all returned objects must match. Different objects have a different set of searchable criteria.
Fields marked with "*Query" in the returns section can be used as part of the query_string. Valid operations for the query string include "=", "!=", "<", "<=", ">=", ">", "IS NULL", "IS NOT NULL", "LIKE", and "NOT LIKE". You must leave a space before and after each operation. The first operand must always be a field name, and the second operand must always be a value (except for "IS NULL" and "IS NOT NULL", where the second operand is implicitly "NULL"). If the second operand contains a space, less than, greater than, or equals sign, then it must be enclosed in double quotes. The second operand may not contain double quotes. Multiple conditions must be joined with either "AND" or "OR". Additionally, any queryable field can also be used to order the results, by appending "ORDER BY" to the query, followed by a field name and either "ASC" or "DESC". |
Querystring Keys
| Key Name |
Description |
| acct_no |
Aria-assigned unique account identifier. |
| user_id |
Unique alphanumeric identifier for an account holder. |
| client_acct_id |
Client-specified account identifier |
| master_plan_instance_id |
Aria generated unique identifier for the master plan instance |
| client_master_plan_instance_id |
Client defined unique identifier for the master plan instance |
| coupon_cd |
Coupon identification code. |
| coupon_create_date |
Date on which the coupon was added to the account. |
| coupon_cancel_date |
Date on which the coupon was canceled for the account (if applicable). |
| plan_instance_no |
Aria generated unique identifier for the plan instance |
| client_plan_instance_id |
Client defined unique identifier for the plan instance |
| coupon_assignment_level |
Specifies the coupon assignment level
Allowed values:
| Value |
Description |
| 1 | Account Level |
| 2 | MPI Stack Level |
| 3 | PI Level |
|
Outputs
| Name |
Type |
Length |
Required |
Description |
| error_code |
long |
|
No |
Aria-assigned error identifier. 0 indicates no error |
| error_msg |
string |
|
No |
Textual description of any error that occurred. "OK" if there was no error. |
| starting_record |
long |
|
No |
This indicates the number of objects that were (or would be) skipped before beginning output. |
| total_records |
long |
|
No |
This is the total number of objects that matched the provided criteria. |
| Start of coupon_history_m hash |
| coupon_history_m |
hash |
|
No |
List of coupon_history_m associated with this method. |
| Name |
Type |
Length |
Required |
Description |
| ▶acct_no |
long |
|
No |
Aria-assigned unique account identifier. |
| ▶user_id |
string |
|
No |
Unique alphanumeric identifier for an account holder. |
| ▶client_acct_id |
string |
|
No |
Client-specified account identifier |
| ▶master_plan_instance_id |
string |
|
No |
Aria generated unique identifier for the master plan instance |
| ▶client_master_plan_instance_id |
string |
|
No |
Client defined unique identifier for the master plan instance |
| ▶currency_cd |
string |
|
No |
ISO currency code. |
| ▶coupon_cd |
string |
|
No |
Coupon identification code. |
| ▶coupon_create_date |
string |
|
No |
Date on which the coupon was added to the account. |
| ▶coupon_status |
string |
|
No |
1 = Active/Not canceled. -1 = Canceled |
| ▶coupon_cancel_date |
string |
|
No |
Date on which the coupon was canceled for the account (if applicable). |
| ▶plan_instance_no |
long |
|
No |
Aria generated unique identifier for the plan instance |
| ▶client_plan_instance_id |
string |
|
No |
Client defined unique identifier for the plan instance |
| ▶coupon_assignment_level |
long |
|
No |
Specifies the coupon assignment level
Allowed values:
| Value |
Description |
| 1 | Account Level |
| 2 | MPI Stack Level |
| 3 | PI Level |
|
| End of coupon_history_m hash |
