Tip |
---|
Table of Contents | ||
---|---|---|
|
POST access_tokens/show
This method returns information related with an access token. A single access token is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(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:
...
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.
Response Data
...
Examples
Expand | ||||||
---|---|---|---|---|---|---|
|
Code Block |
---|
{
"token":"641070EA9DF042E48CDA1B6414ACABC5",
"access_token_identifier": { "authentication_code" : "CCD4537CA4AD4EE8912FFBAE53110601"}
} |
Response:
theme | Confluence |
---|---|
language | javascript |
linenumbers | true |
Table of Contents | ||
---|---|---|
|
POST access_tokens/show
This method returns information related with an access token. A single access token is returned by each call
Resource URL
Parameters
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:
| ||||||
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.
Response Data
Include Page | ||||
---|---|---|---|---|
|
Examples
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
HTTP Method: POST Request: Body:
Response:
|
POST access_tokens/list
Tip |
---|
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
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 the access token. The available accounts receivable identifier fields are the following:
| ||||||
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:
| ||||||
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.
Response Data
Include Page | ||||
---|---|---|---|---|
|
Examples
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
HTTP Method: POST Request: Body:
Response:
|
GET access_tokens/get_not_associated
This method returns all the access tokens which are not associated with an existing entity. Multiple access tokens are retrieved by each call
Resource URL
Parameters
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) | String | The 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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Include Page | ||||
---|---|---|---|---|
|
Examples
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request:
Response:
|
...
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 (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) | String | The 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:
| ||||||||
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:
Note that if an accounts receivable is also specified, then the rewards participant should be owned by that accounts receivable |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Include Page | ||||
---|---|---|---|---|
|
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
...
This method updates access tokens. A single access token can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
Resource URL
Parameters
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:
| ||||||
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) | String | The 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. |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Include Page | ||||
---|---|---|---|---|
|
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|