| Tip |
|---|
Available from CRM.COM R5.0.0 |
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
...
(mandatory)
...
Rewards Participant identifier
The identifier of the rewards participant that should be returned as a result. The allowed 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
...
Examples
| Expand |
|---|
|
HTTP Method: GET Request: Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"sign_up_on": "2014-07-05T15:49:59",
"udf_float_1": 10,
"udf_float_2": 20,
"udf_date_1": "2014-05-05T15:49:59",
"udf_float_3": 30,
"udf_date_2": "2014-06-05T15:49:59",
"number": "16",
"udf_float_4": 40,
"udf_date_3": "2014-07-05T15:49:59",
"sign_up_by_unit":
{
"community_name": "Main Community",
"group_name": "Developers Group",
"name": "Developers Unit",
"id": "C4370788B2630BC8A99E8C7397406C09",
"description": null,
"alternative_code": null
},
"udf_date_4": "2014-08-05T15:49:59",
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"participating_schemes_set":
[
{
"sign_up_on": "2014-08-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "test 2",
"id": "FDC8FD6BC50FD648952C5804820033A4",
"description": null,
"alternative_code": "t2"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "Marketing Unit",
"id": "83922FE923563679768A94F58CAB5569",
"description": "r1c1",
"alternative_code": null
},
"id": "0BF0E353817E3D8F36F07CBE79A62CBC"
},
{
"sign_up_on": "2014-05-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "Test1",
"id": "C423FFDD9CE9AF60A67B7F29F539630F",
"description": "test 1",
"alternative_code": "t1"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "Sales Branch 2",
"id": "C7304329F4787BC7845052332B180A0E",
"description": null,
"alternative_code": "SB2"
},
"id": "A3FBB9718D3B3AFE1505F39A489ED4A4"
}
],
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_6": "udf string 6",
"log_information":
{
"updated_date": "2014-11-19T12:57:30",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-11-19T12:57:27",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
}
},
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": "Andreas",
"company_profile": null,
"title": "Ms",
"type": "PERSON",
"first_name": "Lucia",
"name": null,
"id": "1D92B269658D80DEDF2499E25201739E",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_number": "113115",
"social_security_number": "113116",
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1990
},
"name_day":
{
"month": 5,
"day": 5
},
"id_number": "113114"
}
},
"life_cycle_state": "ACTIVE",
"number": "399",
"name": "Lucia Papapavlou",
"id": "2B669B8EB009BF42352C00B05FAB61CF"
},
"id": "8D585084E77D8EA5AE3E5B13649A1139"
}
} |
|
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
...
(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:
...
(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_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: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"number": "11",
"id": "D6576EBBEDF74533E9C2C0CEE2FAD3BA",
"participating_schemes_set":
[
{
"sign_up_on": "2014-11-12T18:27:27",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "Test1",
"id": "C423FFDD9CE9AF60A67B7F29F539630F",
"description": "test 1",
"alternative_code": "t1"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "test2",
"id": "89E2B186191FBE7ECD6D52F4E2CF159C",
"description": null,
"alternative_code": null
},
"id": "9B6E22B799B8DA18FC08C8A77DB1C7FF"
}
]
},
{
"number": "14",
"id": "DC132E6318D12DE67087260F8F6C76D3",
"participating_schemes_set":
[
{
"sign_up_on": "2014-11-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "Test1",
"id": "C423FFDD9CE9AF60A67B7F29F539630F",
"description": "test 1",
"alternative_code": "t1"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "VK Unit",
"id": "F164DB175FA6C345680426F7C17DF803",
"description": null,
"alternative_code": "VKU"
},
"id": "935C5CA0F843CB3D7AB9438897489285"
},
{
"sign_up_on": "2014-12-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "test 2",
"id": "FDC8FD6BC50FD648952C5804820033A4",
"description": null,
"alternative_code": "t2"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "VK Unit",
"id": "F164DB175FA6C345680426F7C17DF803",
"description": null,
"alternative_code": "VKU"
},
"id": "026AC9C981D52F5F4DF69CC77974334C"
}
]
},
{
"number": "16",
"id": "8D585084E77D8EA5AE3E5B13649A1139",
"participating_schemes_set":
[
{
"sign_up_on": "2014-08-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "test 2",
"id": "FDC8FD6BC50FD648952C5804820033A4",
"description": null,
"alternative_code": "t2"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "Marketing Unit",
"id": "83922FE923563679768A94F58CAB5569",
"description": "r1c1",
"alternative_code": null
},
"id": "0BF0E353817E3D8F36F07CBE79A62CBC"
},
{
"sign_up_on": "2014-05-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "Test1",
"id": "C423FFDD9CE9AF60A67B7F29F539630F",
"description": "test 1",
"alternative_code": "t1"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "Sales Branch 2",
"id": "C7304329F4787BC7845052332B180A0E",
"description": null,
"alternative_code": "SB2"
},
"id": "A3FBB9718D3B3AFE1505F39A489ED4A4"
}
]
}
]
} |
|
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)
...
sign_up_by_unit_identifier
(mandatory)
...
The unit that signed up the rewards participant. The allowed unit identifier fields are the following:
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
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
...
accounts_receivable
(mandatory)
...
access_token
(mandatory)
...
participating_schemes_set
(optional)
...
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: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
| {
"token":"A5FCBB50276F659ED013387B1156A5C0",
"sign_up_on":"2014-07-05T15:49:59",
"sign_up_by_unit_identifier":{"name":"Developers Unit"},
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59",
"accounts_receivable":
{
"action":"EXISTING",
"accounts_receivable_identifier":{"number":"399"},
},
"participating_schemes_set":
[
{
"sign_up_on": "2014-05-05T15:49:59" ,
"sign_up_by_unit_identifier":{"name":"Sales Branch 2"},
"reward_scheme_identifier":{"name":"Test1"}
},
{
"sign_up_on": "2014-08-05T15:49:59" ,
"sign_up_by_unit_identifier":{"name":"Marketing Unit"},
"reward_scheme_identifier":{"name":"test 2"}
}
]
} |
Response: | Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"sign_up_on": "2014-07-05T15:49:59",
"udf_float_1": 10,
"udf_float_2": 20,
"udf_date_1": "2014-05-05T15:49:59",
"udf_float_3": 30,
"udf_date_2": "2014-06-05T15:49:59",
"number": "17",
"udf_float_4": 40,
"udf_date_3": "2014-07-05T15:49:59",
"sign_up_by_unit":
{
"community_name": "Main Community",
"group_name": "Developers Group",
"name": "Developers Unit",
"id": "C4370788B2630BC8A99E8C7397406C09",
"description": null,
"alternative_code": null
},
"udf_date_4": "2014-08-05T15:49:59",
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"participating_schemes_set":
[
{
"sign_up_on": "2014-08-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "test 2",
"id": "FDC8FD6BC50FD648952C5804820033A4",
"description": null,
"alternative_code": "t2"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "Marketing Unit",
"id": "83922FE923563679768A94F58CAB5569",
"description": "r1c1",
"alternative_code": null
},
"id": "33E0F3DEFCBE4F4014538117C921806D"
},
{
"sign_up_on": "2014-05-05T15:49:59",
"scheme":
{
"life_cycle_state": "EFFECTIVE",
"name": "Test1",
"id": "C423FFDD9CE9AF60A67B7F29F539630F",
"description": "test 1",
"alternative_code": "t1"
},
"sign_up_by_unit":
{
"group_name": null,
"name": "Sales Branch 2",
"id": "C7304329F4787BC7845052332B180A0E",
"description": null,
"alternative_code": "SB2"
},
"id": "B64C0B66364B97A24AE966A05865C75D"
}
],
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_6": "udf string 6",
"log_information":
{
"updated_date": "2014-11-19T13:25:25",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-11-19T13:25:09",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": null
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": "Andreas",
"company_profile": null,
"title": "Ms",
"type": "PERSON",
"first_name": "Lucia",
"name": null,
"id": "1D92B269658D80DEDF2499E25201739E",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_number": "113115",
"social_security_number": "113116",
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1990
},
"name_day":
{
"month": 5,
"day": 5
},
"id_number": "113114"
}
},
"life_cycle_state": "ACTIVE",
"number": "399",
"name": "Lucia Papapavlou",
"id": "2B669B8EB009BF42352C00B05FAB61CF"
},
"id": "36648FDA11F3E5A34CBCB0ABAFAAD217"
}
} |
|
POST rewards_participants/update
This method updates rewards 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
...
(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)
...
sign_up_by_unit_identifier
(optional)
...
The unit that signed up the rewards participant. The allowed unit identifier fields are the following:
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
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
...
access_token
(optional)
...
participating_schemes_set
(optional)
...
A list of reward schemes that the rewards participant has joint
...
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:
| Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
|
Response:
| Code Block |
|---|
| theme | Confluence |
|---|
| language | javascript |
|---|
| linenumbers | true |
|---|
|
| Panel |
|---|
|
| Child pages (Children Display) |
|---|
|
|