Page Comparison

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

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)

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

participating_schemes_set

(optional)

Set of Rewards Participant Scheme Objects

A list of reward schemes that the rewards participant has joint

...

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

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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response:

theme

Code Block

{
    "token":"A34C2023D51B1DBAE819E962C8E678C4",
    "rewards_participant_identifier": {"number":"18"},
        "access_token":
        {
        "action":"EXISTING",
        "access_token_identifier" : {"authentication_code":"test123"}
      }    
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "sign_up_on": "2014-11-19T17:33:44",
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_date_1": null,
        "udf_float_3": null,
        "udf_date_2": null,
        "number": "18",
        "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":
        [
        ],
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_6": null,
        "log_information":
        {
            "updated_date": "2014-12-02T10:31:14",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-11-19T17:33:28",
            "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": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "udf_string_7": null,
        "udf_string_8": null,
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Wallas",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": "Mr",
                "type": "PERSON",
                "first_name": "Oscar",
                "name": null,
                "id": "EE75535741F519A353F29B23E2360FEA",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country": null,
                    "passport_number": "111111",
                    "social_security_number": "111111",
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": "80908090",
                    "id_issued_by_country": null,
                    "industry": null
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "191",
            "name": "Oscar Wallas",
            "id": "20960302C3AD8A9CF317C815E5280511"
        },
        "id": "5F7014EEC9BEC07B0C3B8DB498C38933",
        "access_token":
        {
            "authentication_code": "test123",
            "life_cycle_state": "EFFECTIVE",
            "identifier": "test123",
            "number": "20",
            "id": "24CDF96EC29C1359108F633E1C5C3502"
        }
    }
}

Versions Compared

Old Version 12

New Version 13

Key