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) | 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:
| ||||||||||||
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:
| ||||||||||||
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
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved reward scheme |
name | String | The name of the retrieved reward scheme |
alternative_code | String | The alternative code of the retrieved reward scheme |
| description | String | A description of the retrieved reward scheme |
| life_cycle_state | String | The life cycle state of the retrieved reward scheme that can be Effective or Not Effective |
| requires_reference_code | Boolean | If true then a unique reference code is required in order to sign up to that specific reward scheme Available from CRM.COM R12.7.0 |
| self_signup_enabled | Boolean | If true then rewards participants can sign up to this reward scheme by themselves Available from CRM.COM R12.7.0 |
| auto_signup_enabled | Boolean | If true then rewards participants will automatically be participating to this scheme while they sign up Available from CRM.COM R15.0.0 |
| reference_code_generation_method | String | It determines how the reference code will be generated. The following generation methods are supported:
Available from CRM.COM R15.0.0 |
| supported_email_domains | String | It determines the supported email domains that can be used to sign a rewards participant into a specific rewards scheme that requires a reference code (multiple domains can be returned and will be comma separated) Applicable only if the reference code generation method is set to "AUTO_GENERATED" Available from CRM.COM R15.2.0 |
| log_information | Log Information Object | The log information of the retrieved reward scheme |
| marketing_information | Reward Scheme Marketing Information Object | The reward scheme's marketing information Available from CRM.COM R12.7.0 |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"log_information": {
"updated_date": "2015-02-19T16:35:35",
"created_date": "2015-01-14T10:09:24",
"created_by_unit": {
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "p_xenopoulou",
"username": "p_xenopoulou",
"id": "159C17D9C4B1E48DC129FBC701D38438"
},
"updated_by_user": {
"person_name": "p_demou",
"username": "p_demou",
"id": "4927E7EE8BBB4047A35F4F313D0EC6D3"
}
},
"life_cycle_state": "EFFECTIVE",
"id": "EA5CCE98F857F3A928E3AA6891323088",
"name": "Sales Scheme",
"description": "Sales Scheme - TC10"
}
]
}
HTTP Method: GET
Request:
Response:
{
"data": [
{
"alternative_code": "TSF9A9",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2018-04-24T18:08:55",
"updated_date": "2018-04-25T09:54:42",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "test@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "test@crm.com",
"username": "MPAdministrator"
}
},
"self_signup_enabled": true,
"name": "Test Scheme for 9216 and 9215",
"description": null,
"id": "6999036ED39A4D56B322B76607F7E942",
"life_cycle_state": "EFFECTIVE",
"marketing_information": {
"reward_scheme_image": {
"file_name": "6999036ED39A4D56B322B76607F7E942_scheme_image_images.jpg",
"file_alt_text": "tulips",
"file_content_url": "/crm/ImageDownloadServlet?id=6999036ED39A4D56B322B76607F7E942&groupname=scheme_image",
"file_mime_type": "image/jpeg"
},
"short_description": "<p>Short</p>",
"long_description": "<p>the long description for the scheme image </p>\n<p>lalala lalala</p>\n<p>another line with bla bla bla bla</p>\n<p>the end</p>",
"reward_scheme_background": {
"color": "#EFF6E0",
"file_name": "6999036ED39A4D56B322B76607F7E942_scheme_back_image_download.jpg",
"file_alt_text": "tulips back",
"file_content_url": "/crm/ImageDownloadServlet?id=6999036ED39A4D56B322B76607F7E942&groupname=scheme_back_image",
"file_mime_type": "image/jpeg"
}
},
"requires_reference_code": true
},
{
"alternative_code": "M3Scheme1",
"log_information": {
"created_by_unit": {
"alternative_code": "MUnit3",
"group_name": "MGroup3",
"community_name": "MCom",
"name": "MUnit3",
"description": null,
"id": "158E0F54E25349B2AC790782332724E2"
},
"updated_by_unit": {
"alternative_code": "MUnit3",
"group_name": "MGroup3",
"community_name": "MCom",
"name": "MUnit3",
"description": null,
"id": "158E0F54E25349B2AC790782332724E2"
},
"created_date": "2016-07-27T11:51:05",
"updated_date": "2016-07-27T11:51:15",
"updated_by_user": {
"person_name": "Merchant Test3",
"id": "7BD216AF3E6841938B9B57EF87DF40F0",
"email": null,
"username": "merchanttest3"
},
"created_by_user": {
"person_name": "Merchant Test3",
"id": "7BD216AF3E6841938B9B57EF87DF40F0",
"email": null,
"username": "merchanttest3"
}
},
"self_signup_enabled": false,
"name": "M3Scheme1",
"description": null,
"id": "C880F9DC3B6348399CDD03808D5CDD52",
"life_cycle_state": "EFFECTIVE",
"marketing_information": null,
"requires_reference_code": false
},
{
"alternative_code": "M3Scheme2",
"log_information": {
"created_by_unit": {
"alternative_code": "MUnit3",
"group_name": "MGroup3",
"community_name": "MCom",
"name": "MUnit3",
"description": null,
"id": "158E0F54E25349B2AC790782332724E2"
},
"updated_by_unit": {
"alternative_code": "MUnit3",
"group_name": "MGroup3",
"community_name": "MCom",
"name": "MUnit3",
"description": null,
"id": "158E0F54E25349B2AC790782332724E2"
},
"created_date": "2016-07-27T11:51:17",
"updated_date": "2016-07-27T11:51:25",
"updated_by_user": {
"person_name": "Merchant Test3",
"id": "7BD216AF3E6841938B9B57EF87DF40F0",
"email": null,
"username": "merchanttest3"
},
"created_by_user": {
"person_name": "Merchant Test3",
"id": "7BD216AF3E6841938B9B57EF87DF40F0",
"email": null,
"username": "merchanttest3"
}
},
"self_signup_enabled": false,
"name": "M3Scheme2",
"description": null,
"id": "A919A712A4FA4D3EBC6EB9A59DD0AEA1",
"life_cycle_state": "EFFECTIVE",
"marketing_information": null,
"requires_reference_code": false
}
...
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}