Page Comparison

...

Excerpt
This method returns information related with achievements customer events. Multiple achievements customer events are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:

Include Page

	V4:rewards_participants_identifier_post
	V4:rewards_participants_identifier_post

Tip
Deprecated from CRM.COM R17.0.0

accounts_receivable_identifier

(semi-optional)

Rewards Participant Identifier

Accounts Receivable Identifier

The identifier of the

rewards participant

accounts receivable related with the customer events that should be retrieved. The allowed

rewards participant

accounts receivable identifier fields are the following:

Include Page

	V4:

rewards

accounts_

participants

receivable_identifier_post
	V4:

rewards

accounts_

participants

receivable_identifier

accounts_receivable_

_post

Tip
From CRM.COM R17.0.0, the access token attributes are supported

classification_identifier

(semi-optional)

Accounts Receivable Identifier

Customer Event Classification Identifier

The identifier of the

accounts receivable

classification related with the customer events that should be retrieved. The allowed

accounts receivable

customer event classification identifier fields are the following:

Include Page

	V4:

accounts

customer_event_

receivable

classification_identifier
	V4:

accounts

customer_event_

receivable

classification_identifier

classification

submitted_after_

identifier

date

(

semi-The identifier of the classification related with the

optional)

Customer Event Classification Identifier

Date	If specified then information related with achievements customer events that was submitted after the specified date should be retrieved

. The allowed customer event classification identifier fields are the following: Include PageV4:customer_event_classification_identifierV4:customer_event_classification_identifiersubmitted

Tip
Available from CRM.COM R12.2.0

submitted_before_date

(optional)

Date

If specified then information related with achievements customer events that was submitted before the specified date should be retrieved

Tip
Available from CRM.COM R12.2.0

created_after_date

(semi-optional)

Date

If specified then information related with achievements customer events that was

submitted

created after the specified date should be retrieved

Tip
Available from CRM.COM

R12

R15.

2

1.0

submitted

created_before_date

(optional)

Date

If specified then information related with achievements customer events that was

submitted

created before the specified date should be retrieved

Tip
Available from CRM.COM

R12

R15.

2

1.0

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip
Available from CRM.COM R13.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

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

Response:

Code Block

language	javascript
theme	Confluence
language	javascript
linenumbers	true

 
  
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "number": "3",
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "DosSantos",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Freddy",
                    "name": "Freddy DosSantos",
                    "id": "A71495DD306A15CCCB9E130EF1119E52",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence":
                        {
                            "name": "JAPAN",
                            "id": "237"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "88889654",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "50",
                "name": "DosSantos",
                "id": "E5A3CD26B72C9D4D7903BE885EAAFB95"
            },
            "id": "EAC87C2EF350DFEB385CFBA5BD791799",
            "classification":
            {
                "name": "Classification Test 1",
                "id": "37DA1DB4A0E325A37D12CD0B8AA7CDF5",
                "alternative_code": "ct1"
            },
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "performed_by_unit":
            {
                "community_name": "myCommunity",
                "group_name": "Installation Group",
                "name": "Installation Team 1",
                "id": "2B35083ECB69BD57A4C1CC7ADC2F473B",
                "description": null,
                "alternative_code": "IT1"
            },
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2014-11-14T15:11:06",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-10-17T11:35:06",
                "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "life_cycle_state": "POSTED",
            "type": "ACHIEVEMENT",
            "description": "sd",
            "performed_on": "2014-10-17T11:35:22"
        },
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "number": "4",
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "DosSantos",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Freddy",
                    "name": "Freddy DosSantos",
                    "id": "A71495DD306A15CCCB9E130EF1119E52",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence":
                        {
                            "name": "JAPAN",
                            "id": "237"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "88889654",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "50",
                "name": "DosSantos",
                "id": "E5A3CD26B72C9D4D7903BE885EAAFB95"
            },
            "id": "27580CBC38023E3716D51E89196733E3",
            "classification":
            {
                "name": "Classification Test 1",
                "id": "37DA1DB4A0E325A37D12CD0B8AA7CDF5",
                "alternative_code": "ct1"
            },
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "performed_by_unit":
            {
                "community_name": "Verification Community",
                "group_name": "Verification Group",
                "name": "Sales Branch 1",
                "id": "DC4805750EB10DE151F8908F5D19D870",
                "description": null,
                "alternative_code": "SB1"
            },
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2014-12-04T11:32:36",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-10-17T11:40:57",
                "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "life_cycle_state": "POSTED",
            "type": "ACHIEVEMENT",
            "description": null,
            "performed_on": "2014-10-17T11:41:09"
        }
    ]
}

...

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence	language	js
linenumbers	true

{
  "token": "{{token}}",
  "accounts_receivable_identifier": {
    "number": "ACR0000000659"
  },
  "submitted_after_date":"2016-10-26T00:00:12",
  "submitted_before_date":"2016-10-26T19:00:12",
  "fields_set": "number,performed_on"
}

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
  "data": [
    {
      "number": "94",
      "performed_on": "2016-10-26T18:22:55"
    },
    {
      "number": "93",
      "performed_on": "2016-10-26T18:22:40"
    },
    {
      "number": "92",
      "performed_on": "2016-10-26T18:22:26"
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Versions Compared

Old Version 3

New Version Current

Key

Resource URL

Parameters

Restrictions