Name | Type | Description |
---|
validity_options | String | Defines the reward offer's validity options. The available values are VALID_FROM_LATEST_EFFECTIVE_DATE and VALID_FOR_SPECIFIC_PERIOD, VALID_DURING_BIRTHDAY_WEEK_MONTH, VALID_DURING_NAME_DAY_WEEK_MONTH, VALID_DURING_RECURRING_PERIOD
|
validity_birthday_period | String | Defines if the offer will be valid during birthday week or birthday month. The supported options are VALID_DURING_BIRTHDAY_WEEK and VALID_DURING_BIRTHDAY_MONTH. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_WEEK_MONTH
|
validity_name_day_period | String | Defines if the offer will be valid during name day week or name day month. The supported options are VALID_DURING_NAME_DAY_WEEK and VALID_DURING_NAME_DAT_MONTH. Applicable only when the reward offer's validity option is set to VALID_DURING_NAME_DAY_WEEK_MONTH
|
validity_periods_set | Set of Reward Offer Validity Period objects | The periods during which the retrieved reward offer will be valid. Applicable only when the reward offer's validity option is set to VALID_FOR_SPECIFIC_PERIOD. |
validity_recurring_periods_set | Set of Reward Offer Validity Recurring Period objects | The recurring periods during which the retrieved reward offer will be valid. Applicable only when the reward offer's validity option is set to VALID_DURING_RECURRING_PERIOD
|
Referred Objects Response Data
reward_offer_validity_periods response data object
Name | Type | Description |
---|
id | String | The ID of the retrieved reward offer validity period |
valid_from | Date | The date from which the reward offer will be valid |
valid_to | Date | The date that the reward offer should become invalid. This is optional as reward offer can be valid for ever, starting from a specific date |
reward_offer_validity_recurring_periods response data object
Name | Type | Description |
---|
id | String | The ID of the retrieved reward offer validity recurring period |
valid_from | Recurring Period Object | The recurring period that the reward offer should become valid. |
valid_to | Recurring Period Object | The recurring period that the reward offer should become invalid. |
Referred Objects Response Data
recurring period object response data
Name | Type | Description |
---|
day | Integer | The day of the recurring period which can be from 1 up to 31 (depending on the retrieved month) |
month | Integer | The month of the recurring period which can be from 1 up to 12 |