Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
access_token_parameters object data
Name | Type | Description |
action
(mandatory) | String | Defines if a new or existing access token should be used. The supported values are the following: ADD_NEW, ADD_EXISTING, REMOVE The NEW option can be used only if access tokens are allowed to be created on creating reward participants, as specified in access token definitions |
access_token_identifier (mandatory on add existing and remove) | Access Token identifier | An existing access token that should be used. This is applicable and mandatory if the action is set to ADD_EXISTING or REMOVE. Only effective access tokens can be used. The allowed access token identifier fields are the following: Name | Type | Description |
|---|
authentication_code (semi-optional) | String | The authentication code of the access token | identifier (semi-optional) | String | The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code | pass_code (mandatory on conditions) | String | The pass code of the access token, which is applicable and mandatory if the identifier is specified |
|
authentication_code (mandatory on add new) | String | The authentication code of the access token that will be created. This information is not mandatory if set to be generated automatically, in the definition or the classification. Applicable only if the action is set to ADD_NEW |
identifier (mandatory on add new) | String | The identifier of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code. Applicable and if the action is set to ADD_NEW |
pass_code (mandatory on add new) | String | The pass code of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified. Applicable and if the action is set to ADD_NEW |
classification_identifier (optional) | Access Token Classification Identifier | The identifier of the access token classification that will be related with the access token. Applicable and if the action is set to ADD_NEW. The allowed access token classification identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the classification | name (semi-optional) | String | The name of the classification | alternative_code (semi-optional) | String | The alternative code of the classification |
|
udf_string_1 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW |
udf_string_2 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW |
udf_string_3 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW |
udf_string_4 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW |
udf_string_5 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW |
udf_string_6 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW |
udf_string_7 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW |
udf_string_8 (optional) | String | User Defined Field of type String. Applicable only if the action is set to ADD_NEW |
udf_float_1 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to ADD_NEW |
udf_float_2 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to ADD_NEW |
udf_float_3 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to ADD_NEW |
udf_float_4 (optional) | Float | User Defined Field of type Float. Applicable only if the action is set to ADD_NEW |
udf_date_1 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to ADD_NEW |
udf_date_2 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to ADD_NEW |
udf_date_3 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to ADD_NEW |
udf_date_4 (optional) | Date | User Defined Field of type Date. Applicable only if the action is set to ADD_NEW |