Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Deprecated from CRM.COM R18.0.0


Excerpt

This method creates an access token. Single access tokens can be created by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

authentication_code

(mandatory on conditions)

String

The authentication code of the access token that will be created. This information is not mandatory if set to be generated automatically, in the definition or the classification.

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

card_

receivable_

masked_number

(optional)

String

The masked number of the credit card that will be related to the access token

  • Applicable only when the authentication code is related with a credit card
Tip

Available from CRM.COM R16.2.0


accounts_receivable_identifier

(semi-optional on conditions)

Accounts Receivable Identifier

The identifier of the accounts receivable that will be related to 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

From release CRM.COM R14.0.0 and onwards, this parameter is semi-optional on conditions (optional in prior releases)

This information is semi-optional on conditions if the Access Token Pass Code is auto-generated

rewards_participant_identifier

(semi-optional on conditions)

Rewards Participant Identifier

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

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

Tip

Available from CRM.COM R8.0.0

From release CRM.COM R14.0.0 and onwards, this parameter is semi-optional on conditions (optional in prior releases)

This information is semi-optional on conditions if the Access Token Pass Code is auto-generated

classification_identifier

(optional)

Access Token Classification Identifier

 The identifier of the access token classification that will be related to the access token. 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


udf_string_1

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_2

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_3

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_4

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_5

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_6

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_7

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_string_8

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R10.1.0


udf_float_1

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R10.1.0


udf_float_2

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R10.1.0


udf_float_3

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R10.1.0


udf_float_4

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R10.1.0


udf_date_1

(optional)

Date

User Defined Field of type Date

Tip

Available from CRM.COM R10.1.0


udf_date_2

(optional)

Date

User Defined Field of type Date

Tip

Available from CRM.COM R10.1.0


udf_date_3

(optional)

Date

User Defined Field of type Date

Tip

Available from CRM.COM R10

.1.0

udf_date_4

(optional)

Date

User Defined Field of type Date

.1.0


udf_date_4

(optional)

Date

User Defined Field of type Date

Tip

Available from CRM.COM R10.1.0


custom_field_set

(optional)

Set of Custom Fields

The custom fields that are associated with the access token

If no records are specified in the set then nothing will be updated. To add or update a value on a custom field use the custom field name as configured in CRM.COM along with the respective value. To remove a value from a custom field use the custom field name as configured in CRM.COM along with an empty value

Code Block
languagejavascript
themeConfluence
linenumberstrue
"custom_field_set": [
	{"field_name" : "value"},
	{"field_name" : "value"}
]


Tip

Available from CRM.COM

R10

R16.

1

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

Tip

Available from CRM.COM R10.0.0


Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
  • It is mandatory to specify one of the semi-optional on conditions parameters when these conditions are met. At least one of those parameters needs to be specified.

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluence
languagejavascript
linenumberstrue
 {
       "token":"43512326DEE44DF18D37EAAB6A46DA4C",
       "authentication_code" : "180581",
       "identifier":"18555",
       "pass_code":"ap!n3w$",
       "accounts_receivable_identifier"	: { "number" : "ACR000783"}
}  

 

 



Response:

Code Block
languagejavascript
themeConfluence
languagejavascript
linenumberstrue
{
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "log_information":
           {
               "updated_date": "2015-10-15T09:47:49",
               "created_date": "2015-10-15T09:47:48",
               "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": "180581",
           "accounts_receivable":
           {
               "account_owner":
               {
                   "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"
       }
 }


...

Expand
titleExample 2

HTTP Method: POST

 


Request:

Body:

Code Block
languagejavascript
themeConfluence
languagejavascript
linenumberstrue
{
	 "token":"{{token}}",
	 "authentication_code" : "Joanna",
	 "identifier":"password12!",
	 "pass_code":"pass12!",
	 "accounts_receivable_identifier"   : { "number" : "162"},
	 "fields_set":"id,number,life_cycle_state,authentication_code,identifier,accounts_receivable"       
}  

 

 



Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
    {
    "status": {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data": {
        "authentication_code": "Joanna",
        "accounts_receivable": {
            "account_owner": {
                "last_name": "Mercer",
                "middle_name": "111111111",
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": "Mr",
                "first_name": "Ben11 omonoia",
                "type": "PERSON",
                "id": "475904FB959FE8D3DDAEB22FBFEC5FFB",
                "name": "Mercer Ben11 omonoia",
                "company_name": null,
                "demographics": {
                    "gender": "MALE",
                    "passport_issued_by_country": {
                        "three_character_code": "AND",
                        "two_character_code": "AD",
                        "id": "132",
                        "name": "ANDORRA",
                        "alternative_code": null
                    },
                    "social_security_number": null,
                    "passport_number": null,
                    "industry_sector": null,
                    "country_of_residence": {
                        "three_character_code": "USA",
                        "two_character_code": "US",
                        "id": "127",
                        "name": "UNITED STATES",
                        "alternative_code": null
                    },
                    "name_day": {
                        "month": 6,
                        "day": 14
                    },
                    "date_of_birth": {
                        "month": 11,
                        "day": 9,
                        "year": 1963
                    },
                    "id_number": "1212125",
                    "industry": {
                        "id": "31BC2070C79EAE5455BFAD41599C5190",
                        "name": "Marketing1",
                        "code": "MK"
                    },
                    "id_issued_by_country": {
                        "three_character_code": "DZA",
                        "two_character_code": "DZ",
                        "id": "130",
                        "name": "ALGERIA",
                        "alternative_code": null
                    }
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "162",
            "id": "3C66BD54CCDB6BC1096C23F6D8899752",
            "name": "Ben Mercer 1"
        },
        "life_cycle_state": "EFFECTIVE",
        "identifier": "password12!",
        "number": "ACT0000000338",
        "id": "DA28B48FF08346199583CA7F20088CC1"
    }
}


...