GET reward_schemes/list
- Joseph Ioannou (Unlicensed)
- Ekaterini Tzirtzipi
Owned by Joseph Ioannou (Unlicensed)
Available from CRM.COM R17.0.0
This method returns the effective reward schemes that are allowed to be provided to accounts receivable. 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 |
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
{
"data": [
{
"alternative_code": "234324",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"updated_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"created_date": "2019-07-15T13:36:32",
"updated_date": "2019-07-16T18:47:46",
"updated_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
},
"created_by_user": {
"person_name": "joseph ioannou",
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
"email": "j_ioannou@crm.com",
"username": "j_ioannou"
}
},
"self_signup_enabled": false,
"auto_signup_enabled": false,
"name": "234",
"description": "234234",
"reference_code_generation_method": "AUTO_GENERATED",
"id": "E473CB45987948CF9C0721F4B717671C",
"life_cycle_state": "EFFECTIVE",
"supported_email_domains": "crm.com",
"marketing_information": {
"terms_and_conditions": "<p><strong><em>werewrewrewr</em></strong></p>",
"reward_scheme_image": {
"file_name": "E473CB45987948CF9C0721F4B717671C_scheme_image_forest.jpg",
"file_alt_text": "forest",
"file_content_url": "/crm/ImageDownloadServlet?id=E473CB45987948CF9C0721F4B717671C&groupname=scheme_image",
"file_mime_type": "image/jpeg"
},
"short_description": "<p><strong>ewrwerwer</strong></p>",
"reward_scheme_small_image": {
"file_name": "E473CB45987948CF9C0721F4B717671C_scheme_small_image_Beach-And-Blue-Sea-Wallpaper-Download-Full-HD.jpg",
"file_alt_text": null,
"file_content_url": "/crm/ImageDownloadServlet?id=E473CB45987948CF9C0721F4B717671C&groupname=scheme_small_image",
"file_mime_type": "image/jpeg"
},
"long_description": "<p>erwerwerewr</p>"
},
"requires_reference_code": true
},
{
"alternative_code": "MRS",
"log_information": {
"created_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"created_date": "2016-03-11T10:29:39",
"updated_date": "2019-07-17T18:13:14",
"updated_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
},
"created_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
}
},
"self_signup_enabled": true,
"auto_signup_enabled": false,
"name": "Main Rewards Scheme",
"description": "hello8",
"reference_code_generation_method": "AUTO_GENERATED",
"id": "827918B0190B466FA578B14C080F02B8",
"life_cycle_state": "EFFECTIVE",
"supported_email_domains": null,
"marketing_information": {
"terms_and_conditions": "<p>dfhfdhfhfdhruturutdfhdfhd</p>",
"reward_scheme_image": {
"file_name": "827918B0190B466FA578B14C080F02B8_scheme_image_Beach-And-Blue-Sea-Wallpaper-Download-Full-HD.jpg",
"file_alt_text": "iiiiii",
"file_content_url": "/crm/ImageDownloadServlet?id=827918B0190B466FA578B14C080F02B8&groupname=scheme_image",
"file_mime_type": "image/jpeg"
},
"short_description": "<p>Testing long description28</p>\n<p><strong style=\"color: #993300;\">Heading rturturdfhdfhtruru4564564554</strong></p>",
"reward_scheme_small_image": {
"file_name": "827918B0190B466FA578B14C080F02B8_scheme_small_image_forest.jpg",
"file_alt_text": "kkkkk",
"file_content_url": "/crm/ImageDownloadServlet?id=827918B0190B466FA578B14C080F02B8&groupname=scheme_small_image",
"file_mime_type": "image/jpeg"
},
"long_description": "<p>Thesting scheme short <span style=\"background-color: #ff0000;\">descriptiontturtu4545545454</span></p>"
},
"requires_reference_code": false
},
{
"alternative_code": "PT",
"log_information": {
"created_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"created_date": "2019-07-17T17:21:37",
"updated_date": "2019-07-18T10:27:46",
"updated_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
},
"created_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
}
},
"self_signup_enabled": false,
"auto_signup_enabled": false,
"name": "Process Test",
"description": null,
"reference_code_generation_method": "AUTO_GENERATED",
"id": "F7AB23C168EB4FD7811CF8E74B0FC076",
"life_cycle_state": "EFFECTIVE",
"supported_email_domains": "crm.com",
"marketing_information": {
"terms_and_conditions": null,
"reward_scheme_image": null,
"short_description": null,
"reward_scheme_small_image": null,
"long_description": null
},
"requires_reference_code": true
},
{
"alternative_code": "test nic",
"log_information": {
"created_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"created_date": "2019-07-19T12:23:03",
"updated_date": "2019-07-19T12:23:09",
"updated_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
},
"created_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
}
},
"self_signup_enabled": true,
"auto_signup_enabled": false,
"name": "test nic",
"description": null,
"reference_code_generation_method": "AUTO_GENERATED",
"id": "5B3FB375ACB64C3B91985969BDDCDCA2",
"life_cycle_state": "EFFECTIVE",
"supported_email_domains": null,
"marketing_information": {
"terms_and_conditions": null,
"reward_scheme_image": null,
"short_description": null,
"reward_scheme_small_image": null,
"long_description": null
},
"requires_reference_code": false
},
{
"alternative_code": "DTS",
"log_information": {
"created_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"created_date": "2019-07-16T18:32:56",
"updated_date": "2019-07-16T18:37:22",
"updated_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
},
"created_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
}
},
"self_signup_enabled": false,
"auto_signup_enabled": false,
"name": "default template Scheme",
"description": null,
"reference_code_generation_method": "THROUGH_EXTERNAL_SYSTEM",
"id": "A51164A5FFA44593A04747C2E084C081",
"life_cycle_state": "EFFECTIVE",
"marketing_information": {
"terms_and_conditions": null,
"reward_scheme_image": null,
"short_description": null,
"reward_scheme_small_image": null,
"long_description": null
},
"requires_reference_code": true
},
{
"alternative_code": "test",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"created_date": "2019-06-21T17:16:29",
"updated_date": "2019-06-21T17:16:29",
"updated_by_user": {
"person_name": "joseph ioannou",
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
"email": "j_ioannou@crm.com",
"username": "j_ioannou"
},
"created_by_user": {
"person_name": "joseph ioannou",
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
"email": "j_ioannou@crm.com",
"username": "j_ioannou"
}
},
"self_signup_enabled": false,
"auto_signup_enabled": false,
"name": "test",
"description": null,
"reference_code_generation_method": "THROUGH_EXTERNAL_SYSTEM",
"id": "35F335B363444A78BA6F3EB78638E548",
"life_cycle_state": "EFFECTIVE",
"marketing_information": {
"terms_and_conditions": null,
"reward_scheme_image": null,
"short_description": null,
"reward_scheme_small_image": null,
"long_description": null
},
"requires_reference_code": true
},
{
"alternative_code": "e2eSSF",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"created_date": "2019-07-22T16:58:37",
"updated_date": "2019-07-22T16:58:37",
"updated_by_user": {
"person_name": "joseph ioannou",
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
"email": "j_ioannou@crm.com",
"username": "j_ioannou"
},
"created_by_user": {
"person_name": "joseph ioannou",
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
"email": "j_ioannou@crm.com",
"username": "j_ioannou"
}
},
"self_signup_enabled": true,
"auto_signup_enabled": false,
"name": "Self Sign Up",
"description": null,
"reference_code_generation_method": null,
"id": "1D0897EF2ADC4B408CFC4272D9C1BEEF",
"life_cycle_state": "EFFECTIVE",
"marketing_information": {
"terms_and_conditions": "<pre>Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</pre>",
"reward_scheme_image": {
"file_name": "1D0897EF2ADC4B408CFC4272D9C1BEEF_scheme_image_CRM_Logo_R14.png",
"file_alt_text": "rs14",
"file_content_url": "/crm/ImageDownloadServlet?id=1D0897EF2ADC4B408CFC4272D9C1BEEF&groupname=scheme_image",
"file_mime_type": "image/png"
},
"short_description": "<pre>Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</pre>",
"reward_scheme_small_image": {
"file_name": "1D0897EF2ADC4B408CFC4272D9C1BEEF_scheme_small_image_CRM_Logo_R15.png",
"file_alt_text": "rs15",
"file_content_url": "/crm/ImageDownloadServlet?id=1D0897EF2ADC4B408CFC4272D9C1BEEF&groupname=scheme_small_image",
"file_mime_type": "image/png"
},
"long_description": "<pre>Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</pre>"
},
"requires_reference_code": false
},
{
"alternative_code": "rsASU",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"created_date": "2019-07-22T17:02:05",
"updated_date": "2019-07-22T17:02:05",
"updated_by_user": {
"person_name": "joseph ioannou",
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
"email": "j_ioannou@crm.com",
"username": "j_ioannou"
},
"created_by_user": {
"person_name": "joseph ioannou",
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
"email": "j_ioannou@crm.com",
"username": "j_ioannou"
}
},
"self_signup_enabled": false,
"auto_signup_enabled": true,
"name": "Auto Sign Up",
"description": null,
"reference_code_generation_method": null,
"id": "8BB1192214864338B6D9E402F6148364",
"life_cycle_state": "EFFECTIVE",
"marketing_information": {
"terms_and_conditions": null,
"reward_scheme_image": null,
"short_description": null,
"reward_scheme_small_image": null,
"long_description": null
},
"requires_reference_code": false
},
{
"alternative_code": "e2eCLRS",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"created_date": "2019-07-22T17:04:04",
"updated_date": "2019-07-22T17:04:04",
"updated_by_user": {
"person_name": "joseph ioannou",
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
"email": "j_ioannou@crm.com",
"username": "j_ioannou"
},
"created_by_user": {
"person_name": "joseph ioannou",
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
"email": "j_ioannou@crm.com",
"username": "j_ioannou"
}
},
"self_signup_enabled": false,
"auto_signup_enabled": false,
"name": "Close Loop RS",
"description": null,
"reference_code_generation_method": "AUTO_GENERATED",
"id": "5AA4D2ED2DE34F0292F072DD29451AE2",
"life_cycle_state": "EFFECTIVE",
"supported_email_domains": "crm.com",
"marketing_information": {
"terms_and_conditions": null,
"reward_scheme_image": null,
"short_description": null,
"reward_scheme_small_image": null,
"long_description": null
},
"requires_reference_code": true
},
{
"alternative_code": "Y",
"log_information": {
"created_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"created_date": "2019-04-22T11:42:20",
"updated_date": "2019-07-22T10:35:40",
"updated_by_user": {
"person_name": "joseph ioannou",
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
"email": "j_ioannou@crm.com",
"username": "j_ioannou"
},
"created_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
}
},
"self_signup_enabled": true,
"auto_signup_enabled": false,
"name": "Tested",
"description": null,
"reference_code_generation_method": "AUTO_GENERATED",
"id": "3F2807382B984FD8A74EF0B4DD01742E",
"life_cycle_state": "EFFECTIVE",
"supported_email_domains": null,
"marketing_information": {
"terms_and_conditions": null,
"reward_scheme_image": {
"file_name": "3F2807382B984FD8A74EF0B4DD01742E_scheme_image_CRM_Logo.png",
"file_alt_text": "test23",
"file_content_url": "/crm/ImageDownloadServlet?id=3F2807382B984FD8A74EF0B4DD01742E&groupname=scheme_image",
"file_mime_type": "image/png"
},
"short_description": null,
"reward_scheme_small_image": {
"file_name": "3F2807382B984FD8A74EF0B4DD01742E_scheme_small_image_CRM_Logo_R16.png",
"file_alt_text": "tesr56",
"file_content_url": "/crm/ImageDownloadServlet?id=3F2807382B984FD8A74EF0B4DD01742E&groupname=scheme_small_image",
"file_mime_type": "image/png"
},
"long_description": null
},
"requires_reference_code": false
},
{
"alternative_code": "peri",
"log_information": {
"created_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"created_date": "2019-07-23T10:47:15",
"updated_date": "2019-07-23T11:23:48",
"updated_by_user": {
"person_name": "randomtest03 randomtest03",
"id": "C99E3166BDDF48FB924ADEA050859597",
"email": null,
"username": "randomtest03"
},
"created_by_user": {
"person_name": "Andrea Skapoulli",
"id": "8F64929DF83F4258BCFF6CB6DEB0682A",
"email": null,
"username": "a_skapoulli"
}
},
"self_signup_enabled": false,
"auto_signup_enabled": true,
"name": "perini",
"description": "testtest",
"reference_code_generation_method": "AUTO_GENERATED",
"id": "517FAE79D1E245EA81611F9ED334AF8F",
"life_cycle_state": "EFFECTIVE",
"supported_email_domains": null,
"marketing_information": {
"terms_and_conditions": "<p>aejkbvnjksnznwnooneeverreadsthismcndjksnv</p>",
"reward_scheme_image": {
"file_name": "517FAE79D1E245EA81611F9ED334AF8F_scheme_image_Perry_the_Platypus.png",
"file_alt_text": "nic",
"file_content_url": "/crm/ImageDownloadServlet?id=517FAE79D1E245EA81611F9ED334AF8F&groupname=scheme_image",
"file_mime_type": "image/png"
},
"short_description": "<p>nklcnsjkbavjke</p>",
"reward_scheme_small_image": {
"file_name": "517FAE79D1E245EA81611F9ED334AF8F_scheme_small_image_Perry_the_Platypus.png",
"file_alt_text": "nic small",
"file_content_url": "/crm/ImageDownloadServlet?id=517FAE79D1E245EA81611F9ED334AF8F&groupname=scheme_small_image",
"file_mime_type": "image/png"
},
"long_description": "<p>FEBJWEKNVWLK</p>"
},
"requires_reference_code": false
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}