Tip
Available from CRM.COM R5.0.0

Table of Contents

maxLevel	2

...

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

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
      {
    "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"
                }
            ]
        }
    ]
}

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)

...

sign_up_by_unit_identifier

(mandatory)

...

The unit that signed up the rewards participant. The allowed unit identifier fields are the following:

...

udf_string_1

(optional)

...

User Defined Field of type String

...

udf_string_2

(optional)

...

User Defined Field of type String

...

udf_string_3

(optional)

...

User Defined Field of type String

udf_string_4

...

Expand

title	Example 2

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "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

...

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

...

Examples

...

title	Example 1

HTTP Method: POST

Request:

Body:

...

theme	Confluence
language	javascript
linenumbers	true

...

Available from CRM.COM R10.0.0

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:

Include Page

	V4:unit_identifier
	V4:unit_identifier

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_52

(optional)

String

User Defined Field of type String

udf_string_63

(optional)

String

User Defined Field of type String

udf_string_74

(optional)

String

User Defined Field of type String

udf_string_85

(optional)

String

User Defined Field of type String

udf_floatstring_16

(optional)Float

String

User Defined Field of type FloatString

udf_floatstring_27

(optional)Float

String

User Defined Field of type FloatString

udf_floatstring_38

(optional)Float

String

User Defined Field of type FloatString

udf_float_41

(optional)

Float

User Defined Field of type Float

udf_datefloat_1 2

(optional)

DateFloat

User Defined Field of type DateFloat

udf_datefloat_2 3

(optional)

DateFloat

User Defined Field of type DateFloat

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

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 Objects

A 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

...

_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

Include Page

	V4:accounts_receivable_parameters
	V4:accounts_receivable_parameters

Include Page

	V4:access_token_parameters
	V4:access_token_parameters

