SearchLoyaltyRuleDetails
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/SearchLoyaltyRuleDetails
The Purpose of this API is fecth all the Loyalty Rules available for the Institution.
Request fields details
Fields | Description |
---|---|
Source string Mandatory |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string Mandatory |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string Mandatory |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
InstitutionID integer Mandatory |
Unique identification number for Institution. Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard. |
RuleId integer Optional |
ID of Loyalty Rule. Valid Values: 0-9(Value provided by Corecard) Format: XXXX Example:1234 |
RuleType integer Optional |
Flag to decide the type of Loyalty Rule. Valid Values: 0: Base 1:Promotional 2:Advance Promotional 3:Exclusion Format:X Example:1 |
RuleStatus integer Optional |
Status of Loyalty Rule. Valid Values: 0: Active 1: Inactive Format: X Example: 1 |
RuleApplication integer Optional |
Type of transaction on which the Loyalty rule should trigger for the Account. Valid Values:Refer Appendix Section Format:X Example: Example:3 |
RuleSetupOn integer Optional |
Addtional criteria on which Loyalty rule should trigger for the Account. Valid Values:Refer Appendix Section Format:X Example:5 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "InstitutionID": 3241, "RuleId": null, "RuleType": null, "RuleStatus": null, "RuleApplication": null, "RuleSetupOn": null }
Response fields details
Fields | Description |
---|---|
LoyaltyRulesList array |
Must return List of Loyalty Rules for the Institituion in an array, if a specifc parameter is selected in Input, then as per that Loyalty Rules must be returned as a list. |
Sample response body
{ "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "LoyaltyRulesList": [ { "RuleID": 1, "RuleName": "Student Card Base Reward Rule", "RuleType": "Base", "RuleDescription": "1% Reward on All Purchases", "RuleApplication": null, "RuleApplicationDesc": "Purchase", "RuleSetUpOn": 0, "RuleSetUpOnDesc": null, "RuleStatus": 0, "RuleStatusDesc": null } ] } }