Page Comparison

...

Tip
Deprecated from CRM.COM R17.0.0

Excerpt
This method returns information related with a rewards participants. A single rewards participant is returned by each call
Tip
Available from CRM.COM R5.0.0

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:

Include Page

	V4:rewards_participants_identifier_post
	V4:rewards_participants_identifier_post

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.

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence
language	js
linenumbers	true

{
  "token":"476A07F7C99133EA35D9AEA25475C8C1",
  "rewards_participant_identifier":{"number":"29"}
}

Response:

Code Block

language	javascript
theme	Confluence
language	javascript
linenumbers	true

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

...

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence	language	js
linenumbers	true

{
    "token":"{{token}}",
    "rewards_participant_identifier": {"number":"RP0000000017"}
}

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

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

...

Versions Compared

Old Version 1

New Version Current

Key

Resource URL

Parameters

Restrictions