POST rewards_participants/show
This method returns information related with a rewards participants. A single rewards participant is returned by each call
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
| rewards_participant_identifier (mandatory) | Rewards Participant identifier | The identifier of the rewards participant that should be returned as a result. The allowed rewards participant 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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rewards participant |
number | String | The number of the retrieved rewards participant |
| sign_up_on | Date | The date that the rewards participant signed up |
| life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED Available from CRM.COM R12.0.0 |
udf_string_1 | String | User DefinedField of type String |
udf_string_2 | String | User DefinedField of type String |
udf_string_3 | String | User DefinedField of type String |
udf_string_4 | String | User DefinedField of type String |
udf_string_5 | String | User DefinedField of type String |
udf_string_6 | String | User DefinedField of type String |
udf_string_7 | String | User DefinedField of type String |
udf_string_8 | String | User DefinedField of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Log Information object | The log informationrelatedwiththeretrieved job | |
| accounts_receivable | Accounts receivable object | The accounts receivable owned by the rewards participant |
| sign_up_by_unit | Unit object | The unit that signed up the rewards participant |
| access_token | Access Token object | The access token associated with the rewards participant Deprecated starting from CRM.COM R8.0.0 onward |
| currency | Currencyobject | The reward participant's currency Available from CRM.COM R10.0.0 |
| auto_spend_authorisation | Auto Spend Settings Object | The reward's participant's automaticspendsettings Available from CRM.COM R11.0.0 |
| spend_blocking_state | Rewards Participant Spend Requests Blocking State object | The rewards participant's spend requests blocking state Available from CRM.COM R10.1.0 |
| termination_information | Rewards Participant Termination Information object | The Rewards Participant's termination information. Applicable only for Rewards Participants in TERMINATED life cycle state. Available from CRM.COM R12.0.0 |
| wallet | Wallet Object | The wallet related to the rewards participant Available from CRM.COM R12.1.0 |
| participating_schemes_set | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint. |
| access_tokens_set | Set of Access Token Objects | A list of all the access tokens that are related with the rewards participant Available from CRM.COM R8.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"476A07F7C99133EA35D9AEA25475C8C1",
"rewards_participant_identifier":{"number":"29"}
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"sign_up_on": "2015-02-03T09:00:35",
"udf_float_1": null,
"udf_float_2": null,
"udf_date_1": null,
"udf_float_3": null,
"udf_date_2": null,
"number": "29",
"udf_float_4": null,
"udf_date_3": null,
"sign_up_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Marketing Unit",
"id": "83922FE923563679768A94F58CAB5569",
"description": "r1c1",
"alternative_code": null
},
"udf_date_4": null,
"udf_string_1": null,
"udf_string_2": null,
"participating_schemes_set":
[
{
"sign_up_on": "2015-02-03T09:00:08",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "Test1",
"id": "C423FFDD9CE9AF60A67B7F29F539630F",
"description": "test 1",
"alternative_code": "t1"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "Marketing Unit",
"id": "83922FE923563679768A94F58CAB5569",
"description": "r1c1",
"alternative_code": null
},
"id": "1E9B85861D57DCC6C7F6244FDEB20563"
},
{
"sign_up_on": "2015-02-03T09:00:05",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "Marketing Scheme",
"id": "07EBDDD9B4FC19C98AB5052B4FAEF51A",
"description": "Marketing Scheme",
"alternative_code": "MS"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "Marketing Unit",
"id": "83922FE923563679768A94F58CAB5569",
"description": "r1c1",
"alternative_code": null
},
"id": "A7A7AE5993FBC466357688715F94833D"
}
],
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"log_information":
{
"updated_date": "2015-02-03T09:00:44",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2015-02-03T08:59:39",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
}
},
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": "Andreas",
"company_profile": null,
"title": "Ms",
"type": "PERSON",
"first_name": "Lucia",
"name": null,
"id": "1D92B269658D80DEDF2499E25201739E",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_number": "113115",
"social_security_number": "113116",
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1990
},
"name_day":
{
"month": 5,
"day": 5
},
"id_number": "113114"
}
},
"life_cycle_state": "ACTIVE",
"number": "400",
"name": "Lukia Papapavlou",
"id": "F42134513AD119E00CA031A93A5CA4DD"
},
"id": "00C07F53EEBE02A7224370B832BBEE96",
"access_token":
{
"authentication_code": "apitestemptynew",
"life_cycle_state": "EFFECTIVE",
"identifier": "apitestempty1",
"number": "40",
"id": "E05B9FA2C2B1E993817FBB7B96B4A24B"
}
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"rewards_participant_identifier": {"number":"RP0000000017"}
}
Response:
{
"data": {
"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-03-28T11:43:10",
"updated_date": "2016-03-28T13:21:23",
"updated_by_user": {
"person_name": "p_kestora",
"id": "3BF7083426A7443CA7960041E5846F1E",
"email": "p_kestora@crm.com",
"username": "p_kestora"
},
"created_by_user": {
"person_name": "p_kestora",
"id": "3BF7083426A7443CA7960041E5846F1E",
"email": "p_kestora@crm.com",
"username": "p_kestora"
}
},
"udf_date_2": "2016-02-28T15:49:59",
"udf_date_1": "2016-01-28T15:49:59",
"udf_date_4": "2016-04-28T15:49:59",
"udf_date_3": "2016-03-28T15:49:59",
"participating_schemes_set": [
{
"scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"sign_up_on": "2016-03-30T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"id": "C3A9B399D85B4551B455606EFF1A1F8C",
"sign_off_on": null
},
{
"scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"sign_up_on": "2016-03-30T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"id": "1033EB60C8874B87B07D83FF5C347CF1",
"sign_off_on": "2016-03-28T12:56:34"
},
{
"scheme": {
"alternative_code": "SSS",
"name": "Sales Scheme",
"description": "desc",
"id": "3592610A4F01454E97AF71C9E47646FB",
"life_cycle_state": "EFFECTIVE"
},
"sign_up_on": "2016-03-28T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"id": "064D0BE76E484CBDA008996A803C85BD",
"sign_off_on": null
}
],
"number": "RP0000000017",
"udf_float_3": 30,
"udf_float_4": 40,
"sign_up_on": "2016-03-28T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "DD3941F2FE1A4342BBBDCB42E5F83D2D",
"udf_float_1": 10,
"udf_float_2": 20,
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_1": "udf string 1",
"accounts_receivable": {
"number": "ACR0000000157",
"name": "Janet Markinson",
"id": "55075828AD7848608DCA2386C0608550",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Janet Markinson",
"last_name": "Markinson",
"id": "286DDA9BBFEC42E9916A3941C7D8DDB0",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Janet",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"access_tokens_set": [
{
"authentication_code": "PolinaKTest4",
"number": "AT0000000062",
"identifier": "polina.kestora4@crm.com",
"id": "01490FDC2F08479E80883A12E7B01FFF",
"life_cycle_state": "EFFECTIVE",
"classification": null
},
{
"authentication_code": "PolinaKTest8",
"number": "AT0000000066",
"identifier": "polina.kestora8@crm.com",
"id": "FCD00F003CAD49C8BFD8A24673DCE7F2",
"life_cycle_state": "EFFECTIVE",
"classification": null
}
],
"udf_string_8": "udf string 8"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
GET rewards_participants/list
This method returns information related with rewards participants. Multiple rewards participants are returned by each call
Resource URL
Parameters
Name | Type | Description | |||||||||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable identifier | The identifier of the accounts receivable related with the rewards participant that should be returned as a result. The allowed accounts receivable identifier fields are the following:
| |||||||||||||||||||||
| contact_information_identifier (semi-optional) | Contact Information identifier | The identifier of the contact information related with the rewards participant that should be returned as a result. The allowed contact information identifier fields are the following:
| |||||||||||||||||||||
wallet_identifier (semi-optional) | Wallet identifier | The identifier of the wallet elated with the rewards participant that should be returned as a result. The allowed wallet 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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rewards participant |
number | String | The number of the retrieved rewards participant |
| sign_up_on | Date | The date that the rewards participant signed up |
| life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED Available from CRM.COM R12.0.0 |
udf_string_1 | String | User DefinedField of type String |
udf_string_2 | String | User DefinedField of type String |
udf_string_3 | String | User DefinedField of type String |
udf_string_4 | String | User DefinedField of type String |
udf_string_5 | String | User DefinedField of type String |
udf_string_6 | String | User DefinedField of type String |
udf_string_7 | String | User DefinedField of type String |
udf_string_8 | String | User DefinedField of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Log Information object | The log informationrelatedwiththeretrieved job | |
| accounts_receivable | Accounts receivable object | The accounts receivable owned by the rewards participant |
| sign_up_by_unit | Unit object | The unit that signed up the rewards participant |
| access_token | Access Token object | The access token associated with the rewards participant Deprecated starting from CRM.COM R8.0.0 onward |
| currency | Currencyobject | The reward participant's currency Available from CRM.COM R10.0.0 |
| auto_spend_authorisation | Auto Spend Settings Object | The reward's participant's automaticspendsettings Available from CRM.COM R11.0.0 |
| spend_blocking_state | Rewards Participant Spend Requests Blocking State object | The rewards participant's spend requests blocking state Available from CRM.COM R10.1.0 |
| termination_information | Rewards Participant Termination Information object | The Rewards Participant's termination information. Applicable only for Rewards Participants in TERMINATED life cycle state. Available from CRM.COM R12.0.0 |
| wallet | Wallet Object | The wallet related to the rewards participant Available from CRM.COM R12.1.0 |
| participating_schemes_set | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint. |
| access_tokens_set | Set of Access Token Objects | A list of all the access tokens that are related with the rewards participant Available from CRM.COM R8.0.0 |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"number": "11",
"id": "D6576EBBEDF74533E9C2C0CEE2FAD3BA",
"participating_schemes_set":
[
{
"sign_up_on": "2014-11-12T18:27:27",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "Test1",
"id": "C423FFDD9CE9AF60A67B7F29F539630F",
"description": "test 1",
"alternative_code": "t1"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "test2",
"id": "89E2B186191FBE7ECD6D52F4E2CF159C",
"description": null,
"alternative_code": null
},
"id": "9B6E22B799B8DA18FC08C8A77DB1C7FF"
}
]
},
{
"number": "14",
"id": "DC132E6318D12DE67087260F8F6C76D3",
"participating_schemes_set":
[
{
"sign_up_on": "2014-11-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "Test1",
"id": "C423FFDD9CE9AF60A67B7F29F539630F",
"description": "test 1",
"alternative_code": "t1"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "VK Unit",
"id": "F164DB175FA6C345680426F7C17DF803",
"description": null,
"alternative_code": "VKU"
},
"id": "935C5CA0F843CB3D7AB9438897489285"
},
{
"sign_up_on": "2014-12-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "test 2",
"id": "FDC8FD6BC50FD648952C5804820033A4",
"description": null,
"alternative_code": "t2"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "VK Unit",
"id": "F164DB175FA6C345680426F7C17DF803",
"description": null,
"alternative_code": "VKU"
},
"id": "026AC9C981D52F5F4DF69CC77974334C"
}
]
},
{
"number": "16",
"id": "8D585084E77D8EA5AE3E5B13649A1139",
"participating_schemes_set":
[
{
"sign_up_on": "2014-08-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "test 2",
"id": "FDC8FD6BC50FD648952C5804820033A4",
"description": null,
"alternative_code": "t2"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "Marketing Unit",
"id": "83922FE923563679768A94F58CAB5569",
"description": "r1c1",
"alternative_code": null
},
"id": "0BF0E353817E3D8F36F07CBE79A62CBC"
},
{
"sign_up_on": "2014-05-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "Test1",
"id": "C423FFDD9CE9AF60A67B7F29F539630F",
"description": "test 1",
"alternative_code": "t1"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "Sales Branch 2",
"id": "C7304329F4787BC7845052332B180A0E",
"description": null,
"alternative_code": "SB2"
},
"id": "A3FBB9718D3B3AFE1505F39A489ED4A4"
}
]
}
]
}
HTTP Method: GET
Request:
Response:
{
"data": [
{
"number": "RP0000000010",
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "942D9960056A497FB3BC65EDDF7D8D81"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST rewards_participants/create
This method creates a rewards participant. Single rewards participants can be created by each call.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
sign_up_on (mandatory) | Date | The date that the rewards participant signed up | ||||||||||||
sign_up_by_unit_identifier (mandatory) | Unit identifier | The unit that signed up the rewards participant. The allowed unit identifier fields are the following:
| ||||||||||||
enable_automatic_spend (optional) | Boolean | Defines whether the rewards participant requires automatic spend on purchase events or not Available from CRM.COM R11.0.0 | ||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||||||
(mandatory) | Accounts receivable object | The accounts receivable owned by the rewards participant that identifies the CRM.COM customer, and handles all financial transactions that might be posted as a result of award or spend reward transactions | ||||||||||||
(mandatory) | Access Token object | The access token that will be associated with the rewards participant Deprecated starting from CRM.COM R8.0.0 onward | ||||||||||||
(optional) | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint | ||||||||||||
(mandatory on conditions) | Set of Access Token Objects | The access tokens that will be associated with the rewards participant. This information is mandatory if the active access token definition is set up to require at least one access token for each rewards participant
Available from CRM.COM R8.0.0 | ||||||||||||
fields_set (optional) | List of Strings, comma separated | Available from CRM.COM R10.0.0 |
Referred Parameters Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rewards participant |
number | String | The number of the retrieved rewards participant |
| sign_up_on | Date | The date that the rewards participant signed up |
| life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED Available from CRM.COM R12.0.0 |
udf_string_1 | String | User DefinedField of type String |
udf_string_2 | String | User DefinedField of type String |
udf_string_3 | String | User DefinedField of type String |
udf_string_4 | String | User DefinedField of type String |
udf_string_5 | String | User DefinedField of type String |
udf_string_6 | String | User DefinedField of type String |
udf_string_7 | String | User DefinedField of type String |
udf_string_8 | String | User DefinedField of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Log Information object | The log informationrelatedwiththeretrieved job | |
| accounts_receivable | Accounts receivable object | The accounts receivable owned by the rewards participant |
| sign_up_by_unit | Unit object | The unit that signed up the rewards participant |
| access_token | Access Token object | The access token associated with the rewards participant Deprecated starting from CRM.COM R8.0.0 onward |
| currency | Currencyobject | The reward participant's currency Available from CRM.COM R10.0.0 |
| auto_spend_authorisation | Auto Spend Settings Object | The reward's participant's automaticspendsettings Available from CRM.COM R11.0.0 |
| spend_blocking_state | Rewards Participant Spend Requests Blocking State object | The rewards participant's spend requests blocking state Available from CRM.COM R10.1.0 |
| termination_information | Rewards Participant Termination Information object | The Rewards Participant's termination information. Applicable only for Rewards Participants in TERMINATED life cycle state. Available from CRM.COM R12.0.0 |
| wallet | Wallet Object | The wallet related to the rewards participant Available from CRM.COM R12.1.0 |
| participating_schemes_set | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint. |
| access_tokens_set | Set of Access Token Objects | A list of all the access tokens that are related with the rewards participant Available from CRM.COM R8.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"A0931BF523A24C819181DC9487343F45",
"sign_up_on":"2014-07-05T15:49:59",
"fields_set":"number,sign_up_by_unit,id,participating_schemes_set,accounts_receivable",
"sign_up_by_unit_identifier":{"name":"Sales Department 1"},
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59",
"accounts_receivable":
{
"action":"EXISTING",
"accounts_receivable_identifier":{"number":"ACR000525"}
},
"participating_schemes_set":
[
{
"sign_up_on": "2014-05-05T15:49:59" ,
"sign_up_by_unit_identifier":{"name":"Sales Department 1"},
"reward_scheme_identifier":{"name":"Marketing Reward Scheme"}
},
{
"sign_up_on": "2014-08-05T15:49:59" ,
"sign_up_by_unit_identifier":{"name":"Sales Department 2"},
"reward_scheme_identifier":{"name":"Sales Scheme"}
}
],
"access_tokens_set" :
[
{
"authentication_code" : "125672734874",
"identifier" : "12365464899",
"pass_code" : "awe$qew!"
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"accounts_receivable": {
"account_owner": {
"last_name": "Mika",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Ms",
"first_name": "Dina",
"type": "PERSON",
"id": "9ED00E7228634EF986807DF4D86A3F84",
"name": "Mika Dina",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "14587522",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000525",
"id": "C8A54A6BB4B9423AA560D6B955CD1271",
"name": "Dina Mika"
},
"number": "147",
"sign_up_by_unit": {
"community_name": "Internal Community",
"id": "A01DEAA885B5B0F14769F983A2F6A16E",
"name": "Sales Department 1",
"group_name": "Sales Manager Group",
"description": null,
"alternative_code": "SD1"
},
"id": "E64F366E3E66476E96E8494BB9F917EA",
"participating_schemes_set": [
{
"sign_up_on": "2014-05-05T15:49:59",
"sign_off_on": null,
"scheme": {
"life_cycle_state": "EFFECTIVE",
"id": "E339CFB9284E8BB291E63CC42E574E88",
"name": "Marketing Reward Scheme",
"description": "Marketing Reward Scheme for Sales Department, CRM Team 1, Marketing Team",
"alternative_code": "MRS"
},
"sign_up_by_unit": {
"community_name": "Internal Community",
"id": "A01DEAA885B5B0F14769F983A2F6A16E",
"name": "Sales Department 1",
"group_name": "Sales Manager Group",
"description": null,
"alternative_code": "SD1"
},
"id": "DA225B0204144370A2EF0687C37A8B70"
},
{
"sign_up_on": "2014-08-05T15:49:59",
"sign_off_on": null,
"scheme": {
"life_cycle_state": "EFFECTIVE",
"id": "EA5CCE98F857F3A928E3AA6891323088",
"name": "Sales Scheme",
"description": "Sales Scheme - TC10",
"alternative_code": "SS"
},
"sign_up_by_unit": {
"community_name": "Internal Community",
"id": "CA8896C911589FEDB384001606C2440E",
"name": "Sales Department 2",
"group_name": "Sales Manager Group",
"description": "Sales Department 2 under Sales Manager Group",
"alternative_code": "SD2"
},
"id": "3315CBDCA46D48A9875EE70AD53DA19A"
}
]
}
}
HTTP Method: POST
Request:
Body:
{
"token":"A0931BF523A24C819181DC9487343F45",
"sign_up_on":"2014-07-05T15:49:59",
"fields_set":"number,sign_up_by_unit,id,participating_schemes_set,accounts_receivable,access_tokens_set",
"sign_up_by_unit_identifier":{"name":"Sales Department 1"},
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59",
"accounts_receivable":
{
"action":"EXISTING",
"accounts_receivable_identifier":{"number":"ACR001131"}
},
"participating_schemes_set":
[
{
"sign_up_on": "2014-05-05T15:49:59" ,
"sign_up_by_unit_identifier":{"name":"Sales Department 1"},
"reward_scheme_identifier":{"name":"Marketing Reward Scheme"}
},
{
"sign_up_on": "2014-08-05T15:49:59" ,
"sign_up_by_unit_identifier":{"name":"Sales Department 2"},
"reward_scheme_identifier":{"name":"Sales Scheme"}
}
],
"access_tokens_set" :
[
{
"authentication_code" : "1256727348874",
"identifier" : "123654647899",
"pass_code" : "awe$qew!"
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"accounts_receivable": {
"account_owner": {
"last_name": "kyriakou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "maria",
"type": "PERSON",
"id": "6BDA97F3B1EA4276A297B424474E7DD3",
"name": "kyriakou maria",
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "3423423423",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001131",
"id": "0D3BC55501814EF5B9797865C657119B",
"name": "ACR001131"
},
"access_tokens_set": [
{
"authentication_code": "1256727348874",
"life_cycle_state": "EFFECTIVE",
"classification": null,
"number": "ACT0000000340",
"identifier": "123654647899",
"id": "233807C6EE234BEF8B909238AD28D684"
}
],
"number": "148",
"sign_up_by_unit": {
"community_name": "Internal Community",
"id": "A01DEAA885B5B0F14769F983A2F6A16E",
"name": "Sales Department 1",
"group_name": "Sales Manager Group",
"description": null,
"alternative_code": "SD1"
},
"id": "5168BB2790064693BAA2B4C4C9A8866F",
"participating_schemes_set": [
{
"sign_up_on": "2014-08-05T15:49:59",
"sign_off_on": null,
"scheme": {
"life_cycle_state": "EFFECTIVE",
"id": "EA5CCE98F857F3A928E3AA6891323088",
"name": "Sales Scheme",
"description": "Sales Scheme - TC10",
"alternative_code": "SS"
},
"sign_up_by_unit": {
"community_name": "Internal Community",
"id": "CA8896C911589FEDB384001606C2440E",
"name": "Sales Department 2",
"group_name": "Sales Manager Group",
"description": "Sales Department 2 under Sales Manager Group",
"alternative_code": "SD2"
},
"id": "E528D181A16B4E6EB1B8BA6AE3FB12D2"
},
{
"sign_up_on": "2014-05-05T15:49:59",
"sign_off_on": null,
"scheme": {
"life_cycle_state": "EFFECTIVE",
"id": "E339CFB9284E8BB291E63CC42E574E88",
"name": "Marketing Reward Scheme",
"description": "Marketing Reward Scheme for Sales Department, CRM Team 1, Marketing Team",
"alternative_code": "MRS"
},
"sign_up_by_unit": {
"community_name": "Internal Community",
"id": "A01DEAA885B5B0F14769F983A2F6A16E",
"name": "Sales Department 1",
"group_name": "Sales Manager Group",
"description": null,
"alternative_code": "SD1"
},
"id": "A5BB367B54BB4B08A8864002F1181B88"
}
]
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"sign_up_on":"2016-03-28T15:00:00",
"sign_up_by_unit_identifier":{"name":"Admin Unit"},
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2016-01-28T15:49:59",
"udf_date_2":"2016-02-28T15:49:59",
"udf_date_3":"2016-03-28T15:49:59",
"udf_date_4":"2016-04-28T15:49:59",
"accounts_receivable":
{
"action":"NEW",
"name":"Jane Austin",
"classification_identifier":{"name":"Residential Customer"},
"credit_rating_code":"AAA",
"contact_information":{
"action":"NEW",
"type":"PERSON",
"first_name":"Jane",
"last_name":"Markinson"
}
},
"access_token":{
"action": "ADD_NEW2",
"authentication_code":"PolinaKTesting2",
"identifier":"PolinaKTesting2",
"pass_code":"12342"
},
"participating_schemes_set":
[
{
"sign_up_on": "2016-03-28T15:00:00" ,
"sign_up_by_unit_identifier":{"name":"Admin Unit"},
"reward_scheme_identifier":{"name":"Marketing Scheme"}
},
{
"sign_up_on": "2016-03-28T15:00:00" ,
"sign_up_by_unit_identifier":{"name":"Admin Unit"},
"reward_scheme_identifier":{"name":"Sales Scheme"}
}
],
"access_tokens_set" :
[
{
"action": "ADD_NEW",
"authentication_code":"1234879456",
"identifier":"testAT@crm.com",
"pass_code":"1234879456a!"
}
]
}
Response:
{
"data": {
"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-05T08:35:42",
"updated_date": "2016-07-05T08:35:44",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"udf_date_2": "2016-02-28T15:49:59",
"udf_date_1": "2016-01-28T15:49:59",
"udf_date_4": "2016-04-28T15:49:59",
"udf_date_3": "2016-03-28T15:49:59",
"participating_schemes_set": [
{
"scheme": {
"alternative_code": "SSS",
"name": "Sales Scheme",
"description": "desc",
"id": "3592610A4F01454E97AF71C9E47646FB",
"life_cycle_state": "EFFECTIVE"
},
"sign_up_on": "2016-03-28T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"id": "1F4D25D0C22D4F47818751D2ABB56979",
"sign_off_on": null
},
{
"scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"sign_up_on": "2016-03-28T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"id": "56BC61EDEBB749B2B92862CB74E00AFC",
"sign_off_on": null
}
],
"number": "RP0000000051",
"udf_float_3": 30,
"udf_float_4": 40,
"sign_up_on": "2016-03-28T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "D97CA2ADBD274CD69AC1A27D41E06BF2",
"udf_float_1": 10,
"udf_float_2": 20,
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_1": "udf string 1",
"accounts_receivable": {
"number": "ACR0000000272",
"name": "Jane Austin",
"id": "9BBF752EC5A5473C8403A0E59BA9B787",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Jane Markinson",
"last_name": "Markinson",
"id": "F3B3D4F601844A88AF5CEED733DBE478",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Jane",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"access_tokens_set": [
{
"authentication_code": "1234879456",
"number": "AT0000000121",
"identifier": "testAT@crm.com",
"id": "B417DE8C9FC74FC4A9A92795A8D3FC1A",
"life_cycle_state": "EFFECTIVE",
"classification": null
}
],
"udf_string_8": "udf string 8"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST rewards_participants/update
This method updates rewards participants. A single rewards participant can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
| rewards_participant_identifier (mandatory) | Rewards Participant identifier | The identifier of the rewards participant that should be updated. The allowed rewards participant identifier fields are the following:
| ||||||||||||
sign_up_on (optional) | Date | The date that the rewards participant signed up | ||||||||||||
sign_up_by_unit_identifier (optional) | Unit identifier | The unit that signed up the rewards participant. The allowed unit identifier fields are the following:
| ||||||||||||
enable_automatic_spend (optional) | Boolean | Defines whether the rewards participant requires automatic spend on purchase events or not Available from CRM.COM R11.0.0 | ||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||||||
(optional) | Access Token object | The access token that will be associated with the rewards participant Deprecated starting from CRM.COM R8.0.0 | ||||||||||||
(optional) | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
| ||||||||||||
(mandatory on conditions) | Set of Access Token Objects | The access tokens that will be associated with the rewards participant. This information is mandatory if the active access token definition is set up to require at least one access token for each rewards participant If no records are specified in the set then nothing will be updated. To remove a record use action:"remove". To add a record use action:"add_existing" or "add_new". Different actions can be used within the same set. For example: "set": [
{
"action": "add_existing",
...........
},
{
"action": "remove",
...........
},
{
"action": "add_new",
...........
}
]
Available from CRM.COM R8.0.0 |
Referred Parameters Objects Data
Deprecated starting from CRM.COM R8.0.0
Available from CRM.COM R8.0.0
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rewards participant |
number | String | The number of the retrieved rewards participant |
| sign_up_on | Date | The date that the rewards participant signed up |
| life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED Available from CRM.COM R12.0.0 |
udf_string_1 | String | User DefinedField of type String |
udf_string_2 | String | User DefinedField of type String |
udf_string_3 | String | User DefinedField of type String |
udf_string_4 | String | User DefinedField of type String |
udf_string_5 | String | User DefinedField of type String |
udf_string_6 | String | User DefinedField of type String |
udf_string_7 | String | User DefinedField of type String |
udf_string_8 | String | User DefinedField of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Log Information object | The log informationrelatedwiththeretrieved job | |
| accounts_receivable | Accounts receivable object | The accounts receivable owned by the rewards participant |
| sign_up_by_unit | Unit object | The unit that signed up the rewards participant |
| access_token | Access Token object | The access token associated with the rewards participant Deprecated starting from CRM.COM R8.0.0 onward |
| currency | Currencyobject | The reward participant's currency Available from CRM.COM R10.0.0 |
| auto_spend_authorisation | Auto Spend Settings Object | The reward's participant's automaticspendsettings Available from CRM.COM R11.0.0 |
| spend_blocking_state | Rewards Participant Spend Requests Blocking State object | The rewards participant's spend requests blocking state Available from CRM.COM R10.1.0 |
| termination_information | Rewards Participant Termination Information object | The Rewards Participant's termination information. Applicable only for Rewards Participants in TERMINATED life cycle state. Available from CRM.COM R12.0.0 |
| wallet | Wallet Object | The wallet related to the rewards participant Available from CRM.COM R12.1.0 |
| participating_schemes_set | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint. |
| access_tokens_set | Set of Access Token Objects | A list of all the access tokens that are related with the rewards participant Available from CRM.COM R8.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"A0931BF523A24C819181DC9487343F45",
"rewards_participant_identifier": {"number":"76"},
"access_tokens_set":
[
{
"action" : "add_existing",
"access_token_identifier" : { "authentication_code" : "15855832543" }
},
{
"action" : "remove",
"access_token_identifier" : { "authentication_code" : "1256723" }
}
]
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"sign_up_on": "2014-07-05T15:49:59",
"udf_float_1": 10,
"udf_float_2": 20,
"udf_date_1": "2014-05-05T15:49:59",
"udf_float_3": 30,
"udf_date_2": "2014-06-05T15:49:59",
"udf_float_4": 40,
"number": "76",
"sign_up_by_unit":
{
"community_name": "Internal Community",
"id": "A01DEAA885B5B0F14769F983A2F6A16E",
"name": "Sales Department 1",
"group_name": "Sales Manager Group",
"description": null,
"alternative_code": "SD1"
},
"udf_date_3": "2014-07-05T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"participating_schemes_set":
[
{
"sign_up_on": "2014-08-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"id": "EA5CCE98F857F3A928E3AA6891323088",
"name": "Sales Scheme",
"description": "Sales Scheme - TC10",
"alternative_code": "SS"
},
"sign_up_by_unit":
{
"id": "CA8896C911589FEDB384001606C2440E",
"name": "Sales Department 2",
"description": "Sales Department 2 under Sales Manager Group",
"alternative_code": "SD2"
},
"id": "C15176CD387C45D78BBB328113CD9BCE"
},
{
"sign_up_on": "2014-05-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"id": "E339CFB9284E8BB291E63CC42E574E88",
"name": "Marketing Reward Scheme",
"description": "Marketing Reward Scheme for Sales Department, CRM Team 1, Marketing Team",
"alternative_code": "MRS"
},
"sign_up_by_unit":
{
"id": "A01DEAA885B5B0F14769F983A2F6A16E",
"name": "Sales Department 1",
"description": null,
"alternative_code": "SD1"
},
"id": "0740FCC927CB47C0B0E2DF3D0AC2E2AB"
}
],
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_6": "udf string 6",
"log_information":
{
"updated_date": "2015-10-15T13:04:53",
"created_date": "2015-10-15T12:46:02",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Tyler",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Rose",
"type": "PERSON",
"id": "2666B580BF60454C97D5DB2DDCD50BAE",
"name": null,
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day":
{
"month": null,
"day": null
},
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"id_number": "4324",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000783",
"id": "0B06C58003B4456281DC97B73C5050EE",
"name": "ACREC-04-RT"
},
"access_tokens_set":
[
{
"authentication_code": "15855832543",
"life_cycle_state": "EFFECTIVE",
"number": "102",
"identifier": "1241544",
"id": "1BC0D7F84FBC4ABCA04229BEABC6E90B"
}
],
"id": "E1581BDEE0C642A2877806B94C70ADA0"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"rewards_participant_identifier": {"number":"RP0000000051"},
"access_tokens_set":
[
{
"action" : "add_existing",
"access_token_identifier" : { "authentication_code" : "222" }
},
{
"action" : "remove",
"access_token_identifier" : { "authentication_code" : "1234879456" }
}
]
}
Response:
{
"data": {
"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-05T08:35:42",
"updated_date": "2016-07-05T08:43:42",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"udf_date_2": "2016-02-28T15:49:59",
"udf_date_1": "2016-01-28T15:49:59",
"udf_date_4": "2016-04-28T15:49:59",
"udf_date_3": "2016-03-28T15:49:59",
"participating_schemes_set": [
{
"scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"sign_up_on": "2016-03-28T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"id": "56BC61EDEBB749B2B92862CB74E00AFC",
"sign_off_on": null
},
{
"scheme": {
"alternative_code": "SSS",
"name": "Sales Scheme",
"description": "desc",
"id": "3592610A4F01454E97AF71C9E47646FB",
"life_cycle_state": "EFFECTIVE"
},
"sign_up_on": "2016-03-28T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"id": "1F4D25D0C22D4F47818751D2ABB56979",
"sign_off_on": null
}
],
"number": "RP0000000051",
"udf_float_3": 30,
"udf_float_4": 40,
"sign_up_on": "2016-03-28T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "D97CA2ADBD274CD69AC1A27D41E06BF2",
"udf_float_1": 10,
"udf_float_2": 20,
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_1": "udf string 1",
"accounts_receivable": {
"number": "ACR0000000272",
"name": "Jane Austin",
"id": "9BBF752EC5A5473C8403A0E59BA9B787",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Jane Markinson",
"last_name": "Markinson",
"id": "F3B3D4F601844A88AF5CEED733DBE478",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Jane",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"access_tokens_set": [
{
"authentication_code": "222",
"number": "AT0000000034",
"identifier": "2222222",
"id": "F60CA93E227342E88571AD1E30C39867",
"life_cycle_state": "EFFECTIVE",
"classification": null
}
],
"udf_string_8": "udf string 8"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST rewards_participants/enable_spend_blocking
This method enables a rewards participant's spend requests blockin. A single rewards participant can be modified in each call.
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The rewards participant whose spend requests blocking state will be enabled/disabled. The allowed rewards participant identifier fields are the following:
| |||||||||
fields_set (optional) | List of Strings, comma separated |
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rewards participant |
number | String | The number of the retrieved rewards participant |
| sign_up_on | Date | The date that the rewards participant signed up |
| life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED Available from CRM.COM R12.0.0 |
udf_string_1 | String | User DefinedField of type String |
udf_string_2 | String | User DefinedField of type String |
udf_string_3 | String | User DefinedField of type String |
udf_string_4 | String | User DefinedField of type String |
udf_string_5 | String | User DefinedField of type String |
udf_string_6 | String | User DefinedField of type String |
udf_string_7 | String | User DefinedField of type String |
udf_string_8 | String | User DefinedField of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Log Information object | The log informationrelatedwiththeretrieved job | |
| accounts_receivable | Accounts receivable object | The accounts receivable owned by the rewards participant |
| sign_up_by_unit | Unit object | The unit that signed up the rewards participant |
| access_token | Access Token object | The access token associated with the rewards participant Deprecated starting from CRM.COM R8.0.0 onward |
| currency | Currencyobject | The reward participant's currency Available from CRM.COM R10.0.0 |
| auto_spend_authorisation | Auto Spend Settings Object | The reward's participant's automaticspendsettings Available from CRM.COM R11.0.0 |
| spend_blocking_state | Rewards Participant Spend Requests Blocking State object | The rewards participant's spend requests blocking state Available from CRM.COM R10.1.0 |
| termination_information | Rewards Participant Termination Information object | The Rewards Participant's termination information. Applicable only for Rewards Participants in TERMINATED life cycle state. Available from CRM.COM R12.0.0 |
| wallet | Wallet Object | The wallet related to the rewards participant Available from CRM.COM R12.1.0 |
| participating_schemes_set | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint. |
| access_tokens_set | Set of Access Token Objects | A list of all the access tokens that are related with the rewards participant Available from CRM.COM R8.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"D2C2B14EE43E42AA80DFF05CB8E3F635",
"rewards_participant_identifier":{"number":"RP0000000086"}
}
Response:
{
"data": {
"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-09-13T09:47:15",
"updated_date": "2016-09-13T09:54:18",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"participating_schemes_set": [],
"number": "RP0000000086",
"udf_float_3": null,
"udf_float_4": null,
"sign_up_on": "2014-09-13T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9"
},
"id": "51D6C9C39B8445D488F67766F3F2AE3A",
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": "2",
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"accounts_receivable": {
"number": "ACR0000000010",
"name": "ACR0000000010 Joe Rogan",
"id": "F98FFAE225DB47B3BDC32E8FDA81ACFC",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Joe Rogan",
"last_name": "Rogan",
"id": "20798E691E4541B8A078CCB12239B9D4",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Joe",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"spend_blocking_state": {
"updated_date": "Tue Sep 13 09:54:18 EEST 2016",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"enabled": true
},
"udf_string_6": null,
"udf_string_7": "7",
"access_tokens_set": [],
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST rewards_participants/disable_spend_blocking
This method disables a rewards participant's spend requests blocking. A single rewards participant can be modified in each call.
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The rewards participant whose spend requests blocking state will be enabled/disabled. The allowed rewards participant identifier fields are the following:
| |||||||||
fields_set (optional) | List of Strings, comma separated |
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rewards participant |
number | String | The number of the retrieved rewards participant |
| sign_up_on | Date | The date that the rewards participant signed up |
| life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED Available from CRM.COM R12.0.0 |
udf_string_1 | String | User DefinedField of type String |
udf_string_2 | String | User DefinedField of type String |
udf_string_3 | String | User DefinedField of type String |
udf_string_4 | String | User DefinedField of type String |
udf_string_5 | String | User DefinedField of type String |
udf_string_6 | String | User DefinedField of type String |
udf_string_7 | String | User DefinedField of type String |
udf_string_8 | String | User DefinedField of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Log Information object | The log informationrelatedwiththeretrieved job | |
| accounts_receivable | Accounts receivable object | The accounts receivable owned by the rewards participant |
| sign_up_by_unit | Unit object | The unit that signed up the rewards participant |
| access_token | Access Token object | The access token associated with the rewards participant Deprecated starting from CRM.COM R8.0.0 onward |
| currency | Currencyobject | The reward participant's currency Available from CRM.COM R10.0.0 |
| auto_spend_authorisation | Auto Spend Settings Object | The reward's participant's automaticspendsettings Available from CRM.COM R11.0.0 |
| spend_blocking_state | Rewards Participant Spend Requests Blocking State object | The rewards participant's spend requests blocking state Available from CRM.COM R10.1.0 |
| termination_information | Rewards Participant Termination Information object | The Rewards Participant's termination information. Applicable only for Rewards Participants in TERMINATED life cycle state. Available from CRM.COM R12.0.0 |
| wallet | Wallet Object | The wallet related to the rewards participant Available from CRM.COM R12.1.0 |
| participating_schemes_set | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint. |
| access_tokens_set | Set of Access Token Objects | A list of all the access tokens that are related with the rewards participant Available from CRM.COM R8.0.0 |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"D2C2B14EE43E42AA80DFF05CB8E3F635",
"rewards_participant_identifier":{"number":"RP0000000086"}
}
Response:
{
"data": {
"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-09-13T09:47:15",
"updated_date": "2016-09-13T09:51:47",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"participating_schemes_set": [],
"number": "RP0000000086",
"udf_float_3": null,
"udf_float_4": null,
"sign_up_on": "2014-09-13T15:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9"
},
"id": "51D6C9C39B8445D488F67766F3F2AE3A",
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": "2",
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"accounts_receivable": {
"number": "ACR0000000010",
"name": "ACR0000000010 Joe Rogan",
"id": "F98FFAE225DB47B3BDC32E8FDA81ACFC",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Joe Rogan",
"last_name": "Rogan",
"id": "20798E691E4541B8A078CCB12239B9D4",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Joe",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"spend_blocking_state": {
"updated_date": "Tue Sep 13 09:51:47 EEST 2016",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"enabled": false
},
"udf_string_6": null,
"udf_string_7": "7",
"access_tokens_set": [],
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST rewards_participants/calculate_total_awarded_amount
This method calculates the total awarded amount that was provided to a specific rewards participant and the amount that was awarded by each scheme that the rewards participant participated to. A single rewards participant can be specified in each call.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The rewards participant for which the awarded amount will be calculated for. The allowed rewards participant identifier fields are the following:
| ||||||||||||
reward_scheme_identifier (optional) | Reward Scheme Identifier | The reward scheme that awarded the calculated amount. If specified then the calculation will include only awards provided by the specified reward scheme. The allowed reward scheme identifier fields are the following:
| ||||||||||||
from_date (optional) | Date | If specified then the calculation will include only awards that were provided on that date or on a date after that date will be | ||||||||||||
to_date (optional) | Date | If specified then the calculation will include only awards that were provided on that date or on a date before that date will be | ||||||||||||
fields_set (optional) | List of Strings, comma separated |
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
| total_awarded_amount | Number | The total amount that was awarded to the specific rewards participant in rewards participant's currency |
| total_awarded_alternative_amount | Number | The total amount that was awarded to the specific rewards participant in rewards participant's alternative currency, if any. Available form CRM.COM R14.2.0 |
| from_date | Date | The date that the first award was applied |
| to_date | Date | The date that the last award was applied |
| currency | Currency object | The reward participant's currency |
| alternative_currency | Currency Object | The reward participant's alternative currency Available form CRM.COM R14.2.0 |
| reward_scheme_awards_set | Set of Reward Scheme Awards Objects | A list of awards provided by reward schemes that the rewards participant participated to |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"rewards_participant":{"number":"1"},
"from_date":"2016-03-23T12:00:40",
"to_date":"2016-03-29T09:00:00"
}
Response:
{
"data": {
"from_date": "2016-03-23T13:43:34",
"to_date": "2016-03-29T08:57:34",
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9"
},
"reward_scheme_awards_set": [
{
"scheme": {
"alternative_code": "SSS",
"name": "Sales Scheme",
"description": "desc",
"id": "3592610A4F01454E97AF71C9E47646FB",
"life_cycle_state": "EFFECTIVE"
},
"total_awarded_amount": 6
},
{
"scheme": {
"alternative_code": "MS",
"name": "Marketing Scheme",
"description": null,
"id": "6CAAD517743C4C179251282A5B2B58A6",
"life_cycle_state": "EFFECTIVE"
},
"total_awarded_amount": 27
}
],
"total_awarded_amount": 33
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}