Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R9.0.0

Table of Contents
maxLevel2

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

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

HTTP Method: GET

 

Request:

Response:

 

 
Expand
titleExample 1
Code Block
themeConfluence
languagejavascript
linenumberstrue
Panel
nameblue

Child pages (Children Display)
excerpttrue