Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R8.0.0

Deprecated from CRM.COM R18.0.0


Excerpt

This method returns information related with to multiple access tokens, which are related either with to an accounts receivable or a rewards participant. Multiple access tokens are returned by each call. 

Resource URL

Parameters

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

to the access token. The available accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The identifier of the rewards participant related

with

to the access token. The available rewards participant identifier fields are the following:

Include Page
V4:access_token_rewards_participants_identifier
V4:access_token_rewards_participants_identifier

Tip

Deprecated from CRM.COM R18.0.0


classification_identifier

(optional)

Access Token Classification Identifier

 The identifier of the access token classification that retrieved access tokens should have. If specified then only access tokens having that classification will be retrieved. The allowed access token classification identifier fields are the following:

Include Page
V4:access_token_classification_identifier
V4:access_token_classification_identifier

Tip

Available from CRM.COM R10.0.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
titleExample 1

HTTP Method: GET

Request: 


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
   {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "verification_code": null,
      "log_information": {
        "updated_date": "2016-05-20T10:06:08",
        "created_date": "2016-05-19T14:26:53",
        "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": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "reward_participant": {
        "accounts_receivable": {
          "account_owner": {
            "last_name": "Andreou",
            "middle_name": null,
            "life_cycle_state": "FINANCIAL",
            "company_profile": null,
            "title": null,
            "first_name": "Kokos",
            "type": "PERSON",
            "id": "32120E4E8518419FA1A017E200F35D8E",
            "name": "Andreou Kokos",
            "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": "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": "9655851",
              "industry": null,
              "id_issued_by_country": null
            }
          },
          "life_cycle_state": "ACTIVE",
          "number": "ACR001018",
          "id": "3D2B233237C9492DB23B1A8D3935AAAA",
          "name": "ACR001018"
        },
        "number": "115",
        "id": "41BDE8D9D1AE4F46A1948C85E5644A66"
      },
      "authentication_code": "pk_test4",
      "life_cycle_state": "EFFECTIVE",
      "verified_date": null,
      "accounts_receivable": null,
      "classification": {
        "id": "FD034DB5BEB34D07A57A4DE075B5F649",
        "name": "PK Main Access Token Classification ",
        "alternative_code": "MATC_2"
      },
      "number": "ACT0000000231",
      "identifier": "pk6@crm.com",
      "id": "33592E8A66A0442FA5B70C077A33010D",
      "verified_by_user": null
    },
    {
      "verification_code": null,
      "log_information": {
        "updated_date": "2016-05-20T10:04:41",
        "created_date": "2016-05-20T10:04:24",
        "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": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "reward_participant": {
        "accounts_receivable": {
          "account_owner": {
            "last_name": "Andreou",
            "middle_name": null,
            "life_cycle_state": "FINANCIAL",
            "company_profile": null,
            "title": null,
            "first_name": "Kokos",
            "type": "PERSON",
            "id": "32120E4E8518419FA1A017E200F35D8E",
            "name": "Andreou Kokos",
            "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": "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": "9655851",
              "industry": null,
              "id_issued_by_country": null
            }
          },
          "life_cycle_state": "ACTIVE",
          "number": "ACR001018",
          "id": "3D2B233237C9492DB23B1A8D3935AAAA",
          "name": "ACR001018"
        },
        "number": "115",
        "id": "41BDE8D9D1AE4F46A1948C85E5644A66"
      },
      "authentication_code": "76456",
      "life_cycle_state": "EFFECTIVE",
      "verified_date": null,
      "accounts_receivable": null,
      "classification": {
        "id": "FD034DB5BEB34D07A57A4DE075B5F649",
        "name": "PK Main Access Token Classification ",
        "alternative_code": "MATC_2"
      },
      "number": "ACT0000000246",
      "identifier": null,
      "id": "5E8AB892776745588B8611E86BB6B571",
      "verified_by_user": null
    }
  ]
}


...