Get Template History
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetTemplateHistory
Use this API to list down the Merchant Template History and Merchant Template History Details for its version ID. Use the Template ID and value in Template History Indicator will fetch out the result. If the value in the indicator is provided as '0' then it will list out the template history and if the value is provided as '1' then it will list out CPM, MRT for that template version.
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 |
|
TemplateID string Mandatory |
Unique ID assigned to template when created Valid Values:0-9, A-Z Format:XXXX Example:MOT1001 Allowable Values: 100 |
|
TemplateVersionID string Conditional |
Template Version ID , if any changes made on template it changes Valid Values:0-9, A-Z Format:XXXX Example:Template V1 Conditinon: It is mandatory when Indicator = 1. Allowable Values: 100 |
|
TemplateHistoryIndicator integer Mandatory |
Tag to check what the result of API should display 0 - List of template history 1 - List of CPM,MRT for that template version Valid Values:0-1 Format:X Example:0,1 |
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,
"TemplateID": "MOT1001",
"TemplateVersionID": null,
"TemplateHistoryIndicator": 0
}
Response fields details
| Fields | Description |
|---|---|
|
MerchantTempalteHistory array |
Array of history of template version. |
|
MerchantTempalteHistoryDetails array |
Array of history of template version. |
Sample response body
{
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"MerchantTempalteHistory": [
{
"TemplateHistoryUniqueKey": 1,
"TemplateVersionID": "Template V 1",
"LogDateTime": "04/30/2020 01:55:39",
"UserID": "user123"
}
],
"MerchantTempalteHistoryDetails": null
}
}