Versions Compared

Old Version 3

changes.mady.by.user George Rossides

Saved on

compared with

New Version 4

changes.mady.by.user Former user

Saved on

Key

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

Available from CRM.COM R9.0.0

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

group_identifier

(optional)

Group Identifier

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:

Include Page
V4:group_identifier
V4:group_identifier

unit_identifier

(optional)

Unit Identifier

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:

Include Page
V4:unit_identifier
V4:unit_identifier

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

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "E339CFB9284E8BB291E63CC42E574E88",
            "name": "Marketing Reward Scheme",
            "description": "Marketing Reward Scheme for Sales Department, CRM Team 1, Marketing Team"
        },
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "D9789AC11CF4792C21C93BB5A7ABE9DD",
            "name": "Marketing Reward Scheme for Call Centre Offers",
            "description": "Marketing Reward Scheme for Call Centre Offers"
        },
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "EA5CCE98F857F3A928E3AA6891323088",
            "name": "Sales Scheme",
            "description": "Sales Scheme - TC10"
        }
    ]
}