Intended Application
Returns member progress for all transaction product progress promotions that are configured to track progress.
Notes
- One of two identifiers can be supplied (Account Id or Internal Member Id). If both are supplied, the Account Id is given preference and is used to retrieve the member. If no Internal Member Id is available, enter -1 for this field.
- "Offset Minutes from UTC" is used to determine current local date/time, which is then used to determine which promotions have an active date range that includes this local timestamp.
- Promotions will be returned in the output, only if the promotion is still active (see above note) and if the member has eligibility.
Input Parameters
PARAMETER |
DATA TYPE | DATA REQUIRED? | FORMATTING | NOTES |
---|---|---|---|---|
WS Security Token |
Alphanumeric |
Yes |
|
|
Account Id | Alphanumeric | Yes/No | See Article Notes | |
Internal Member Id | Integer | Yes/No | See Article Notes | |
Offset Minutes from UTC | Integer | Yes | The difference (in minutes) from UTC for active date range validation. | |
Include Past Promotions | Integer | Yes | (0=No/1=Yes) If enabled, return will include inactive promotions progress. |
Common Return Codes
0,1,2,7,100,101,102,5000,6000,6004,6046
Additional error codes may be generated. Their descriptions can be found by calling GetReturnCodeMessage.
More Information