| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
GET activities/show
This method returns information related with an activity. Single activity is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Activity identifier
The identifier of the activity that should be returned as a result. The allowed activities 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 | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET activities/list
This method returns information related with activities. Multiple activities are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(semi-optional)
...
Activity type identifier
The identifier of the activity type. The allowed activity type identifier fields are the following:
...
(semi-optional)
...
The identifier of the contact information related with the account that will be returned as results. The allowed contact information 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 | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
POST activities/create
...
| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
GET rewards_participants/show
This method returns information related with a rewards participants. A single rewards participant is returned by each call
Resource URL
Parameters
Name | Type | Description | |||||||||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||||||||
| rewards_participant_identifier (mandatory) | Activity Type IdentifierRewards Participant identifier | The | type identifier of the | activityrewards participant that should be returned as a result. The allowed | activity type identifiers rewards participant identifier fields are the following:
| activity
| type
| activity
| type
| contact||||||||||||||
fields_ | information_identifier set ( | mandatory)Contact Information Identifier | The contact information related with the activity. The allowed contact information identifiers are the following: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 | ||
|---|---|---|
|
...
|
...
|
...
|
...
|
...
|
...
category_identifier
(optional)
...
The category of the activity. The allowed activity category identifiers are the following:
...
status_identifier
(mandatory)
...
The status of the activity. The allowed activity status identifiers are the following:
...
description
(optional)
...
notes
(optional)
...
start_date
(optional)
...
owned_by_group_identifier
(mandatory)
...
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET rewards_participants/list
This method returns information related with rewards participants. Multiple rewards participants 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 rewards participant that should be returned as a result. The allowed accounts receivable identifier fields are the following:
| ||||||
| contact_information_identifier (semi-optional) | Contact Information identifier | The identifier of the contact information related with the rewards participant that should be returned as a result. The allowed contact information identifier fields are the following:
| ||||||
fields_ | level_identifierset (optional) | The identifier of the privacy level | The privacy level of the activity. The allowed privacy level identifier fields are the following: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 | ||
|---|---|---|
|
...
|
...
|
...
|
...
|
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
...
expected_completion_date
(semi-optional)
...
(semi-optional)
...
(mandatory)
...
The assignment information of the activity
...
(optional)
...
The entities which are related with the activity
...
(optional)
...
The information related to the services to be provided with the activity
...
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 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST activities/update
This method updates activities. Single activities 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
...
activity_identifier
(mandatory)
...
The identifier of the account receivable to be updated. The allowed account receivable identifier fields are the following:
...
category_identifier
(optional)
...
The category of the activity. The allowed activity category identifiers are the following:
...
status_identifier
(optional)
...
The status of the activity. The allowed activity status identifiers are the following:
...
description
(optional)
...
notes
(optional)
...
start_date
(optional)
...
owned_by_group_identifier
(optional)
...
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
POST rewards_participants/create
This method creates a rewards participant. Single rewards participants can be created by each call.
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
sign_up_on (mandatory) | Date | The date that the rewards participant signed up | ||||||
sign_up_by_unit_identifier (mandatory) | Unit identifier | The unit that signed up the rewards participant. The allowed unit identifier fields are the following:
| ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
(mandatory) | Accounts receivable object | The accounts receivable owned by the reward participant that identifies the CRM.COM customer, and handles all financial transactions that might be posted as a result of award or spend reward transactions | ||||||
(optional) | Set of Rewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint |
Referred Parameters Objects DataAnchor rewards participant create referred objects parameters rewards participant create referred objects parameters
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
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 rewards_participants/update
This method updates reward participants. A single rewards participant 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 | ||||||||
| rewards_participant_identifier (mandatory) | Rewards Participant identifier | The identifier of the rewards participant that should be updated. The allowed rewards participant identifier fields are the following:
| ||||||||
sign_up_on (optional) | Date | The date that the rewards participant signed up | ||||||||
sign_up_by_unit_identifier (optional) | The Unit identifier of the privacy level | The privacy level of the activityunit that signed up the rewards participant. The allowed privacy level unit identifier fields are the following:
| ||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_31 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_42 (optional) | Date | User Defined Field of type Date | ||||||||
expected_completion_date (optional) | Date | The date that the activity is expected to be completed | ||||||||
(optional) | Time Period Object | The time that is estimated to complete the activity, measured in minutes, hours, days, weeks, years | ||||||||
assign_toudf_date_3 (optional) | Assign To Object | The assignment information of the activity | performed_forDate | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Performed for Object | The entities which are related with the activity
| services_to_be_providedDate | User Defined Field of type Date | ||||||
(optional) | Set of Services to be Provided ObjectThe information related to the services to be provided with the activityRewards Participant Scheme Objects | A list of reward schemes that the rewards participant has joint
|
...
Referred Parameters Objects DataAnchor rewards participant update referred objects parameters rewards participant update referred objects parameters
| Include Page | ||||
|---|---|---|---|---|
|
Restrictions
...
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|