| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
GET rewards_participants/configuration/reward_schemes/list
This method returns the effective reward schemes that are allowed to be provided to rewards participants. Multiple reward schemes are returned by each call. Note that only effective reward schemes are retrieved.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
group_identifier
(optional)
...
The identifier of the group that will be providing the reward scheme. The group is filtered against the reward scheme's allowed organisational units. The allowed group identifier fields are the following:
...
unit_identifier
(optional)
...
The identifier of the unit that will be providing the reward scheme. The unit is filtered against the reward scheme's allowed organisational units. The allowed unit identifier fields are the following:
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Response Data
...
Examples
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Code Block | ||||||
| ||||||
| Panel | ||||||
| ||||||
|