GetMessageTemplate
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetMessageTemplate
This API is used to get list of Template ID’s and details of Message Template as per criteria specified.
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: 1234 |
MessageCategory string Optional |
The message category for Message Maintenance Valid Values: 0,1,2,3,4 Example: 0-Status, 1-Period, 2-Monetary, 3-Security, 4-Cards Allowable Values: 30 |
MessageType string Optional |
Indicates the type of message Valid Values: 0,1 Example: 0- Email, 1-SMS Allowable Values: 30 |
TemplateName string Optional |
Name of the Template Valid Values: a-z,0-9 Allowable Values: 30 |
TemplateLanguage string Optional |
Indicates the Language of the Template Valid Values: a-z Example: English Allowable Values: 30 |
TemplateStatus string Optional |
Indicates the Status of the Template Valid Values: Active, Inactive Example: Active Allowable Values: 30 |
BatchSize integer Optional |
Number of Transaction which can be view in one Batch. Default Value would be 50 Valid Values:0-9 Format: XX |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "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": 3235, "MessageCategory": "11", "MessageType": "0", "TemplateName": "630", "TemplateLanguage": "en", "TemplateStatus": "1", "BatchSize": 10 }
Response fields details
Fields | Description |
---|---|
TemplateIDRecords array |
Description – Unique Template ID for the Template created. Valid Values:0-9 a-z |
ErrorMessage string |
|
Info_Code string |
Sample response body
{ "Message": "Request processed successfully", "Status": true, "ErrorCode": "ERR01155", "ResponseData": { "TemplateIDRecords": [ { "TemplateID": "1234", "MessageCategory": "Cards", "MessageType": "SMS", "TemplateName": "abcd", "TemplateVersion": "123", "TemplateLanguage": "English", "TemplateStatus": "Active", "Subject": "Template Subject", "MessageText": "Message Text", "InstitutionID": 1234, "lastUpdatedByUserid": "userid", "CreatedByUserID": "userid", "MessageFormat": null } ], "ErrorMessage": null, "Info_Code": null } }