Versions Compared

Old Version 41

changes.mady.by.user George Rossides

Saved on

compared with

New Version 42

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R5.0.0

Table of Contents
maxLevel2

...

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:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

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

...

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:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

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:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

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:

Include Page
V4:wallet_identifier
V4:wallet_identifier

Tip

Available from CRM.COM R10.0.0

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

...

Name

Type

Description

token

String

The token retrieved from the login method

sign_up_on

(mandatory)

DateThe 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:

Include Page
V4:unit_identifier
V4:unit_identifier

enable_automatic_spend

(optional)

Boolean

Defines whether the rewards participant requires automatic spend on purchase events or not

Tip

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

accounts_receivable

(mandatory)

Accounts receivable objectThe 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

access_token

(mandatory)

Access Token object

The access token that will be associated with the rewards participant

Tip

Deprecated starting from CRM.COM R8.0.0 onward

participating_schemes_set

(optional)

Set of Rewards Participant Scheme ObjectsA list of reward schemes that the rewards participant has joint

access_tokens_set

(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

 

Tip

Available from CRM.COM R8.0.0

fields_set

(optional)

List of Strings, comma separated 
Tip

Available from CRM.COM R10.0.0


Anchor
rewards participant create referred objects parameters
rewards participant create referred objects parameters
Referred Parameters Objects Data

...

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:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

sign_up_on

(optional)

DateThe 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:

Include Page
V4:unit_identifier
V4:unit_identifier

enable_automatic_spend

(optional)

Boolean

Defines whether the rewards participant requires automatic spend on purchase events or not

Tip

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

access_token

(optional)

Access Token object

The access token that will be associated with the rewards participant

Tip

Deprecated starting from CRM.COM R8.0.0

participating_schemes_set

(optional)

Set of Rewards Participant Scheme Objects

A list of reward schemes that the rewards participant has joint

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

access_tokens_set

(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:

Code Block
themeConfluence
languagejavascript
linenumberstrue
"set": [
	   		{
            	"action": "add_existing",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add_new",
            	...........
			}
		]
Tip

Available from CRM.COM R8.0.0

Anchor
rewards participant update referred objects parameters
rewards participant update referred objects parameters
Referred Parameters Objects Data

Tip

Deprecated starting from CRM.COM R8.0.0

Include Page
V4:access_token_parameters
V4:access_token_parameters

Tip

Available from CRM.COM R8.0.0

Include Page
V4:access_token_update_parameters
V4:access_token_update_parameters

...

POST rewards_participants/enable_spend_blocking

Tip

Available from CRM.COM R10.1.0

This method enables a rewards participant's spend requests blockin. A single rewards participant can be modified in each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant

(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:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

fields_set

(optional)

List of Strings, comma separated 

 

...

POST rewards_participants/disable_spend_blocking

Tip

Available from CRM.COM R10.1.0

This method disables a rewards participant's spend requests blocking. A single rewards participant can be modified in each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant

(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:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

fields_set

(optional)

List of Strings, comma separated 

 

...

POST rewards_participants/calculate_total_awarded_amount

Tip

Available from CRM.COM R10.1.0

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.

...

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant

(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:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

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:

Include Page
V4:reward_scheme_identifier
V4:reward_scheme_identifier

from_date

(optional)

DateIf 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)

DateIf 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 

 

...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

 

Response:

Code Block
  {
  "token":"{{token}}",
  "rewards_participant":{"number":"1"},
  "from_date":"2016-03-23T12:00:40",
  "to_date":"2016-03-29T09:00:00"
  }

 

Response:

Code Block
 {
  "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": ""
  }
}