You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 4
Next »
rewards participant schemes object parameter data
Name | Type | Description |
---|
action
(mandatory) | String | Defines if a new or existing information will be updated.The supported values are the following: ADD, UPDATE, REMOVE |
sign_up_on (mandatory and applicable only on add and update) | Date | The date that the rewards participant signed up for that specific reward scheme |
reference_code (mandatory on conditions and only on add and update) | String | The unique reference code that was used while signing up to that specific reward scheme. This is available and mandatory only if it is required by the specific reward scheme |
sign_up_by_unit_identifier (mandatory and applicable only on add and update | Unit identifier | The unit that signed up the rewards participant to that specific reward scheme. The allowed unit identifier fields are the following: Name | Type | Description |
---|
id (semi-optional) | String | The ID of the Unit | name (semi-optional) | String | The name of the Unit | alternative_code (semi-optional) | String | The alternative code of the Unit |
|
sign_off_on | Date | The date that the rewards participant signed off from that specific reward scheme |
rewards_participant_scheme_identifier (mandatory and applicable only on update or remove) | Rewards Participant Scheme Identifier | The identifier of the activity service to be updated. The allowed activity service identifier fields are the following: Name | Type | Description |
---|
id (mandatory) | String | The ID of the reward participant participating scheme |
|
reward_scheme_identifier (mandatory and applicable only on add) | Reward Scheme Identifier | The reward scheme that the rewards participant has joint. The allowed reward scheme identifier fields are the following: Name | Type | Description |
---|
id (semi-optional) | String | The ID of the reward scheme | name (semi-optional) | String | The name of the reward scheme | alternative_code (semi-optional) | String | The alternative code of the reward scheme |
|