| Tip |
|---|
| Excerpt |
|---|
This method returns information related with a reward offer. A single reward offer is returned by each call |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| reward_offer_identifier (mandatory) | Reward Offer 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 |
...
| Expand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
HTTP Method: GET
Request:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
| |||||||||
| Expand | |||||||||
|
| Code Block |
|---|
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=46 |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"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": ""
}
} |
| title | Example 3 |
|---|
HTTP Method: GET
Request:
| Code Block |
|---|
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=87 |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"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": ""
}
} |
| title | Example 4 |
|---|
HTTP Method: GET
Request:
| Code Block |
|---|
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=48 |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"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": ""
}
} |
| title | Example 5 |
|---|
HTTP Method: GET
Request:
| Code Block |
|---|
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=187 |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"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": ""
}
} |
| title | Example 6 |
|---|
HTTP Method: GET
Request:
| Code Block |
|---|
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=226 |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"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": ""
}
} |
| title | Example 7 |
|---|
HTTP Method: GET
Request:
| Code Block |
|---|
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=229 |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"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": ""
}
} |
| title | Example 8 |
|---|
HTTP Method: GET
Request:
| Code Block |
|---|
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=258 |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"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": ""
}
} |
| title | Example 9 |
|---|
HTTP Method: GET
Request:
| Code Block |
|---|
{{server}}/crmapi/rest/v2/reward_offers/show?token={{token}}&reward_offer_identifier=number=317 |
Response:
| Code Block | ||
|---|---|---|
| ||
|
| Expand | |||||||
|---|---|---|---|---|---|---|---|
| |||||||
HTTP Method: GET Request:
Response:
|