Name | Type | Description |
---|
id | String | The ID of the retrieved rewards participant participating reward scheme |
sign_up_on | Date | The date that the rewards participant signed up for that specific reward scheme |
sign_off_on | Date | The date that the rewards participant signed off from that specific reward scheme |
reference_code | Sting | The unique reference code that was used while signing up to that specific reward scheme. This is available only if it is required by the specific reward scheme |
sign_up_by_unit | Unit object | The unit that signed up the rewards participant to that specific reward scheme |
sign_up_by_business_unit | Business Unit object | The business unit that signed up the rewards participant to that specific reward scheme |
scheme | Reward Scheme Object | The reward scheme that the rewards participant has joint |
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 |
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 |