Versions Compared

Old Version 19

changes.mady.by.user George Rossides (Unlicensed)

Saved on

compared with

New Version 20

changes.mady.by.user Former user

Saved on

Key

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

Available from CRM.COM R5.0.0

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

access_token_identifier

(mandatory)

Access Token identifier  

The identifier of the access token that should be returned as a result. The allowed access token identifier fields are the following:

Include Page
V4:access_token_identifier
V4:access_token_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

...

POST access_tokens/list

Tip

Available from CRM.COM R8.0.0

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

...

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

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

number

(mandatory)

Number

The number of access tokens that should be retrieved

life_cycle_state

(optional)

StringThe life cycle state of the access tokens that should be retrieved. The allowed options are EFFECTIVE or NOT_EFFECTIVE

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

authentication_code

(optional)

String

The authentication code of the access token that will be created. If not specified then it will be generated automatically.

identifier

(mandatory on conditions)

String

The identifier of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code.

pass_code

(mandatory on conditions)

StringThe pass code of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified. 

accounts_receivable_identifier

(optional)

Accounts Receivable Identifier

The identifier of the accounts receivable that will be related with the access token. The available accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

Tip

Available from CRM.COM R8.0.0

rewards_participant_identifier

(optional)

Rewards Participant Identifier

The identifier of the rewards participant that will be related with 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

Available from CRM.COM R8.0.0

Note that if an accounts receivable is also specified, then the rewards participant should be owned by that accounts receivable

...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
       "token":"A4F19B70D95D4DE09C3A9FC720A33A4943512326DEE44DF18D37EAAB6A46DA4C",
       "authentication_code" : "apitest180581",
       "identifier":"apitest1218555",
       "pass_code":"api11112ap!n3w$",
}         "accounts_receivable_identifier"	: { "number" : "ACR000783"}
}

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "log_information":
           {
               "updated_date": "2015-0510-27T1215T09:4847:3249",
               "created_date": "2015-0510-27T1215T09:47:48:31",
               "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": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               }
           },
           "reward_participant": null,
           "authentication_code": "apitest180581",
           "accounts_receivable":
null,           {
  "life_cycle_state": "EFFECTIVE",            "identifieraccount_owner":
"apitest12",               "number": "53",{
            "id": "BA7BBF7E3DDD40528C4680FBECC1D798       "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"
           },
           "life_cycle_state": "EFFECTIVE",
           "identifier": "18555",
           "number": "ACT0000000142",
           "id": "7DD8EE7C341B4627A45A1E2D64C2999E"
       }
 }

POST access_tokens/update

...

Name

Type

Description

token

String

The token retrieved from the login method

access_token_identifier

(mandatory)

Access Token identifier  

The identifier of the access token that should be updated. The allowed access token identifier fields are the following:

Include Page
V4:access_token_identifier
V4:access_token_identifier

authentication_code

(optional)

String

The authentication code of the access token that will be updated. Is specified as null then the authentication code will be regenerated automatically

identifier

(mandatory on conditions)

String

The identifier of the access token that will be update. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code.

pass_code

(mandatory on conditions)

StringThe pass code of the access token that will be updated. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified. 

...