- Created by Georgia Kountouri, last modified by Marina Antoniadou (Unlicensed) on Jun 12, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 43 Next »
Available from CRM.COM R10.0.0
GET reward_offers/show
This method returns information related with a reward offer. A single reward offer is returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
| reward_offer_identifier (mandatory) | Lead identifier | The identifier of the reward offer that should be returned as a result. The allowed reward offer 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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved reward offer |
number | String | The number of the retrieved reward offer |
| name | String | The name of the retrieved reward offer |
| alternative_code | String | The alternative code of the retrieved reward offer |
| description | String | The description of the retrieved reward offer |
| classification | String | The reward offer classification, which can be one of the following:
|
| evaluation_method | String | The method that will be used to evaluate the offers which can be BATCH_PROCESS or INTERACTIVELY |
| award_scope | String | The award scope that defines if the award provided by the reward offer should be applied per transaction or per transaction item, which can be APPLY_AWARD_PER_TRANSACTION or APPLY_AWARD_PER_TRANSACTION_ITEM Deprecated from CRM.COM R17.0.0 |
| spend_method | String | The method that will be used to spend the offers which can be SPEND_ON_REQUEST, SPEND_INSTANTLY, SPEND_INSTANTLY_THROUGH_VOUCHER |
| apply_on_top_of_other_applicable_offers | Boolean | If false then the reward offer will be applicable only if the provided award is the best award among other reward offers that might be applicable. If true then it will be applied irrespective of any other applicable reward offers Deprecated from CRM.COM R17.0.0 |
life_cycle_state | String | The life cycle state of the retrieved lead which can be EFFECTIVE or NOT EFFECTIVE |
| latest_effective_date | Date | The latest effective date of the retrieved reward offer |
| latest_evaluation_date | Date | The latest date that the reward offer was evaluated. This is applicable only for reward offers with evaluation method equal to BATCH |
| terms_and_conditions | String | The terms and conditions for the retrieved reward offer Available from CRM.COM R15.0.0 |
| award_amount | Number | The awarded amount provided by the reward offer. An awarded amount can be specified in all reward offers classifications. Either an awarded amount, award percentage or award percentage on awarded purchases is returned per reward offer. |
| award_percentage | Number | The award percentage of the financial transaction amount that triggered the award. Either an awarded amount, award percentage or award percentage on awarded purchases is returned per reward offer. An offer's awarded percentage can only be specified in the offer is classified as: UTILISE_FREE_CAPACITY, INCREASE_REVENUE_TRANSACTION_BASED, INCREASE_REVENUE_PRODUCT_BASED, REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED and REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED |
| award_percentage_on_previous_awards | Award Percentage on Previous Awards Object | The award percentage on awards submitted within a specific period of time. Award percentage on previous awards can be specified in all reward offers classifications. Available from CRM.COM R10.0.0 |
| award_currency | Currency Object | The currency in which the Reward Offer's award will be provided which can either be in system or the alternative currency. |
| reward_scheme | Reward Scheme Object | The reward scheme of the retrieved reward offer |
| category | Reward Offer Category Object | The category information of the retrieved reward offer |
| owned_by_group | Group object | The group that is owning the reward offer Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit) |
| owned_by_business_unit | Business Unit Object | The business unit that is owning the accounts receivable Available from CRM.COM R18.0.0 |
| marketing_information | Reward Offer Marketing Information Object | The reward offer's marketing information |
| log_information | Log Information Object | The log information related with the retrieved reward offer |
Referred Objects Response Data
currency object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
reward scheme object 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 reward scheme which can be EFFECTIVE or NOT_EFFECTIVE |
award percentage on key performance indicator values response data
Name | Type | Description |
|---|---|---|
| percentage | Number | Defines the award percentage that should be applied on the value of the specified key performance indicator |
| key_performance_indicator | Key Performance Indicator Objects | The key performance indicator that will be awarded based on its value and the specified percentage |
key performance indicator object response data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved customer event key performance indicator |
name | String | The name of the retrieved customer event key performance indicator |
alternative_code | String | The alternative code of the retrieved customer event key performance indicator |
reward_offer_category data object
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved reward offer category |
| name | String | The Name of the retrieved reward offer category |
| code | String | The Code of the retrieved reward offer category |
| description | String | The Description of the retrieved reward offer category |
| parent_id | String | The id of the retrieved category's parent category |
group object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved group |
name | String | The name of the retrieved group |
community_name | String | The name of the community that the retrieved group belongs to |
alternative_code | String | The alternative code of the retrieved group |
| unified_code | String | The unified code of the retrieved group Available from CRM.COM R16.2.2 |
description | String | The description of the retrieved group |
business unit object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
reward offer marketing information object response data
Name | Type | Description |
|---|---|---|
| long_description | String | The offer's long description |
| short_description | String | The offer's short description |
| no_awards_status_text | String | The text that should appear to inform the participant that he has not been awarded yet. Deprecated from CRM.COM R17.0.0 |
| times_awarded_status_text | String | The text that should appear to inform the participant that the number displayed is the times he has been awarded. Deprecated from CRM.COM R17.0.0 |
| average_weekly_awarded_amount_text | String | The text that should appear to inform the participant that the amount displayed is the average weekly awarded amount. Deprecated from CRM.COM R17.0.0 |
| offer_image | Reward Offer Image Object | The reward large (standard) offer image |
| offer_small_image | Reward Offer Image Object | The reward small offer image |
| offer_background | Reward Offer Background Object | The reward offer background which can be an image or a color Deprecated from CRM.COM R17.0.0 |
| offer_stamp_image | Reward Offer Stamp Image Object | The reward offer stamp image Available from CRM.COM R15.0.0 Deprecated from CRM.COM R17.0.0 |
Referred Objects Response Data
Reward offer Marketing Information Image Object
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
Reward scheme Marketing Information Background Object
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
| color | String | The hexadecimal value of the color that will be used as a background |
Reward offer Marketing Information Stamp Image Object
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0 | |
User Object | The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled | |
Unit Object | The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
User Object | The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Examples
Example 1
HTTP Method: GET
http://cyn1lnx004:9080/crmapi/rest/v2/reward_offers/show?token=62B858D0EE784763922A6A96439AF7D8&reward_offer_identifier=number=63
Request:
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=169
Response:
{
"data": {
"award_conditions_set": {
"financial_achievement_conditions": {
"financial_achievement_amount_range": {
"from_value": 5,
"to_value": 12
},
"number_of_awards": "ONLY_ONE_PER_PERIOD",
"number_of_awards_period": {
"time_period_uot": "WEEKS",
"time_period_value": 5
},
"all_achievements_should_exist": false,
"financial_achievement_classifications_set": [
{
"alternative_code": "FA2",
"name": "Financial Achievement 2",
"id": "7FD0A0BE5D684A3698BCEE2ACFC7F7AF"
},
{
"alternative_code": "FA",
"name": "Financial Achievement 1",
"id": "39031C33C1AC4FB79140B27D1614CD6A"
}
]
},
"location_conditions_set": null,
"period_conditions": null,
"product_conditions_set": [],
"segment_conditions_set": [],
"organisational_unit_conditions_set": [],
"payment_medium_conditions_set": {}
},
"alternative_code": "PTO",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-10-04T07:14:14",
"updated_date": "2016-10-07T12:12:42",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "PKRS",
"name": "PK Reward Scheme",
"description": null,
"id": "19A8546CACC3470898147EF0EAFE4CA2",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"apply_if_best_award_is_provided": false,
"spend_method": null,
"life_cycle_state": "NOT_EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "FA",
"name": "Financial Achievments",
"description": null,
"id": "1F91CA50C16B494A86901861A4681127",
"classification": "REWARD_FINANCIAL_ACHIEVEMENTS"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": null,
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "169",
"award_amount": 5,
"name": "PK Test Offer",
"id": "722E83DBC8224523BD156A9936C0C6E2",
"award_scope": null,
"category": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
Example 2
HTTP Method: GET
Request:
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=46
Response:
{
"data": {
"award_conditions_set": {
"product_conditions_set": [],
"segment_conditions_set": [],
"organisational_unit_conditions_set": [],
"payment_medium_conditions_set": {
"payment_medium_type_condition_set": [
{
"name": "BANK TRANSDER PAYMENT",
"description": null,
"id": "EA7291BC11C846088456A771514642D9",
"altCode": "BTP"
},
{
"name": "CREDIT CARD",
"description": null,
"id": "68FAF1F833194091967F86B1AA352129",
"altCode": "CC"
}
],
"payment_medium_brand_condition_set": [
{
"name": "VISA",
"description": null,
"id": "02DEEA7F35B8413E9C017600653C1223",
"altCode": "V"
}
]
}
},
"alternative_code": "ovc",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-05T06:56:43",
"updated_date": "2016-07-05T06:58:41",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "FA",
"name": "Financial Achievments",
"description": null,
"id": "1F91CA50C16B494A86901861A4681127",
"classification": "REWARD_FINANCIAL_ACHIEVEMENTS"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-05 06:58:41.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "46",
"award_amount": 12,
"name": "offer that validates criteria",
"id": "C309CC842D274BB3BFF7C320005453B4",
"category": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
Example 3
HTTP Method: GET
Request:
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=87
Response:
{
"data": {
"award_conditions_set": {
"segment_conditions_set": [
{
"segment": {
"number": "2",
"alternative_code": "EP",
"name": "Effective rewards participants",
"description": null,
"id": "9BCA8988077543B8B1A30D10DEE14440"
},
"option": "EXCLUDE"
}
],
"organisational_unit_conditions_set": [
{
"unit": null,
"group": {
"alternative_code": "EG",
"community_name": "Community",
"name": "External Group",
"description": null,
"id": "641C9485A25246B6B7FE20804E5A81A1"
}
}
],
"nameday_condition": "DURING_NAMEDAY_MONTH"
},
"alternative_code": "ERN",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-14T08:09:44",
"updated_date": "2016-07-14T09:33:10",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RON",
"name": "Reward On Nameday",
"description": null,
"id": "8702D2C8C1A04BC283126F944AF29D37",
"classification": "REWARD_ON_NAMEDAY"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-07-14 08:10:24.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "87",
"award_amount": 2.89,
"name": "ET Reward Nameday",
"id": "8B37E0EAF84C4FC7B8745318F0F6840E",
"category": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
Example 4
HTTP Method: GET
Request:
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=48
Response:
{
"data": {
"award_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[
{
"day_of_week": "MONDAY"
},
{
"day_of_week": "TUESDAY"
},
{
"day_of_week": "WEDNESDAY"
},
{
"day_of_week": "THURSDAY"
},
{
"day_of_week": "FRIDAY"
},
{
"day_of_week": "SATURDAY"
},
{
"day_of_week": "SUNDAY"
}
]
],
"hours_condition_set": []
},
"transaction_condition": {},
"location_conditions_set": {
"location_set": [
{
"area": "Kaimakli",
"city": "",
"district": ""
},
{
"area": "",
"city": "Larnaca",
"district": "Livadia"
},
{
"area": "",
"city": "Nicosia",
"district": ""
}
]
},
"period_conditions": null,
"product_conditions_set": {
"product_set": []
},
"organisational_unit_conditions_set": []
},
"alternative_code": "UWNC",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-11T09:21:14",
"updated_date": "2016-07-15T06:05:34",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"award_percentage": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "UFCE",
"name": "Utilise Free Capacity ET",
"description": null,
"id": "4B9AD34AA9334F3DB9F6668D1B0E0DB2",
"classification": "UTILISE_FREE_CAPACITY"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-14 09:46:20.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "48",
"name": "ET Utilise Free Capacity",
"id": "EDC5AF03BD394966B326EE63985928B0",
"category": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
Example 5
HTTP Method: GET
Request:
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=187
Response:
{
"data": {
"award_conditions_set": {
"location_conditions_set": {
"location_set": [
{
"area": "Aglantzia",
"city": "Nicosia",
"district": "Nicosia"
}
]
},
"period_conditions": {
"time_period_uot": "YEARS",
"time_period_value": 7
},
"financial_statement_conditions": {
"key_performance_indicator_conditions_set": [
{
"key_performance_indicator": {
"alternative_code": "ETKPI",
"name": "ET KPI",
"id": "123456id"
},
"product": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"from_value": 2,
"to_value": 5
},
{
"key_performance_indicator": {
"alternative_code": "kpi_a",
"name": "key performance indicator A",
"id": "164DC042D50F462BB6B28E86AE2B6C8C"
},
"product": null,
"from_value": 3,
"to_value": null
}
],
"number_of_awards": "ONLY_ONE_PER_PERIOD",
"number_of_awards_period": {
"time_period_uot": "DAYS",
"time_period_value": 1
},
"financial_statement_classifications_set": [
{
"alternative_code": "6136",
"name": "Financial Statement",
"id": "DF940370AA0D4497AA33F1A89A842C62"
}
]
},
"segment_conditions_set": [
{
"segment": {
"number": "48",
"alternative_code": "ER",
"name": "ET RP",
"description": null,
"id": "C404D4AA9DCD4F08BB70899F6D98F278"
},
"option": "EXCLUDE"
},
{
"segment": {
"number": "20",
"alternative_code": "RPMT1MA",
"name": "Rewards Participants more than 1 month activated",
"description": null,
"id": "BDEBA651620047E782F99E4ABF544CF4"
},
"option": "INCLUDE"
}
],
"organisational_unit_conditions_set": [
{
"unit": null,
"group": {
"alternative_code": "EMG",
"community_name": "ET Merchant Group",
"name": "ET Merchant Group",
"description": null,
"id": "275FFB56605049E8B599F8B00AD55E02"
}
},
{
"unit": {
"alternative_code": "u1",
"group_name": "Main Group",
"community_name": "Community",
"name": "Unit1",
"description": null,
"id": "C03AB710D94843229A32198FA4096448"
},
"group": null
}
]
},
"alternative_code": "FSTC",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-10-13T11:26:18",
"updated_date": "2016-10-13T12:18:38",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "ES_1",
"name": "ET S11",
"description": null,
"id": "F475BE22923944858AA188FE0205C3FD",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"apply_if_best_award_is_provided": false,
"spend_method": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[
{
"day_of_week": "MONDAY"
},
{
"day_of_week": "FRIDAY"
}
]
],
"hours_condition_set": [
{
"from": 0,
"to": 16
}
]
},
"product_conditions_set": [
{
"product_family": null,
"product": null,
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "AO",
"composition_method": "FLAT",
"name": "Add-ons",
"description": "Additional products",
"id": "E2324486B2454B56B054ED8129E3A9C0",
"classification": "SERVICES",
"physical_good_type": null
}
},
{
"product_family": null,
"product": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"product_type": null
},
{
"product_family": {
"code": "PKF",
"name": "PK_Family",
"description": null,
"id": "3E91CC57B69240FBB367C1BD534BF190"
},
"product": null,
"product_type": null
}
],
"organisational_unit_conditions_set": [
{
"unit": null,
"group": {
"alternative_code": "EMG",
"community_name": "ET Merchant Group",
"name": "ET Merchant Group",
"description": null,
"id": "275FFB56605049E8B599F8B00AD55E02"
}
},
{
"unit": {
"alternative_code": "u1",
"group_name": "Main Group",
"community_name": "Community",
"name": "Unit1",
"description": null,
"id": "C03AB710D94843229A32198FA4096448"
},
"group": null
}
],
"allowed_spend_period_after_award": {
"time_period_uot": "DAYS",
"time_period_value": 2
}
},
"type": {
"alternative_code": "FS",
"name": "Financial Statement",
"description": null,
"id": "CC6AAD68E5EA4CC7BF91D70C1028BFE4",
"classification": "REWARD_FINANCIAL_STATEMENTS"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-10-13T11:31:16",
"reward_award_validity": {
"validity_options": "VALID_FOR_SPECIFIC_PERIOD",
"award_validity_period_duration": {
"time_period_uot": "DAYS",
"time_period_value": 3
}
},
"number": "187",
"award_percentage_on_key_performance_indicator_values": [
{
"key_performance_indicator": {
"alternative_code": "kpi_a",
"name": "key performance indicator A",
"id": "164DC042D50F462BB6B28E86AE2B6C8C"
},
"percentage": "5.30"
}
],
"name": "Financial Statement Template Copy",
"id": "377E2A0DA4FE4D30BD12063B8993E403",
"award_scope": null,
"category": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
Example 6
HTTP Method: GET
Request:
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=226
Response:
{
"data": {
"award_conditions_set": {
"sign_up_condition": false,
"segment_conditions_set": [
{
"segment": {
"number": "54",
"alternative_code": "ZS",
"name": "Zoe Segment",
"description": null,
"id": "9AAEF16C6CA34CC9896FC5D3FB0BC2F6"
},
"option": "INCLUDE"
}
],
"organisational_unit_conditions_set": []
},
"alternative_code": "LO4",
"reward_offer_validity": {
"validity_options": "VALID_DURING_BIRTHDAY_PERIOD",
"valid_x_days_before_birthday_date": 19,
"valid_x_days_after_birthday_date": 11
},
"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": "2016-11-02T10:09:49",
"updated_date": "2016-11-03T13:46:12",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "LSVT",
"name": "Loukia Scheme For Validity Tesing - DO NOT USE",
"description": null,
"id": "BE9FC69C38C74098974E8C682C0DA1C3",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"apply_if_best_award_is_provided": false,
"spend_method": "SPEND_ON_REQUEST",
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RS",
"name": "Reward Signups",
"description": null,
"id": "21B8D71630BD4FE6B504E63B7167549E",
"classification": "REWARD_SIGN_UPS"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-11-02T10:10:50",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "226",
"award_amount": 10,
"name": "Loukia Offer 4 - DO NOT EDIT",
"id": "B64B6789B6924B63891978396AFD0CC3",
"award_scope": "APPLY_AWARD_PER_TRANSACTION_ITEM",
"category": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
Example 7
HTTP Method: GET
Request:
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=229
Response:
{
"data": {
"award_conditions_set": {
"sign_up_condition": false,
"segment_conditions_set": [],
"organisational_unit_conditions_set": []
},
"alternative_code": "LO7",
"reward_offer_validity": {
"validity_options": "VALID_DURING_RECURRING_PERIOD",
"validity_recurring_periods_set": [
{
"valid_to": {
"month": 1,
"day": 10
},
"valid_from": {
"month": 1,
"day": 1
},
"id": "26D1D902ADAB428BAEEB50A36021D099"
},
{
"valid_to": {
"month": 12,
"day": 31
},
"valid_from": {
"month": 12,
"day": 10
},
"id": "0630844543644EA485D9D9D04590A806"
},
{
"valid_to": {
"month": 8,
"day": 31
},
"valid_from": {
"month": 6,
"day": 1
},
"id": "378594D5883F4A37A95BCF21A06E4B42"
}
]
},
"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": "2016-11-02T10:15:58",
"updated_date": "2016-11-03T13:50:10",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "LSVT",
"name": "Loukia Scheme For Validity Tesing - DO NOT USE",
"description": null,
"id": "BE9FC69C38C74098974E8C682C0DA1C3",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"apply_if_best_award_is_provided": false,
"spend_method": "SPEND_ON_REQUEST",
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RS",
"name": "Reward Signups",
"description": null,
"id": "21B8D71630BD4FE6B504E63B7167549E",
"classification": "REWARD_SIGN_UPS"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-11-02T10:19:00",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "229",
"award_amount": 10,
"name": "Loukia Offer 7 - DO NOT EDIT",
"id": "FB72F9FFC07F479B97E8DB624408A428",
"award_scope": "APPLY_AWARD_PER_TRANSACTION_ITEM",
"category": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
Example 8
HTTP Method: GET
Request:
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=258
Response:
{
"data": {
"award_conditions_set": {
"transaction_condition": {
"transaction_period_range_period": {
"time_period_uot": "MONTHS",
"time_period_value": 6
},
"transaction_amount_from": 500
},
"location_conditions_set": null,
"product_conditions_set": [
{
"product_family": null,
"all_products_should_exist": true,
"product": null,
"product_type": {
"service_type": null,
"used_for_provisioning": false,
"alternative_code": "001",
"composition_method": "FLAT",
"name": "Equipment",
"description": null,
"id": "EQ",
"classification": "PHYSICALGOODS",
"physical_good_type": "NONTRACEABLE"
}
},
{
"product_family": null,
"all_products_should_exist": true,
"product": {
"code": "Smartcard",
"product_type": {
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "S",
"composition_method": "FLAT",
"name": "SMARTCARD",
"description": "SMARTCARD",
"id": "D6BE0209EC0149989A89972CE889DF8B",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "SC1",
"description": "asd",
"id": "4F656ED5DAC44168B0805227881202CD"
},
"product_type": null
}
],
"segment_conditions_set": [],
"organisational_unit_conditions_set": null,
"payment_medium_conditions_set": {}
},
"alternative_code": "O1-DNC_1",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2017-06-08T17:07:45",
"updated_date": "2017-06-08T18:14:23",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
},
"privacy_level": {
"number": "14",
"name": "PL Group A_Share_Low",
"id": "9DCEFDA9D56145978C265085CD146810",
"hierarchy_level": 1
},
"reward_scheme": {
"alternative_code": "PKRS",
"name": "PK Reward Scheme",
"description": null,
"id": "84E4934B64F64008965F9929FDE0CFB1",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": "SB1 - Reward Loyalty, Transaction Amount Based offers",
"apply_if_best_award_is_provided": false,
"spend_method": null,
"life_cycle_state": "NOT_EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RLTAB",
"name": "Reward Loyalty, Transaction Amount Based",
"description": null,
"id": "CCCEDDF8C646480F9636E31A335898E5",
"classification": "REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2017-06-08T17:10:01",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "258",
"award_amount": 5,
"name": "Offer 1B - DO NOT CHANGE",
"id": "019CD7764AE341F9B84FA37A8FA4D900",
"award_scope": null,
"category": null,
"marketing_information": {
"short_description": null,
"times_awarded_status_text": null,
"average_weekly_awarded_amount_text": null,
"long_description": null,
"no_awards_status_text": null,
"offer_image": {
"file_alt_text": null,
"file_content_url": null
},
"offer_background": {
"color": null,
"file_alt_text": null,
"file_mime_type": null
}
}
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST reward_offers/list
This method returns information related with reward offers. Multiple reward offers are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
rewards_participant_identifier (semi-optional) | Rewards participant identifier | The identifier of the rewards participant who might benefit from the reward offer that will be returned as a result. The allowed rewards participant identifier fields are the following:
| ||||||||||||
accounts_receivable_identifier (semi-optional) | Accounts Receivable identifier | The identifier of the rewards participant's accounts receivable. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
wallet_identifier (semi-optional) | Wallet identifier | The identifier of the reward participant's wallet. The allowed wallet identifier fields are the following:
| ||||||||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will provide the reward offer. The group is filtered against the reward offer's Award conditions organisational units. The allowed unit identifier fields are the following:
| ||||||||||||
unit_identifier (optional) | Unit identifier | The identifier of the unit that will provide the reward offer. The unit is filtered against the reward offer's Award conditions organisational units. The allowed unit identifier fields are the following:
| ||||||||||||
reward_scheme_identifier (optional) | Reward scheme identifier | The identifier of the reward scheme related with the reward offer that should be returned as a result. The allowed reward scheme identifier fields are the following:
| ||||||||||||
type_identifier | Reward offer type identifier | The identifier of the reward offer type related with the reward offer that should be returned as a result. The allowed reward offer type identifier fields are the following:
| ||||||||||||
evaluation_method (optional) | Reward offer evaluation method identifier | The identifier of the reward offer evaluation method related with the reward offer that should be returned as a result. The allowed reward offer evaluation method identifier fields are the following:BATCH_PROCESS or BATCH_PROCESS_AND_INTERACTIVELY. | ||||||||||||
award_scope (optional) | Award Scope identifier | The identifier of the award scope related with the reward offer that should be returned as a result. The allowed award scope identifier fields are the following: APPLY_AWARD_PER_TRANSACTION_ITEM or APPLY_AWARD_PER_TRANSACTION. Available from CRM.COM R10.0.0 | ||||||||||||
spend_method (optional) | Reward Offer spend method | The identifier of the reward offer spend method related with the reward offer that should be returned as a result. The allowed reward offer spend method identifier fields are the following: SPEND_ON_REQUEST or SPEND_INSTANTLY. Available from CRM.COM R10.0.0 | ||||||||||||
purchase_product (optional) | Product identifier | The identifier of the product which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product identifier fields are the following:
| ||||||||||||
purchase_product_type (optional) | Product type identifier | The identifier of the product type which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product type identifier fields are the following:
| ||||||||||||
purchase_product_family (optional) | Product family identifier | The identifier of the family type which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product family identifier fields are the following:
| ||||||||||||
purchase_amount (optional) | Number | The amount of the purchase that the rewards participant will have to make in order to benefit from the reward offer that will be returned as a result | ||||||||||||
number_of_purchases (optional) | Number | The number of purchases that the rewards participant will have to make in order to benefit from the reward offer that will be returned as a result | ||||||||||||
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 |
Restrictions
- As input parameters one of the following semi-optional parameters must be specified:
- rewards_participant_identifier
- accounts_receivable_identifier
- wallet_identifier
- The rest of the input parameters are optional
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved reward offer |
number | String | The number of the retrieved reward offer |
| name | String | The name of the retrieved reward offer |
| alternative_code | String | The alternative code of the retrieved reward offer |
| description | String | The description of the retrieved reward offer |
| classification | String | The reward offer classification, which can be one of the following:
|
| evaluation_method | String | The method that will be used to evaluate the offers which can be BATCH_PROCESS or INTERACTIVELY |
| award_scope | String | The award scope that defines if the award provided by the reward offer should be applied per transaction or per transaction item, which can be APPLY_AWARD_PER_TRANSACTION or APPLY_AWARD_PER_TRANSACTION_ITEM Deprecated from CRM.COM R17.0.0 |
| spend_method | String | The method that will be used to spend the offers which can be SPEND_ON_REQUEST, SPEND_INSTANTLY, SPEND_INSTANTLY_THROUGH_VOUCHER |
| apply_on_top_of_other_applicable_offers | Boolean | If false then the reward offer will be applicable only if the provided award is the best award among other reward offers that might be applicable. If true then it will be applied irrespective of any other applicable reward offers Deprecated from CRM.COM R17.0.0 |
life_cycle_state | String | The life cycle state of the retrieved lead which can be EFFECTIVE or NOT EFFECTIVE |
| latest_effective_date | Date | The latest effective date of the retrieved reward offer |
| latest_evaluation_date | Date | The latest date that the reward offer was evaluated. This is applicable only for reward offers with evaluation method equal to BATCH |
| terms_and_conditions | String | The terms and conditions for the retrieved reward offer Available from CRM.COM R15.0.0 |
| award_amount | Number | The awarded amount provided by the reward offer. An awarded amount can be specified in all reward offers classifications. Either an awarded amount, award percentage or award percentage on awarded purchases is returned per reward offer. |
| award_percentage | Number | The award percentage of the financial transaction amount that triggered the award. Either an awarded amount, award percentage or award percentage on awarded purchases is returned per reward offer. An offer's awarded percentage can only be specified in the offer is classified as: UTILISE_FREE_CAPACITY, INCREASE_REVENUE_TRANSACTION_BASED, INCREASE_REVENUE_PRODUCT_BASED, REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED and REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED |
| award_percentage_on_previous_awards | Award Percentage on Previous Awards Object | The award percentage on awards submitted within a specific period of time. Award percentage on previous awards can be specified in all reward offers classifications. Available from CRM.COM R10.0.0 |
| award_currency | Currency Object | The currency in which the Reward Offer's award will be provided which can either be in system or the alternative currency. |
| reward_scheme | Reward Scheme Object | The reward scheme of the retrieved reward offer |
| category | Reward Offer Category Object | The category information of the retrieved reward offer |
| owned_by_group | Group object | The group that is owning the reward offer Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit) |
| owned_by_business_unit | Business Unit Object | The business unit that is owning the accounts receivable Available from CRM.COM R18.0.0 |
| marketing_information | Reward Offer Marketing Information Object | The reward offer's marketing information |
| log_information | Log Information Object | The log information related with the retrieved reward offer |
Referred Objects Response Data
currency object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
reward scheme object 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 reward scheme which can be EFFECTIVE or NOT_EFFECTIVE |
award percentage on key performance indicator values response data
Name | Type | Description |
|---|---|---|
| percentage | Number | Defines the award percentage that should be applied on the value of the specified key performance indicator |
| key_performance_indicator | Key Performance Indicator Objects | The key performance indicator that will be awarded based on its value and the specified percentage |
key performance indicator object response data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved customer event key performance indicator |
name | String | The name of the retrieved customer event key performance indicator |
alternative_code | String | The alternative code of the retrieved customer event key performance indicator |
reward_offer_category data object
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved reward offer category |
| name | String | The Name of the retrieved reward offer category |
| code | String | The Code of the retrieved reward offer category |
| description | String | The Description of the retrieved reward offer category |
| parent_id | String | The id of the retrieved category's parent category |
group object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved group |
name | String | The name of the retrieved group |
community_name | String | The name of the community that the retrieved group belongs to |
alternative_code | String | The alternative code of the retrieved group |
| unified_code | String | The unified code of the retrieved group Available from CRM.COM R16.2.2 |
description | String | The description of the retrieved group |
business unit object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
reward offer marketing information object response data
Name | Type | Description |
|---|---|---|
| long_description | String | The offer's long description |
| short_description | String | The offer's short description |
| no_awards_status_text | String | The text that should appear to inform the participant that he has not been awarded yet. Deprecated from CRM.COM R17.0.0 |
| times_awarded_status_text | String | The text that should appear to inform the participant that the number displayed is the times he has been awarded. Deprecated from CRM.COM R17.0.0 |
| average_weekly_awarded_amount_text | String | The text that should appear to inform the participant that the amount displayed is the average weekly awarded amount. Deprecated from CRM.COM R17.0.0 |
| offer_image | Reward Offer Image Object | The reward large (standard) offer image |
| offer_small_image | Reward Offer Image Object | The reward small offer image |
| offer_background | Reward Offer Background Object | The reward offer background which can be an image or a color Deprecated from CRM.COM R17.0.0 |
| offer_stamp_image | Reward Offer Stamp Image Object | The reward offer stamp image Available from CRM.COM R15.0.0 Deprecated from CRM.COM R17.0.0 |
Referred Objects Response Data
Reward offer Marketing Information Image Object
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
Reward scheme Marketing Information Background Object
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
| color | String | The hexadecimal value of the color that will be used as a background |
Reward offer Marketing Information Stamp Image Object
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0 | |
User Object | The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled | |
Unit Object | The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
User Object | The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Examples
Example 1
HTTP Method: POST
Request:
http://cyn1lnx004:9080/crmapi/rest/v2/reward_offers/list
Body:
{
"token":"163317CACB7441CD88CB01C5427DF6E7",
"accounts_receivable_identifier":{"name":"ACR000879"},
"unit_identifier":{"name":"Test"},
"purchase_product":{"code":"TPG Bundle 3"},
"purchase_product_type":{"name":"Accessories"},
"purchase_product_family":{"name":"Analogue"}
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"number": "81",
"name": "Utilise ET",
"privacy_level": null,
"log_information": {
"updated_date": "2016-05-26T09:23:05",
"created_date": "2016-05-26T09:15:09",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"owned_by_group": {
"community_name": "Internal Community",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG1"
},
"life_cycle_state": "EFFECTIVE",
"reward_scheme": {
"life_cycle_state": "EFFECTIVE",
"id": "EA5CCE98F857F3A928E3AA6891323088",
"name": "Sales Scheme",
"description": "Sales Scheme - TC10",
"alternative_code": "SS"
},
"type": {
"classification": "UTILISE_FREE_CAPACITY",
"id": "4ADADCD342A55A483E324F63DE4D54E5",
"name": "Utilise Free Capacity",
"description": "Utilise Free Capacity",
"alternative_code": "UFC"
},
"id": "3064E7C123B64B47B10E8D4802EA10AA",
"spend_conditions_set": {
"allowed_spend_period_after_award": {
"time_period_value": null,
"time_period_uot": null
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
}
},
"description": null,
"award_percentage": null,
"award_conditions_set": {
"product_conditions_set": {
"product_set": [
{
"product_family": {
"id": "63D78575AE1C47513C19765F9AAF857A",
"name": "Analogue",
"description": null,
"code": null
},
"product_type": null,
"product": null
}
]
},
"organisational_unit_conditions_set": [],
"time_conditions_set": {
"days_condition_set": [
[
{
"day_of_week": "TUESDAY"
},
{
"day_of_week": "WEDNESDAY"
},
{
"day_of_week": "THURSDAY"
},
{
"day_of_week": "FRIDAY"
}
]
],
"hours_condition_set": [
{
"from": null,
"to": 23
}
]
}
},
"category": null,
"latest_effective_date": "2016-05-26 09:16:10.0",
"alternative_code": "UE"
}
]
}
Example 2
HTTP Method: POST
Request:
{{server}}/crmapi/rest/v2/reward_offers/list
Body:
{
"token":"{{token}}",
"rewards_participant_identifier":{"number":"RP0000000019"},
"unit_identifier":{"name":"Admin Unit"},
"spend_method":"SPEND_INSTANTLY",
"award_scope":"APPLY_AWARD_PER_TRANSACTION_ITEM"
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"spend_method": "SPEND_INSTANTLY",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"number": "52",
"name": "PK_Reward Offer_1",
"privacy_level": null,
"log_information": {
"updated_date": "2016-07-14T08:49:18",
"created_date": "2016-07-11T13:31:04",
"created_by_unit": {
"community_name": "Community",
"id": "1",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "admin unit",
"alternative_code": "adminunit"
},
"updated_by_unit": {
"community_name": "Community",
"id": "1",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "admin unit",
"alternative_code": "adminunit"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "dev@crm.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "dev@crm.com"
}
},
"owned_by_group": {
"community_name": "Community",
"id": "1",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG"
},
"award_scope": "APPLY_AWARD_PER_TRANSACTION_ITEM",
"life_cycle_state": "EFFECTIVE",
"reward_scheme": {
"life_cycle_state": "EFFECTIVE",
"id": "6CAAD517743C4C179251282A5B2B58A6",
"name": "Marketing Scheme",
"description": null,
"alternative_code": "MS"
},
"type": {
"classification": "UTILISE_FREE_CAPACITY",
"id": "DE7AF5BB04EF442DA745C0CC5346C13D",
"name": "Utilise Free Capacity",
"description": null,
"alternative_code": "UFC"
},
"id": "6644452351BB482483F4A375575D5F73",
"award_percentage": 10,
"description": null,
"spend_conditions_set": {
"allowed_spend_period_after_award": {
"time_period_value": null,
"time_period_uot": null
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
}
},
"award_conditions_set": {
"product_conditions_set": {
"product_set": [
{
"product_family": null,
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "434A205A97FD44A2824CFD2B872D8340",
"name": "PK_Product Type_2",
"description": null,
"alternative_code": "PT_1"
},
"product": null
},
{
"product_family": null,
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "B2AEEFA234BF4B0FBB8423EC9550B418",
"name": "PK_Product Type",
"description": null,
"alternative_code": "PT"
},
"product": null
}
]
},
"organisational_unit_conditions_set": [],
"time_conditions_set": {
"days_condition_set": [
[
{
"day_of_week": "MONDAY"
},
{
"day_of_week": "TUESDAY"
},
{
"day_of_week": "WEDNESDAY"
},
{
"day_of_week": "THURSDAY"
},
{
"day_of_week": "FRIDAY"
},
{
"day_of_week": "SATURDAY"
},
{
"day_of_week": "SUNDAY"
}
]
],
"hours_condition_set": []
}
},
"latest_effective_date": "2016-07-14 08:49:18.0",
"category": null,
"alternative_code": "PO_1"
},
{
"spend_method": "SPEND_INSTANTLY",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"number": "67",
"name": "PK_Reward Offer_3",
"privacy_level": null,
"log_information": {
"updated_date": "2016-07-14T08:49:39",
"created_date": "2016-07-12T09:40:52",
"created_by_unit": {
"community_name": "Community",
"id": "1",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "admin unit",
"alternative_code": "adminunit"
},
"updated_by_unit": {
"community_name": "Community",
"id": "1",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "admin unit",
"alternative_code": "adminunit"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "dev@crm.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "dev@crm.com"
}
},
"owned_by_group": {
"community_name": "Community",
"id": "1",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG"
},
"award_scope": "APPLY_AWARD_PER_TRANSACTION_ITEM",
"life_cycle_state": "EFFECTIVE",
"reward_scheme": {
"life_cycle_state": "EFFECTIVE",
"id": "6CAAD517743C4C179251282A5B2B58A6",
"name": "Marketing Scheme",
"description": null,
"alternative_code": "MS"
},
"type": {
"classification": "UTILISE_FREE_CAPACITY",
"id": "DE7AF5BB04EF442DA745C0CC5346C13D",
"name": "Utilise Free Capacity",
"description": null,
"alternative_code": "UFC"
},
"id": "017CBB2945D24D5A8B591D926246A104",
"award_percentage": null,
"description": null,
"spend_conditions_set": {
"allowed_spend_period_after_award": {
"time_period_value": null,
"time_period_uot": null
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
}
},
"award_conditions_set": {
"product_conditions_set": {
"product_set": [
{
"product_family": null,
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "434A205A97FD44A2824CFD2B872D8340",
"name": "PK_Product Type_2",
"description": null,
"alternative_code": "PT_1"
},
"product": null
},
{
"product_family": null,
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "B2AEEFA234BF4B0FBB8423EC9550B418",
"name": "PK_Product Type",
"description": null,
"alternative_code": "PT"
},
"product": null
}
]
},
"organisational_unit_conditions_set": [],
"time_conditions_set": {
"days_condition_set": [
[
{
"day_of_week": "MONDAY"
},
{
"day_of_week": "TUESDAY"
},
{
"day_of_week": "WEDNESDAY"
},
{
"day_of_week": "THURSDAY"
},
{
"day_of_week": "FRIDAY"
},
{
"day_of_week": "SATURDAY"
},
{
"day_of_week": "SUNDAY"
}
]
],
"hours_condition_set": []
}
},
"latest_effective_date": "2016-07-14 08:49:39.0",
"category": null,
"alternative_code": "PO_3"
}
]
}
Example 2
HTTP Method: GET
Request:
http://cyn1lnx004:8080/crmapi/rest/v2/reward_offers/list
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000285"},
"unit_identifier":{"name":"Admin Unit"}
}
Response:
{
"data": [
{
"award_conditions_set": {
"segment_conditions_set": [
{
"segment": {
"number": "2",
"alternative_code": "EP",
"name": "Effective rewards participants",
"description": null,
"id": "9BCA8988077543B8B1A30D10DEE14440"
},
"option": "EXCLUDE"
}
],
"organisational_unit_conditions_set": [
{
"unit": null,
"group": {
"alternative_code": "EG",
"community_name": "Community",
"name": "External Group",
"description": null,
"id": "641C9485A25246B6B7FE20804E5A81A1"
}
}
],
"nameday_condition": "DURING_NAMEDAY_MONTH"
},
"alternative_code": "ERN",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-14T08:09:44",
"updated_date": "2016-07-14T09:33:10",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RON",
"name": "Reward On Nameday",
"description": null,
"id": "8702D2C8C1A04BC283126F944AF29D37",
"classification": "REWARD_ON_NAMEDAY"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-07-14 08:10:24.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "87",
"award_amount": 2.89,
"name": "ET Reward Nameday",
"id": "8B37E0EAF84C4FC7B8745318F0F6840E",
"category": null
},
{
"award_conditions_set": {
"behavior_conditions": {
"facebook_page_like": "www.crm.com",
"award_facebook_likes": 1,
"award_website_visit": 0
},
"period_conditions": {
"time_period_uot": null,
"time_period_value": null
},
"segment_conditions_set": [
{
"segment": {
"number": "2",
"alternative_code": "EP",
"name": "Effective rewards participants",
"description": null,
"id": "9BCA8988077543B8B1A30D10DEE14440"
},
"option": "INCLUDE"
}
],
"organisational_unit_conditions_set": [
{
"unit": null,
"group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
}
}
]
},
"alternative_code": "RWV2",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-02-10T14:29:40",
"updated_date": "2016-03-23T10:49:43",
"updated_by_user": {
"person_name": "emichailidou",
"id": "9A2CF58F91D94B8B981C33275BA20880",
"email": "crm.com.tst@gmail.com",
"username": "emichailidou"
},
"created_by_user": {
"person_name": "emichailidou",
"id": "9A2CF58F91D94B8B981C33275BA20880",
"email": "crm.com.tst@gmail.com",
"username": "emichailidou"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "SSS",
"name": "Sales Scheme",
"description": "desc",
"id": "3592610A4F01454E97AF71C9E47646FB",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RB",
"name": "Reward Behavior",
"description": null,
"id": "F945D878D86B489B9EC3F2A500E9775F",
"classification": "REWARD_BEHAVIOR"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-03-23 10:48:19.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "9",
"award_amount": 2,
"name": "Reward Website Visits 2euros",
"id": "060E54C6ECDC432D93233FEB3751D700",
"category": null
},
{
"award_conditions_set": {
"location_conditions_set": null,
"just_money_condition": "MULTIPLE",
"segment_conditions_set": [
{
"segment": {
"number": "2",
"alternative_code": "EP",
"name": "Effective rewards participants",
"description": null,
"id": "9BCA8988077543B8B1A30D10DEE14440"
},
"option": "INCLUDE"
}
],
"organisational_unit_conditions_set": [
{
"unit": null,
"group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
}
}
]
},
"alternative_code": "1EA",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-03-24T08:50:01",
"updated_date": "2016-03-24T08:57:43",
"updated_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"email": "crm.com.tst@gmail.com",
"username": "pdemou"
},
"created_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"email": "crm.com.tst@gmail.com",
"username": "pdemou"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "JM",
"name": "Just Money",
"description": null,
"id": "7D67E2BCB70D430B99DB12A42B9EC6E4",
"classification": "JUST_MONEY"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-03-24 08:57:43.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "22",
"award_amount": 10,
"name": "10 Euro award",
"id": "3DE813A206804C1FA1B923750378CA91",
"category": null
},
{
"award_conditions_set": {
"location_conditions_set": {
"location_set": [
{
"area": "",
"city": "Limassol",
"district": ""
}
]
},
"just_money_condition": "ONLY_ONE",
"segment_conditions_set": [
{
"segment": {
"number": "20",
"alternative_code": "RPMT1MA",
"name": "Rewards Participants more than 1 month activated",
"description": null,
"id": "BDEBA651620047E782F99E4ABF544CF4"
},
"option": "EXCLUDE"
}
],
"organisational_unit_conditions_set": []
},
"alternative_code": "EJM",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-12T07:56:33",
"updated_date": "2016-07-14T09:48:19",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "JM",
"name": "Just Money",
"description": null,
"id": "7D67E2BCB70D430B99DB12A42B9EC6E4",
"classification": "JUST_MONEY"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-07-14 09:48:19.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "58",
"award_amount": 65,
"name": "ET Just Money",
"id": "E8E5733EA0F34804BEE8B823D6C61611",
"category": null
},
{
"award_conditions_set": {
"birthday_condition": "ON_BIRTHDAY",
"segment_conditions_set": [
{
"segment": {
"number": "2",
"alternative_code": "EP",
"name": "Effective rewards participants",
"description": null,
"id": "9BCA8988077543B8B1A30D10DEE14440"
},
"option": "INCLUDE"
}
],
"organisational_unit_conditions_set": [
{
"unit": null,
"group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
}
}
]
},
"alternative_code": "5EOB",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-03-24T09:42:58",
"updated_date": "2016-03-24T09:48:41",
"updated_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"email": "crm.com.tst@gmail.com",
"username": "pdemou"
},
"created_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"email": "crm.com.tst@gmail.com",
"username": "pdemou"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "ROB",
"name": "Reward on Birthday",
"description": null,
"id": "771F28B7D0F54EDB8004D6FB302C621B",
"classification": "REWARD_ON_BIRTHDAY"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-03-24 09:48:41.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "26",
"award_amount": 5,
"name": "5 euro on Birthday",
"id": "5DE44D90F5BC4F5889B6A5C2623F6F35",
"category": null
},
{
"award_conditions_set": {
"sign_up_condition": 1,
"segment_conditions_set": [
{
"segment": {
"number": "2",
"alternative_code": "EP",
"name": "Effective rewards participants",
"description": null,
"id": "9BCA8988077543B8B1A30D10DEE14440"
},
"option": "INCLUDE"
}
],
"organisational_unit_conditions_set": [
{
"unit": null,
"group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
}
}
]
},
"alternative_code": "5EFNC",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-03-24T09:48:49",
"updated_date": "2016-03-24T09:51:30",
"updated_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"email": "crm.com.tst@gmail.com",
"username": "pdemou"
},
"created_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"email": "crm.com.tst@gmail.com",
"username": "pdemou"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RS",
"name": "Reward Signups",
"description": null,
"id": "21B8D71630BD4FE6B504E63B7167549E",
"classification": "REWARD_SIGN_UPS"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-03-24 09:51:30.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "27",
"award_amount": 5,
"name": "5 Euros for New Customers",
"id": "F7B4A9BE955244CC879ACE09641ACF79",
"category": null
},
{
"award_conditions_set": {
"transaction_condition": {
"transaction_amount_to": null,
"transaction_period_range_period": {
"time_period_uot": null,
"time_period_value": null
},
"transaction_amount_from": 2
},
"location_conditions_set": {
"location_set": [
{
"area": "Strovolos",
"city": "Limassol",
"district": ""
}
]
},
"segment_conditions_set": [],
"organisational_unit_conditions_set": []
},
"alternative_code": "ERLTAB",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-12T07:46:15",
"updated_date": "2016-07-14T10:26:04",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"award_percentage": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RE",
"name": "RLTA ET",
"description": null,
"id": "4E52DE1E29E24BD4B3A3C547B82B0975",
"classification": "REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-07-14 09:47:27.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "55",
"name": "ET Reward Loyalty Transaction Amount Based",
"id": "5F9F3B3FBF2C45DCB33A5719FB859A42",
"category": null
},
{
"award_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[
{
"day_of_week": "MONDAY"
},
{
"day_of_week": "TUESDAY"
},
{
"day_of_week": "WEDNESDAY"
},
{
"day_of_week": "THURSDAY"
},
{
"day_of_week": "FRIDAY"
},
{
"day_of_week": "SATURDAY"
},
{
"day_of_week": "SUNDAY"
}
]
],
"hours_condition_set": []
},
"transaction_condition": {},
"location_conditions_set": null,
"period_conditions": {
"time_period_uot": null,
"time_period_value": null
},
"product_conditions_set": {
"product_set": [
{
"product_family": null,
"product": {
"code": "Gold",
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "G",
"description": null,
"id": "D1EB074DFD904E54A0C67CAB9DC7E010"
},
"product_type": null
}
]
},
"organisational_unit_conditions_set": []
},
"alternative_code": "owapmc",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-12T11:19:00",
"updated_date": "2016-07-12T11:22:30",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"award_percentage": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "UFC",
"name": "Utilise Free Capacity",
"description": null,
"id": "DE7AF5BB04EF442DA745C0CC5346C13D",
"classification": "UTILISE_FREE_CAPACITY"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-12 11:20:24.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "73",
"name": "offer without any payment medium criteria",
"id": "20C9C4E4F864491699344F1C0BDBF6B2",
"category": null
},
{
"award_conditions_set": {
"transaction_condition": {
"transaction_period_range_period": {
"time_period_uot": null,
"time_period_value": null
},
"transaction_number_from": 1,
"transaction_number_to": null
},
"location_conditions_set": {
"location_set": [
{
"area": "",
"city": "Limassol",
"district": ""
},
{
"area": "Strovolos",
"city": "Limassol",
"district": ""
},
{
"area": "Strovolos",
"city": "Limassol",
"district": "Livadia"
},
{
"area": "Strovolos",
"city": "",
"district": ""
}
]
},
"segment_conditions_set": [],
"organisational_unit_conditions_set": []
},
"alternative_code": "ERLNB",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-12T09:55:07",
"updated_date": "2016-07-14T11:35:13",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RE_1",
"name": "RLTN ET",
"description": null,
"id": "4C23652F5E4B4F1286F3A1A33F20B45D",
"classification": "REWARD_LOYALTY_TRANSACTION_NUMBER_BASED"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-07-14 09:49:09.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "70",
"award_amount": 2.3,
"name": "ET Reward Loyalty Number Based",
"id": "423CC69A0B6D45619FE370AF18CEAF0C",
"category": null
},
{
"award_conditions_set": {
"subscription_maturity_condition": {
"maximum_interruption_period": {
"time_period_uot": "DAYS",
"time_period_value": 0
},
"uninterrupted_subscription_period": {
"time_period_uot": "MONTHS",
"time_period_value": 0
}
},
"segment_conditions_set": [],
"organisational_unit_conditions_set": []
},
"alternative_code": "rmos",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-06-24T06:31:44",
"updated_date": "2016-06-30T09:46:30",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "SSS",
"name": "Sales Scheme",
"description": "desc",
"id": "3592610A4F01454E97AF71C9E47646FB",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": "test reward spend transactions",
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RSM",
"name": "Reward Subscription Maturity",
"description": null,
"id": "F08640E2E4664C66879DB12B673B1E5E",
"classification": "REWARD_SUBSCRIPTION_MATURITY"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-06-24 06:49:21.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "29",
"award_amount": 2,
"name": "reward maturity offer sevia",
"id": "A861F7DE2F8047438E12E00FC9497D07",
"category": null
},
{
"award_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[
{
"day_of_week": "MONDAY"
},
{
"day_of_week": "TUESDAY"
},
{
"day_of_week": "WEDNESDAY"
},
{
"day_of_week": "THURSDAY"
},
{
"day_of_week": "FRIDAY"
},
{
"day_of_week": "SATURDAY"
},
{
"day_of_week": "SUNDAY"
}
]
],
"hours_condition_set": []
},
"transaction_condition": {},
"location_conditions_set": null,
"period_conditions": {
"time_period_uot": null,
"time_period_value": null
},
"product_conditions_set": {
"product_set": [
{
"product_family": null,
"product": null,
"product_type": {
"service_type": null,
"used_for_provisioning": false,
"alternative_code": "PT_1",
"composition_method": "FLAT",
"name": "PK_Product Type_2",
"description": null,
"id": "434A205A97FD44A2824CFD2B872D8340",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
}
},
{
"product_family": null,
"product": null,
"product_type": {
"service_type": null,
"used_for_provisioning": false,
"alternative_code": "PT",
"composition_method": "FLAT",
"name": "PK_Product Type",
"description": null,
"id": "B2AEEFA234BF4B0FBB8423EC9550B418",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
}
}
]
},
"organisational_unit_conditions_set": []
},
"alternative_code": "PO_1",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-11T13:31:04",
"updated_date": "2016-07-14T08:49:18",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"award_percentage": 10,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "UFC",
"name": "Utilise Free Capacity",
"description": null,
"id": "DE7AF5BB04EF442DA745C0CC5346C13D",
"classification": "UTILISE_FREE_CAPACITY"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-14 08:49:18.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "52",
"name": "PK_Reward Offer_1",
"id": "6644452351BB482483F4A375575D5F73",
"category": null
},
{
"award_conditions_set": {
"transaction_condition": {
"transaction_period_range_period": {
"time_period_uot": "WEEKS",
"time_period_value": 1
},
"transaction_number_from": 5,
"transaction_number_to": 20
},
"location_conditions_set": null,
"segment_conditions_set": [],
"organisational_unit_conditions_set": []
},
"alternative_code": "tpmlbn",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-06-29T07:09:03",
"updated_date": "2016-06-29T07:34:28",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RLTNB",
"name": "Reward Loyalty, Transaction Number Based",
"description": null,
"id": "40B41F61958744949EEB5D2A288B4965",
"classification": "REWARD_LOYALTY_TRANSACTION_NUMBER_BASED"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-06-29 07:10:40.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "35",
"award_amount": 5,
"name": "test payment medium loyalty based number",
"id": "8895A94B54FB4EDE9216EF8B3E7FB9F3",
"category": null
},
{
"award_conditions_set": {
"location_conditions_set": null,
"period_conditions": {
"time_period_uot": null,
"time_period_value": null
},
"achievement_conditions_set": {
"classification": [
{
"alternative_code": "CF1",
"name": "Customer Feedback 1",
"id": "5E4CA041768646BCA9AD587A81985BB7"
},
{
"alternative_code": "CF3",
"name": "Customer Feedback 3",
"id": "2D3EDC7CA2F4494BB8313D9F14120AD8"
},
{
"alternative_code": "CF2",
"name": "Customer Feedback 2",
"id": "E27D1F25A1AC4409947F1FF2DDB8CBF5"
}
]
},
"segment_conditions_set": [],
"organisational_unit_conditions_set": []
},
"alternative_code": "cras",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-06-30T07:59:11",
"updated_date": "2016-07-04T15:32:41",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "SSS",
"name": "Sales Scheme",
"description": "desc",
"id": "3592610A4F01454E97AF71C9E47646FB",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": "screens testing",
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RA",
"name": "Reward Achievements",
"description": null,
"id": "A38DFB8AA07141379707FDC5392E245A",
"classification": "REWARD_ACHIEVEMENTS"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-07-01 09:35:02.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "39",
"award_amount": 5,
"name": "check reward achievments sevia",
"id": "63A882A6BC3C4B84BF6A7722FA1445C7",
"category": null
},
{
"award_conditions_set": {},
"alternative_code": "favac",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-04T10:29:25",
"updated_date": "2016-07-04T11:26:19",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": "test all classifications of fin",
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "FA",
"name": "Financial Achievments",
"description": null,
"id": "1F91CA50C16B494A86901861A4681127",
"classification": "REWARD_FINANCIAL_ACHIEVEMENTS"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-04 10:31:24.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "45",
"award_amount": 25,
"name": "financial achievment valid all classifications",
"id": "F31BB448D2C2462EA09F96F00C38A02E",
"category": null
},
{
"award_conditions_set": {},
"alternative_code": "ovc",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-05T06:56:43",
"updated_date": "2016-07-05T06:58:41",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "FA",
"name": "Financial Achievments",
"description": null,
"id": "1F91CA50C16B494A86901861A4681127",
"classification": "REWARD_FINANCIAL_ACHIEVEMENTS"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-05 06:58:41.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "46",
"award_amount": 12,
"name": "offer that validates criteria",
"id": "C309CC842D274BB3BFF7C320005453B4",
"category": null
},
{
"award_conditions_set": {
"behavior_conditions": {
"facebook_page_like": "www.facebook.com/crm",
"award_facebook_likes": 1,
"award_website_visit": 0
},
"period_conditions": {
"time_period_uot": null,
"time_period_value": null
},
"segment_conditions_set": [
{
"segment": {
"number": "2",
"alternative_code": "EP",
"name": "Effective rewards participants",
"description": null,
"id": "9BCA8988077543B8B1A30D10DEE14440"
},
"option": "INCLUDE"
}
],
"organisational_unit_conditions_set": [
{
"unit": null,
"group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
}
}
]
},
"alternative_code": "RFL",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-03-23T14:49:21",
"updated_date": "2016-03-23T14:50:30",
"updated_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"email": "crm.com.tst@gmail.com",
"username": "pdemou"
},
"created_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"email": "crm.com.tst@gmail.com",
"username": "pdemou"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RB",
"name": "Reward Behavior",
"description": null,
"id": "F945D878D86B489B9EC3F2A500E9775F",
"classification": "REWARD_BEHAVIOR"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-03-23 14:50:30.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "16",
"award_amount": 2,
"name": "Reward Facebook Like",
"id": "FCD7DE87377844F4A01BEE03DA51FC92",
"category": null
},
{
"award_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[
{
"day_of_week": "MONDAY"
},
{
"day_of_week": "TUESDAY"
},
{
"day_of_week": "WEDNESDAY"
},
{
"day_of_week": "THURSDAY"
},
{
"day_of_week": "FRIDAY"
},
{
"day_of_week": "SATURDAY"
},
{
"day_of_week": "SUNDAY"
}
]
],
"hours_condition_set": []
},
"transaction_condition": {},
"location_conditions_set": null,
"period_conditions": {
"time_period_uot": null,
"time_period_value": null
},
"product_conditions_set": {
"product_set": [
{
"product_family": null,
"product": null,
"product_type": {
"service_type": null,
"used_for_provisioning": false,
"alternative_code": "PT_1",
"composition_method": "FLAT",
"name": "PK_Product Type_2",
"description": null,
"id": "434A205A97FD44A2824CFD2B872D8340",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
}
},
{
"product_family": null,
"product": null,
"product_type": {
"service_type": null,
"used_for_provisioning": false,
"alternative_code": "PT",
"composition_method": "FLAT",
"name": "PK_Product Type",
"description": null,
"id": "B2AEEFA234BF4B0FBB8423EC9550B418",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
}
}
]
},
"organisational_unit_conditions_set": []
},
"alternative_code": "PO_3",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-12T09:40:52",
"updated_date": "2016-07-14T08:49:39",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"award_percentage": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "UFC",
"name": "Utilise Free Capacity",
"description": null,
"id": "DE7AF5BB04EF442DA745C0CC5346C13D",
"classification": "UTILISE_FREE_CAPACITY"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-14 08:49:39.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "67",
"name": "PK_Reward Offer_3",
"id": "017CBB2945D24D5A8B591D926246A104",
"category": null
},
{
"award_conditions_set": {
"segment_conditions_set": [
{
"segment": {
"number": "37",
"alternative_code": "rats",
"name": "reward award transaction sevia",
"description": null,
"id": "F692BC8A0C7A4895AF8011B9D59936A3"
},
"option": "INCLUDE"
},
{
"segment": {
"number": "38",
"alternative_code": "rsts",
"name": "reward spend transaction sevia",
"description": "test reward maturity offers",
"id": "49156EEEFC514D629063CA13EA384016"
},
"option": "INCLUDE"
}
],
"organisational_unit_conditions_set": [],
"personal_data_completeness_condition": {
"phone_completeness_set": [],
"data_completeness_period": {
"complete_data_from": null,
"complete_data_to": null
},
"address_completeness_set": [],
"email_completeness_set": [],
"award_date_of_birth_completeness": 1
}
},
"alternative_code": "cs",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-06-24T08:31:00",
"updated_date": "2016-06-24T10:12:01",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RDC",
"name": "Reward Data Completeness",
"description": null,
"id": "BC71FA164082431D84D012E74905CC74",
"classification": "REWARD_PERSONAL_DATA_COMPLETENESS"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-06-24 08:32:02.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "30",
"award_amount": 2,
"name": "completnsess sevia",
"id": "05E4FA7EA2DD42C4A4DCEE3EDF34441D",
"category": null
},
{
"award_conditions_set": {},
"alternative_code": "ERFA",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-12T07:58:00",
"updated_date": "2016-07-14T09:49:03",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "FA",
"name": "Financial Achievments",
"description": null,
"id": "1F91CA50C16B494A86901861A4681127",
"classification": "REWARD_FINANCIAL_ACHIEVEMENTS"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-07-14 09:48:35.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "59",
"award_amount": 3.5,
"name": "ET Reward Financial Achievement",
"id": "22A77647D60A4720BDDE06E3AABFA9FF",
"category": null
},
{
"award_conditions_set": {
"transaction_condition": {
"transaction_amount_to": 50,
"transaction_amount_from": 5
},
"location_conditions_set": null,
"period_conditions": {
"time_period_uot": null,
"time_period_value": null
},
"segment_conditions_set": [],
"organisational_unit_conditions_set": []
},
"alternative_code": "S5",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-12T15:11:36",
"updated_date": "2016-07-13T13:59:58",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"award_percentage": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "IRTB",
"name": "Increase Revenue, Transaction Based",
"description": null,
"id": "78C608798CA847869FCFB0FF4999E546",
"classification": "INCREASE_REVENUE_TRANSACTION_BASED"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-13 13:59:58.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "84",
"name": "SB3_Offer 5",
"id": "3EEB11E629A441C08A3A4E6EB504BDFE",
"category": null
},
{
"award_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[
{
"day_of_week": "THURSDAY"
}
]
],
"hours_condition_set": []
},
"transaction_condition": {},
"location_conditions_set": {
"location_set": [
{
"area": "Lakatamia",
"city": "Nicosia",
"district": "Lefkosias"
},
{
"area": "Aglantzia",
"city": "Nicosia",
"district": ""
},
{
"area": "",
"city": "Limassol",
"district": ""
}
]
},
"period_conditions": {
"time_period_uot": "WEEKS",
"time_period_value": 1
},
"product_conditions_set": {
"product_set": []
},
"organisational_unit_conditions_set": []
},
"alternative_code": "UWNC",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-11T09:21:14",
"updated_date": "2016-07-14T11:50:27",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"award_percentage": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "UFCE",
"name": "Utilise Free Capacity ET",
"description": null,
"id": "4B9AD34AA9334F3DB9F6668D1B0E0DB2",
"classification": "UTILISE_FREE_CAPACITY"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-14 09:46:20.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "48",
"name": "ET Utilise Free Capacity",
"id": "EDC5AF03BD394966B326EE63985928B0",
"category": null
},
{
"award_conditions_set": {
"transaction_condition": {
"transaction_amount_to": null,
"transaction_amount_from": 0.5
},
"location_conditions_set": {
"location_set": [
{
"area": "Strovolos",
"city": "",
"district": ""
}
]
},
"period_conditions": {
"time_period_uot": "WEEKS",
"time_period_value": 1
},
"segment_conditions_set": [],
"organisational_unit_conditions_set": []
},
"alternative_code": "EIRTB",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-11T14:01:43",
"updated_date": "2016-07-14T09:46:54",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"award_percentage": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "IRTE",
"name": "Incr. Rev Trans ET",
"description": null,
"id": "02208950880541DBBC655E6006A6DCAD",
"classification": "INCREASE_REVENUE_TRANSACTION_BASED"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-14 09:46:54.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "53",
"name": "ET Increase Revenue Transaction Based ",
"id": "FB88EBA17B714789BB566CE8E1480D1B",
"category": null
},
{
"award_conditions_set": {
"location_conditions_set": {
"location_set": [
{
"area": "",
"city": "Limassol",
"district": ""
}
]
},
"period_conditions": {
"time_period_uot": "YEARS",
"time_period_value": 1
},
"product_conditions_set": [
{
"product_family": null,
"product": {
"code": "Bronze",
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "B",
"description": null,
"id": "F50CC52934BD4F119B6E18E215A4FC55"
},
"product_type": null,
"purchase_event_amount_condition": {
"amount_from": 1.5,
"amount_to": null
}
},
{
"product_family": null,
"product": {
"code": "Expense 1",
"product_type": {
"service_type": "EXPENSE",
"used_for_provisioning": false,
"alternative_code": "006",
"composition_method": "FLAT",
"name": "Fees",
"description": "Fees One Time Services",
"id": "6",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "E1",
"description": null,
"id": "A9917A7895044BEF9499DD6958539D33"
},
"product_type": null,
"purchase_event_amount_condition": {
"amount_from": null,
"amount_to": 2
}
}
],
"segment_conditions_set": [],
"organisational_unit_conditions_set": []
},
"alternative_code": "EIRPB",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-11T14:21:25",
"updated_date": "2016-07-14T09:47:00",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"award_percentage": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "IRPE",
"name": "Inc. Rev Product ET",
"description": null,
"id": "C466037AA96249078BA306E0BC00D2DB",
"classification": "INCREASE_REVENUE_PRODUCT_BASED"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-14 09:47:00.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "54",
"name": "ET Increase Revenue Product Based",
"id": "F8AC0EF7DC034D82946480DB0E6FBE5D",
"category": null
},
{
"award_conditions_set": {
"location_conditions_set": {
"location_set": [
{
"area": "",
"city": "",
"district": "Livadia"
},
{
"area": "Strovolos",
"city": "Limassol",
"district": ""
},
{
"area": "Strovolos",
"city": "",
"district": "Livadia"
}
]
},
"period_conditions": {
"time_period_uot": "MONTHS",
"time_period_value": 6
},
"achievement_conditions_set": {
"classification": [
{
"alternative_code": "CF2",
"name": "Customer Feedback 2",
"id": "E27D1F25A1AC4409947F1FF2DDB8CBF5"
}
]
},
"segment_conditions_set": [],
"organisational_unit_conditions_set": []
},
"alternative_code": "ERA",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-12T07:54:45",
"updated_date": "2016-07-14T12:05:10",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RAE",
"name": "Reward Achievement ET",
"description": null,
"id": "97773F29D5B34912ACD4A4D04D468CF8",
"classification": "REWARD_ACHIEVEMENTS"
},
"evaluation_method": "BATCH_PROCESS",
"latest_effective_date": "2016-07-14 09:47:51.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "57",
"award_amount": 5.6,
"name": "ET Reward Achievement",
"id": "13D82246806B42039111A911B3A2BDE3",
"category": null
},
{
"award_conditions_set": {
"behavior_conditions": {
"facebook_page_like": "www.facebook.com/polina",
"award_facebook_likes": 1,
"award_website_visit": 0
},
"period_conditions": {
"time_period_uot": "MONTHS",
"time_period_value": 1
},
"segment_conditions_set": [],
"organisational_unit_conditions_set": []
},
"alternative_code": "ERB",
"reward_offer_validity": {
"validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
},
"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": "2016-07-12T07:51:26",
"updated_date": "2016-07-13T15:13:27",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"privacy_level": null,
"reward_scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"life_cycle_state": "EFFECTIVE",
"spend_conditions_set": {
"time_conditions_set": {
"days_condition_set": [
[]
],
"hours_condition_set": []
},
"product_conditions_set": [],
"organisational_unit_conditions_set": [],
"allowed_spend_period_after_award": {
"time_period_uot": null,
"time_period_value": null
}
},
"type": {
"alternative_code": "RE_2",
"name": "RB ET",
"description": null,
"id": "3430C4A0167D44EDA7808DB2A85A2603",
"classification": "REWARD_BEHAVIOR"
},
"evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
"latest_effective_date": "2016-07-13 15:13:27.0",
"reward_award_validity": {
"validity_options": "ALWAYS_VALID"
},
"number": "56",
"award_amount": 3.25,
"name": "ET Reward Behavior",
"id": "62093E7885EE42088CA25F1E7BB3B685",
"category": null
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
GET reward_offers/performance
Available from CRM.COM R12.2.0
This method returns information related with the performance of a rewards participant against a specific reward offer. A single reward offer performance is returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
| reward_offer_identifier (mandatory) | Rewards Offer identifier | The identifier of the reward offer that should be returned as a result. The allowed reward offer identifier fields are the following:
| ||||||||||||
| rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The identifier of the rewards participant for which the performance should be returned. The allowed rewards participant 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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
| total_number_of_awards | Number | The number of awards the rewards participant received from the specified offer during the last 12 months. |
| average_weekly_awarded_amount | Number | The average amount of money per week awarded from this offer during the last 12 months |
| targeted_number_of_purchases | Number | The number of purchases that should be done in order for the offer to be awarded. This information comes from the reward offer, if the offer is of classification REWARD_LOYALTY_TRANSACTION_NUMBER_BASED or REWARD_LOYALTY_TRANSACTION_QUANTITY_ITEM_BASED From R14.7.0, the Rewards Offer setting "Apply Only If No Spend Requests Were Submitted" is also taken into consideration, so that if enabled, only the purchases which are not related with spend requests are calculated |
| current_number_of_purchases | Number | The number of purchases that were done so far if the offer is of classification REWARD_LOYALTY_TRANSACTION_NUMBER_BASED or REWARD_LOYALTY_TRANSACTION_QUANTITY_ITEM_BASED. The counted purchases must fulfill all the offer's award conditions, should have not been processed for being awarded yet and the purchases are performed within the offer's transaction period range condition. From R14.7.0, the Rewards Offer setting "Apply Only If No Spend Requests Were Submitted" is also taken into consideration, so that if enabled, only the purchases which are not related with spend requests are calculated |
| targeted_purchased_amount | Number | The total amount of purchases that should be done in order for the offer to be awarded. This information comes from the reward offer, if the offer is of classification REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED From R14.7.0, the Rewards Offer setting "Apply Only If No Spend Requests Were Submitted" is also taken into consideration, so that if enabled, only the purchases which are not related with spend requests are calculated |
| current_purchased_amount | Number | The amount of money that was purchased so far if the offer is of classification REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED. The purchased amount must fulfill all the offer's award conditions, should have not been processed for being awarded yet and the purchases are performed within the offer's transaction period range condition. From R14.7.0, the Rewards Offer setting "Apply Only If No Spend Requests Were Submitted" is also taken into consideration, so that if enabled, only the purchases which are not related with spend requests are calculated |
| targeted_date | Date | The date up to which that amount of money should be purchased from the first date of the transaction, if the offer is of classification REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED or REWARD_LOYALTY_TRANSACTION_NUMBER_BASED or REWARD_LOYALTY_TRANSACTION_QUANTITY_ITEM_BASED |
| expiration_date | Date | The date the reward offer will expire. If the date is during birthday or nameday then the date is calculated dynamically based on participant's birthday or nameday respectively. |
| latest_awarded_date | Date | The latest date that the reward offer was awarded |
| marketing_information | Reward Offer Marketing Information Object | The reward offer's marketing information |
Referred Objects Response Data
reward offer marketing information object response data
Name | Type | Description |
|---|---|---|
| long_description | String | The offer's long description |
| short_description | String | The offer's short description |
| no_awards_status_text | String | The text that should appear to inform the participant that he has not been awarded yet. Deprecated from CRM.COM R17.0.0 |
| times_awarded_status_text | String | The text that should appear to inform the participant that the number displayed is the times he has been awarded. Deprecated from CRM.COM R17.0.0 |
| average_weekly_awarded_amount_text | String | The text that should appear to inform the participant that the amount displayed is the average weekly awarded amount. Deprecated from CRM.COM R17.0.0 |
| offer_image | Reward Offer Image Object | The reward large (standard) offer image |
| offer_small_image | Reward Offer Image Object | The reward small offer image |
| offer_background | Reward Offer Background Object | The reward offer background which can be an image or a color Deprecated from CRM.COM R17.0.0 |
| offer_stamp_image | Reward Offer Stamp Image Object | The reward offer stamp image Available from CRM.COM R15.0.0 Deprecated from CRM.COM R17.0.0 |
Referred Objects Response Data
Reward offer Marketing Information Image Object
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
Reward scheme Marketing Information Background Object
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
| color | String | The hexadecimal value of the color that will be used as a background |
Reward offer Marketing Information Stamp Image Object
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file. |
| file_content_url | String | The url that can be used to access the actual content of the file. |
| file_mime_type | String | The mime type of the attached file |
| file_alt_text | String | The alternative text of the attached file, if the file is an image |
Examples
Example 1
HTTP Method: GET
Request:
{{server}}/crmapi/rest/v2/reward_offers/performance?token={{token}}&reward_offer_identifier=number=254&rewards_participant_identifier=number=RP0000000364
Response:
{
"data": {
"total_number_of_awards": 1,
"average_weekly_awarded_amount": 5,
"targeted_date": "2017-07-19T11:44:59",
"latest_awarded_date": "2017-06-08T14:29:43",
"expiration_date": "Always Valid",
"targeted_number_of_purchases": 3,
"marketing_information": {
"short_description": null,
"times_awarded_status_text": null,
"average_weekly_awarded_amount_text": null,
"long_description": null,
"no_awards_status_text": null,
"offer_image": {
"file_alt_text": null,
"file_content_url": null
},
"offer_background": {
"color": null,
"file_alt_text": null,
"file_mime_type": null
}
},
"current_number_of_purchases": 1
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
- No labels