Get Letter Template Details
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetLetterTemplateDetails
The purpose of this API is to get details of mentioned manual letter.
Request fields details
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 ---- es: means Spanish Allowable Values: 10 |
ExternalIP string |
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 |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 |
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 |
LetterTemplateID integer Mandatory |
ID assigned to a Letter Template Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. |
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 |
LetterTemplateID integer Mandatory |
ID assigned to a Letter Template Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. |
Sample request body
{ "Source": "Web", "IPAddress": null, "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.205.0.56", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "LetterTemplateID": 1373 }
Response fields details
Fields | Description |
---|---|
GetLetterInterfaceDataList array |
GetLetterInterfaceDataList |
GetLetterInterfaceDataList array |
GetLetterInterfaceDataList |
Sample response body
{ "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "GetLetterInterfaceDataList": [ { "LetterTemplateID": 1373, "LetterTemplateVersion": 1, "LetterTemplateStatus": 1, "MessageTemplateLanguage": "en", "NumOfUsrDefAmtVar": 3, "NumOfUsrDefDateVar": 1, "NumOfUsrDefTextVar": null, "UsrAmountVar1": "Payoff Amount", "UsrAmountVar2": "Interest", "UsrAmountVar3": "Fee", "UsrAmountVar4": null, "UsrAmountVar5": null, "UsrAmountVar6": null, "UsrAmountVar7": null, "UsrAmountVar8": null, "UsrAmountVar9": null, "UsrAmountVar10": null, "UsrDateVar1": "Cycle End Date", "UsrDateVar2": null, "UsrDateVar3": null, "UsrDateVar4": null, "UsrDateVar5": null, "UsrDateVar6": null, "UsrDateVar7": null, "UsrDateVar8": null, "UsrDateVar9": null, "UsrDateVar10": null, "UsrTextVar1": null, "UsrTextVar2": null, "UsrTextVar3": null, "UsrTextVar4": null, "UsrTextVar5": null, "UsrTextVar6": null, "UsrTextVar7": null, "UsrTextVar8": null, "UsrTextVar9": null, "UsrTextVar10": null, "LettersStatusDesc": "Active" } ] } }