Include Page

	V4:rewards_participant_schemes_parameter
	V4:rewards_participant_schemes_parameter

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Include Page

	V4:rewards_participant_complete
	V4:rewards_participant_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

  {
  "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:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "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"
      }
    ]
  }
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

  {
  "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:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "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"
    },
     "participatingaccess_schemestokens_set": [
  [    {
 {        "signauthentication_up_oncode": "2014-05-05T15:49:59" ,1256727348874",
        "signlife_up_by_unit_identifier":{"name":"Sales Department 1"}cycle_state": "EFFECTIVE",
        "classification": null,
        "number": "ACT0000000340",
        "reward_scheme_identifier":{ "name":"Marketing Reward Scheme"}123654647899",
        },"id": "233807C6EE234BEF8B909238AD28D684"
      }
{    ],
   "sign_up_on": "2014-08-05T15:49:59"  "number": "148",
       "sign_up_by_unit_identifier": {"name":"Sales
Department 2"},        "reward_scheme_identifier":{"community_name": "SalesInternal SchemeCommunity"},
     } "id": "A01DEAA885B5B0F14769F983A2F6A16E",
 ],     "access_tokens_setname": :"Sales Department 1",
  [    "group_name": "Sales Manager Group",
 {     "description": null,
      "authenticationalternative_code" : "125672734874SD1",
       },
    "identifierid" : "123654648995168BB2790064693BAA2B4C4C9A8866F",
            "pass_code" : "awe$qew!""participating_schemes_set": [
      {
 }     ]  }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "status": {"sign_up_on": "2014-08-05T15:49:59",
        "messagesign_off_on": ""null,
    "description": "",     "codescheme": "OK"{
  },   "data": {     "accountslife_cycle_receivablestate": {"EFFECTIVE",
          "account_ownerid": {"EA5CCE98F857F3A928E3AA6891323088",
          "last_name": "MikaSales Scheme",
          "middle_namedescription": null,"Sales Scheme - TC10",
          "lifealternative_cycle_statecode": "FINANCIALSS",
        "company_profile": null},
        "titlesign_up_by_unit": "Ms",{
          "firstcommunity_name": "DinaInternal Community",
          "typeid": "PERSONCA8896C911589FEDB384001606C2440E",
          "idname": "9ED00E7228634EF986807DF4D86A3F84Sales Department 2",
          "group_name": "MikaSales Manager DinaGroup",
          "company_namedescription": null,"Sales Department 2 under Sales     "demographics": {Manager Group",
          "genderalternative_code": null,"SD2"
          "passport_issued_by_country": null},
          "social_security_number"id": null,"E528D181A16B4E6EB1B8BA6AE3FB12D2"
      },
   "passport_number": null,  {
        "industrysign_up_sectoron": null"2014-05-05T15:49:59",
          "countrysign_ofoff_residenceon": {
   null,
        "three_character_codescheme": "USA",
 {
          "twolife_charactercycle_codestate": "USEFFECTIVE",
            "id": "127E339CFB9284E8BB291E63CC42E574E88",
            "name": "UNITEDMarketing Reward STATESScheme",
            "alternative_codedescription": null"Marketing Reward Scheme for Sales Department, CRM Team 1, Marketing  }Team",
          "namealternative_daycode": { "MRS"
        },
        "month": null,
sign_up_by_unit": {
          "community_name": "dayInternal Community":,
null           }"id": "A01DEAA885B5B0F14769F983A2F6A16E",
          "date_of_birthname": {"Sales Department 1",
          "monthgroup_name": null,"Sales Manager Group",
          "daydescription": null,
            "yearalternative_code": null"SD1"
          },
 
        "id_number": "14587522",A5BB367B54BB4B08A8864002F1181B88"
      }
    ]
  }
}

Expand

title	Example 3

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "industrytoken": null,
          "id_issued_by_country": null
        }
      },
  "{{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",
   "lifeudf_cyclestring_state4":"udf string 4"ACTIVE",
      "number"udf_string_5": "ACR000525"udf string 5",
      "id"udf_string_6":"udf string 6"C8A54A6BB4B9423AA560D6B955CD1271",
      "name"udf_string_7":"udf "Dinastring Mika"
    }7",
    "numberudf_string_8":"udf string 8"147",
    "signudf_upfloat_by_unit1": {10,
      "community_name": "Internal Community",
  "udf_float_2":20,
   "idudf_float_3": "A01DEAA885B5B0F14769F983A2F6A16E"30,

     "name"udf_float_4":40,
 "Sales Department 1",
 "udf_float_5":50,
     "groupudf_float_name6":60,
"Sales  Manager Group",
   "udf_float_7":70,
   "descriptionudf_float_8": null80,
      "alternative_code"udf_date_1": "SD1""2016-01-28T15:49:59",
    }"udf_date_2":"2016-02-28T15:49:59",
    "idudf_date_3": "E64F366E3E66476E96E8494BB9F917EA"2016-03-28T15:49:59",
    "participatingudf_schemesdate_set": [4":"2016-04-28T15:49:59",
   "accounts_receivable":
   {
        "sign_up_on"action": "2014-05-05T15:49:59"NEW",
        "sign_off_onname":"Jane nullAustin",
        "schemeclassification_identifier": {
 "name":"Residential Customer"},
        "lifecredit_cyclerating_statecode": "EFFECTIVEAAA",
          "idcontact_information":{
"E339CFB9284E8BB291E63CC42E574E88",            "nameaction": "NEW"Marketing,
Reward Scheme",           "descriptiontype": "Marketing Reward Scheme for Sales Department, CRM Team 1, Marketing Team"PERSON",
            "first_name":"Jane",
            "alternativelast_codename": "MRSMarkinson"
        
 },       }
  },
  "sign_up_by_unitaccess_token": {
          "community_name": "Internal Community",
          "idaction": "A01DEAA885B5B0F14769F983A2F6A16EADD_NEW2",
          "name": "Sales Department 1",           "groupauthentication_namecode": "Sales Manager GroupPolinaKTesting2",
          "description": null,           "alternative_codeidentifier": "SD1PolinaKTesting2",
          },         "idpass_code": "DA225B0204144370A2EF0687C37A8B7012342"
},
   "participating_schemes_set":
 },  [
     {
        "sign_up_on": "20142016-0803-05T1528T15:4900:5900" ,
        "sign_up_by_off_onunit_identifier":{"name":"Admin nullUnit"},

       "reward_scheme_identifier": {"name":"Marketing Scheme"}
     },
   "life_cycle_state": "EFFECTIVE",  {
        "idsign_up_on": "EA5CCE98F857F3A928E3AA6891323088"2016-03-28T15:00:00" ,
          "sign_up_by_unit_identifier":{"name": "SalesAdmin SchemeUnit"},
          "description": "Sales Scheme - TC10",
 "reward_scheme_identifier":{"name":"Sales Scheme"}
     }
   ],
    "alternativeaccess_tokens_codeset" :
"SS"    [
    },    {
    "sign_up_by_unit": {
          "community_nameaction": "Internal CommunityADD_NEW",
            "idauthentication_code": "CA8896C911589FEDB384001606C2440E1234879456",
            "nameidentifier": "Sales Department 2","testAT@crm.com",
            "grouppass_namecode": "1234879456a!"Sales
Manager Group",       }
   "description": "Sales Department 2 under Sales Manager Group",
 ]
 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "data": {
         "alternativelog_codeinformation": "SD2"{
        },"created_by_unit": {
        "idalternative_code": "3315CBDCA46D48A9875EE70AD53DA19Aadminunit",
      }     ]
  }
}"group_name": "Main Group",
        "community_name": "Community",

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

  {   "tokenname": "A0931BF523A24C819181DC9487343F45Admin Unit",
   "sign_up_on":"2014-07-05T15:49:59",     "fields_setdescription":"number,sign_up_by_unit,id,participating_schemes_set,accounts_receivable,access_tokens_set "admin unit",
  "sign_up_by_unit_identifier":{"name":"Sales Department 1"},
  "udf_string_1":"udf string 1"      "id": "1"
      },
      "udfupdated_stringby_2unit":"udf string 2", {
        "udfalternative_string_3code":"udf string 3", "adminunit",
        "udfgroup_string_4name": "udfMain string 4Group",
        "udfcommunity_string_5name":"udf string 5", "Community",
        "udf_string_6name": "udfAdmin string 6Unit",
   "udf_string_7     "description": "udfadmin string 7unit",
        "udf_string_8id": "udf1"
 string 8",    "udf_float_1":10,},
      "udfcreated_float_2date":20 "2016-07-05T08:35:42",
      "udfupdated_float_3":30,date": "2016-07-05T08:35:44",
      "udfupdated_floatby_4user":40, {
    "udf_float_5":50,    "udfperson_float_6name":60,    "udf_float_7":70"CRM COM",
   "udf_float_8":80,     "udf_date_1id":"2014-05-05T15:49:59 "1",
   "udf_date_2     "email":"2014-06-05T15:49:59", "dev@crm.com",
        "udf_date_3username":"2014-07-05T15:49:59" "MPAdministrator"
      },
      "udfcreated_dateby_4":"2014-08-05T15:49:59",user": {
        "accountsperson_receivablename": "CRM COM",
 {       "actionid": "EXISTING1",
        "accounts_receivable_identifieremail":{ "number":"ACR001131"}dev@crm.com",
  },      "participating_schemes_setusername": "MPAdministrator"
  [    }
 {   },
    "signudf_update_on2": "20142016-0502-05T1528T15:49:59" ,
       "signudf_up_by_unit_identifierdate_1":{"name":"Sales Department 1"},
  "2016-01-28T15:49:59",
     "rewardudf_schemedate_identifier4":{"name":"Marketing Reward Scheme"}
     } "2016-04-28T15:49:59",
     {
       "sign_up_on"udf_date_3": "20142016-0803-05T1528T15:49:59" ,
       "signparticipating_up_by_unit_identifier":{"name":"Sales Department 2"},schemes_set": [
      {
        "reward_scheme_identifier": {"name":"Sales
Scheme"}      }    ],
    "access_tokens_set" :
"alternative_code": "SSS",
   [       "name":  {
 "Sales Scheme",
          "authentication_codedescription" : "1256727348874desc",
            "identifierid" : "1236546478993592610A4F01454E97AF71C9E47646FB",
            "passlife_cycle_codestate" : "awe$qew!EFFECTIVE"
        },
    ]  }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{   "status": {sign_up_on": "2016-03-28T15:00:00",
        "messagesign_up_by_unit": "",{
    "description": "",     "alternative_code": "OK"adminunit",
       },   "datagroup_name": {
 "Main Group",
  "accounts_receivable": {       "accountcommunity_ownername": "Community",
 {         "last_name": "kyriakouAdmin Unit",
          "middle_namedescription": null"admin unit",
        "life_cycle_state  "id": "FINANCIAL"1"
        },
        "company_profileid": null"1F4D25D0C22D4F47818751D2ABB56979",
        "titlesign_off_on": null,
      },
   "first_name": "maria",   {
        "typescheme": "PERSON", {
          "idalternative_code": "6BDA97F3B1EA4276A297B424474E7DD3MS",
          "name": "kyriakouMarketing mariaScheme",
          "company_namedescription": null,
          "demographicsid": {"6CAAD517743C4C179251282A5B2B58A6",
          "genderlife_cycle_state": "FEMALE",EFFECTIVE"
        },
        "passportsign_issuedup_by_countryon": null"2016-03-28T15:00:00",
          "socialsign_up_securityby_numberunit": null,{
          "passportalternative_numbercode": null"adminunit",
          "industrygroup_sectorname": "Main nullGroup",
          "countrycommunity_of_residencename": {"Community",
            "three_character_code"name": "CYPAdmin Unit",
            "two_character_code"description": "CYadmin unit",
            "id": "181",1"
        },
        "nameid": "CYPRUS56BC61EDEBB749B2B92862CB74E00AFC",
            "alternative_code"sign_off_on": null
      }
    ],
    "number": "RP0000000051",
    }"udf_float_3": 30,
    "udf_float_4": 40,
    "namesign_up_dayon": {"2016-03-28T15:00:00",
    "sign_up_by_unit": {
      "monthalternative_code": null"adminunit",
      "group_name": "Main Group",
      "daycommunity_name": null"Community",
      "name":    },
"Admin Unit",
         "date_of_birth"description": {"admin unit",
      "id": "1"
   "month": null},
    "currency": {
      "daysuffix_symbol": null,
      "prefix_symbol": "€",
      "yeardecimal_part_name": null,
      "code": "EUR",
   },   "integer_part_name": null,
      "id_number": "34234234232",
     },
    "industryid": null"D97CA2ADBD274CD69AC1A27D41E06BF2",
    "udf_float_1": 10,
    "idudf_issuedfloat_by_country2": null
        }
      }20,
      "lifeudf_cyclestring_state2": "ACTIVEudf string 2",
 
    "numberudf_string_3": "ACR001131udf string 3",
 
    "idudf_string_4": "0D3BC55501814EF5B9797865C657119Budf string 4",
      "name"udf_string_5": "ACR001131"udf     }string 5",
    "accessudf_tokensstring_set1": [
"udf string 1",
    "accounts_receivable": {
 
      "authentication_codenumber": "1256727348874ACR0000000272",
        "life_cycle_state"name": "EFFECTIVEJane Austin",

       "classificationid": null"9BBF752EC5A5473C8403A0E59BA9B787",
        "number"life_cycle_state": "ACT0000000340ACTIVE",
        "identifieraccount_owner": "123654647899",{
        "idcompany_profile": "233807C6EE234BEF8B909238AD28D684"null,
        }
"company_name": null,
   ],     "numbername": "148Jane Markinson",
  
 "sign_up_by_unit": {       "communitylast_name": "Internal CommunityMarkinson",
        "id": "A01DEAA885B5B0F14769F983A2F6A16EF3B3D4F601844A88AF5CEED733DBE478",,
        "namelife_cycle_state": "SalesFINANCIAL",
Department 1",       "groupmiddle_name": "Salesnull,
Manager Group",       "descriptiontitle": null,
        "alternative_codetype": "SD1PERSON",
    },     "idfirst_name": "5168BB2790064693BAA2B4C4C9A8866FJane",
    "participating_schemes_set": [   "demographics":  {
 {         "signname_up_onday": "2014-08-05T15:49:59", {
            "sign_off_onmonth": null,
            "schemeday": {null
          "life_cycle_state": "EFFECTIVE"},
          "id_number": "EA5CCE98F857F3A928E3AA6891323088"null,
          "namegender": "Sales Scheme"null,
          "descriptioncountry_of_residence": "Sales{
Scheme - TC10",           "alternative_code": "SSCYP"
 ,
      },         "signthree_upcharacter_by_unitcode": {"CYP",
            "community_name": "Internal CommunityCYPRUS",
            "id": "CA8896C911589FEDB384001606C2440E181",
          "name  "two_character_code": "Sales Department 2""CY"
          },
          "groupdate_of_namebirth": "Sales{
Manager Group",           "descriptionmonth": "Salesnull,
Department 2 under Sales Manager Group",
          "alternative_codeyear": "SD2"null,
        },         "idday": "E528D181A16B4E6EB1B8BA6AE3FB12D2"null
      },    },
  {         "signindustry_up_onsector": "2014-05-05T15:49:59"null,
          "signpassport_off_onnumber": null,
          "schemeindustry": {null,
          "lifesocial_cyclesecurity_statenumber": "EFFECTIVE"null,
          "id_issued_by_country": "E339CFB9284E8BB291E63CC42E574E88"null,
          "namepassport_issued_by_country": "Marketing Reward Scheme",
 null
        }
      }
    },
    "descriptionudf_string_6": "Marketingudf Rewardstring Scheme6",
for Sales Department, CRM Team 1, Marketing Team "udf_string_7": "udf string 7",
          "alternative_code"access_tokens_set": "MRS"[
        },{
        "sign_up_by_unitauthentication_code": {"1234879456",
          "community_namenumber": "Internal CommunityAT0000000121",
 
        "ididentifier": "A01DEAA885B5B0F14769F983A2F6A16EtestAT@crm.com",
          "nameid": "Sales Department 1B417DE8C9FC74FC4A9A92795A8D3FC1A",
          "grouplife_cycle_namestate": "Sales Manager GroupEFFECTIVE",
          "descriptionclassification": null,
      }
    ],
    "alternativeudf_string_code8": "SD1"udf      string 8"
  },
  "status": {
    "idcode": "A5BB367B54BB4B08A8864002F1181B88OK",
    "description": "",
}     ]"message": ""
  }
}

POST rewards_participants/update

...

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)

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:

Include Page

	V4:unit_identifier
	V4:unit_identifier

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

theme	Confluence
language	javascript
linenumbers	true

"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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "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:

Code Block

theme	Confluence
language	javascript
linenumbers	true

    {
       "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"
       }
    }

Tip
Available from CRM.COM R10.0.0

Versions Compared

Old Version 35

New Version 36

Key

POST rewards_participants/create

Resource URL

Parameters

POST rewards_participants/create

Resource URL

Parameters

Restrictions

Response Data

Examples

Restrictions

Response Data

Examples

POST rewards_participants/update

Page Comparison

Versions Compared

Old Version 35

New Version 36

Key

POST rewards_participants/create

Resource URL

Parameters

POST rewards_participants/create

Resource URL

Parameters

Restrictions

Response Data

Examples

Restrictions

Response Data

Examples

POST rewards_participants/update