APIs

This section covers the details of the APIs supported by Campaign microservices.

  • Version 1.0.0
  • Version 1.0.1
  • Version 2.0.0

Version 1.0.0

This is the basic version of the Campaign microservices, which is compatible to work with the Spotlight App released in R20, to store and retrieve the campaign definition details.

Get campaigns
This API retrieves the list of campaigns based on the query parameters, such as campaignId and campaignStatus.

GET/v1.0.0/origination/campaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns
Sample Response
{
    "campaignLists": [
        {
            "campaignId": "CP100",
            "campaignName": "Home Loan campaign",
            "campaignDescription": "This is a campaign to sell home loan product",
            "objectiveType": "UPSELL",
            "productId": "HOME.LOAN",
            "productGroupId": "PERSONAL.LOANS",
            "campaignPriority": 3,
            "campaignType": "SINGLE",
            "campaignStatus": "Active",
            "startDate": "2022-02-21 00:00:00.0",
            "endDate": "2022-03-01 00:00:00.0",
            "channelTypes": [
                "ONLINE"
            ],
            "eventTriggerDetailss": [
                {
                    "eventTriggerId": "ET004",
                    "eventName": "Birthday",
                    "eventDescription": "Customer’s Birthday ",
                    "triggerType": "External",
                    "eventSource": "CRM",
                    "eventCode": "BIRTHDAY"
                }
            ],
            "profileDetailss": [
                {
                    "profileId": "PRF001",
                    "profileName": "RUBY",
                    "profileDescription": "RUBY Profile created for internal testing",
                    "profileConditionss": [
                        {
                            "profileConditionId": "PC3846934823",
                            "conditionExpression": "CustomerType eq 'RUBY'",
                            "dataContextId": "DC3143771713",
                            "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP",
                            "dataContextName": "RUBY_DATACONTEXT",
                            "dataContextDescription": "DataContext created for RUBY Profiles"
                        }
                    ]
                }
            ],
            "channelDetailss": [
                {
                    "channelSubType": "SMS",
                    "channelPriority": "2"
                },
                {
                    "channelSubType": "WEB",
                    "channelPriority": "1"
                }
            ],
            "onlineContents": [
                {
                    "onlineContentId": "OC3851279899",
                    "placeholderId": "PH007",
                    "placeholderName": "Apply for new account",
                    "placeholderDescription": "Sample place holder description",
                    "channelSubType": "WEB",
                    "placeholderIdentifier": "APPLY_FOR_NEW_ACCOUNT",
                    "imageResolution": "560x308",
                    "imageScale": "640",
                    "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Home_loan777",
                    "imageURL": "/personalloan7.jpg",
                    "imageIndex": 0
                },
                {
                    "onlineContentId": "OC0050",
                    "placeholderId": "PH002",
                    "placeholderName": "Homepage",
                    "placeholderDescription": "Sample place holder description",
                    "channelSubType": "MOBILE",
                    "placeholderIdentifier": "PRELOGIN",
                    "imageResolution": "750x212",
                    "imageScale": "2x",
                    "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Home_loan",
                    "imageURL": "/personalloan.jpg",
                    "imageIndex": 0
                }
            ],
            "offlineTemplates": [
                {
                    "offlineTemplateId": "OT3851279899",
                    "channelSubType": "EMAIL",
                    "subject": "TEST EMAIL ",
                    "content": "Hello EMAIL"
                }
            ]
        }
    ]
}
GET PROFILES
This API retrieves the list of profiles based on the profileId query parameter.

GET/v1.0.0/origination/campaigns/profiles

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/profiles
Sample Response
{
    "allProfiless": [
        {
            "profileId": "PRF2008528933",
            "profileName": "PLATINUM",
            "profileDescription": "PLATINUM Profile created for internal purpose",
            "profileConditionss": [
                {
                    "profileConditionId": "PC2008528934",
                    "conditionExpression": "CustomerType eq 'PLATINUM'",
                    "dataContextId": "DC2008528918",
                    "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP",
                    "dataContextName": "PLATINUM_DATACONTEXT",
                    "dataContextDescription": "DataContext created for PLATINUM Profiles"
                }
            ]
        },
        {
            "profileId": "PRF2008529086",
            "profileName": "ELITE",
            "profileDescription": "ELITE Profile created for internal purpose",
            "profileConditionss": [
                {
                    "profileConditionId": "PC2008529087",
                    "conditionExpression": "CustomerType eq 'ELITE'",
                    "dataContextId": "DC2008529043",
                    "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP",
                    "dataContextName": "ELITE_DATACONTEXT",
                    "dataContextDescription": "DataContext created for ELITE Profiles"
                }
            ]
        }
    ]
}
Get Event Triggers
This API retrieves the list of event triggers based on the query parameters, such as eventTriggerId, triggerType, eventCode and eventSource.

GET/v1.0.0/origination/campaigns/eventTriggers

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/eventtriggers
Sample Response
{
    "eventTriggers": [
        {
            "eventTriggerId": "ET001",
            "eventName": "SurplusFunds",
            "eventDescription": "Customer has surplus Funds in the selected account",
            "triggerType": "External",
            "eventSource": "Transact",
            "eventCode": "SURPLUSFUNDS"
        },
        {
            "eventTriggerId": "ET002",
            "eventName": "UpdatePostalCode",
            "eventDescription": "The Postal Code of the primary address of the customer is updated",
            "triggerType": "External",
            "eventSource": "CRM",
            "eventCode": "UPDATEPOSTALCODE"
        },
        {
            "eventTriggerId": "ET003",
            "eventName": "OverdrawnAccount",
            "eventDescription": "The account in consideration is overdrawn",
            "triggerType": "External",
            "eventSource": "Transact",
            "eventCode": "OVERDRAWNACCOUNT"
        },
        {
            "eventTriggerId": "ET004",
            "eventName": "Birthday",
            "eventDescription": "Customers Birthday ",
            "triggerType": "External",
            "eventSource": "CRM",
            "eventCode": "BIRTHDAY"
        },
        {
            "eventTriggerId": "ET005",
            "eventName": "PhoneUpdate",
            "eventDescription": "Customer updated the phone number ",
            "triggerType": "Internal",
            "eventSource": "Transact",
            "eventCode": "UPDATEPHONE"
        }
    ]
}
Get Placeholders
This API retrieves the list of place holders based on the query parameters, such as placeholderId, channelSubType, application and placeholderIdentifier.

GET/v1.0.0/origination/campaigns/placeholders

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/placeholders
Sample Response
{
    "placeHolders": [
        {
            "placeholderId": "PH001",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "PRELOGIN",
            "imageResolution": "375x106",
            "imageScale": "1x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH002",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "PRELOGIN",
            "imageResolution": "750x212",
            "imageScale": "2x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH003",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "PRELOGIN",
            "imageResolution": "1125x318",
            "imageScale": "3x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH004",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "POSTLOGIN",
            "imageResolution": "375x812",
            "imageScale": "1x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH005",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "POSTLOGIN",
            "imageResolution": "750x1624",
            "imageScale": "2x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH006",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "POSTLOGIN",
            "imageResolution": "1125x2436",
            "imageScale": "3x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH007",
            "placeholderName": "Apply for new account",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "APPLY_FOR_NEW_ACCOUNT",
            "imageResolution": "560x308",
            "imageScale": "640",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH008",
            "placeholderName": "Apply for new account",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "APPLY_FOR_NEW_ACCOUNT",
            "imageResolution": "668x728",
            "imageScale": "1024",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH009",
            "placeholderName": "Apply for new account",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "APPLY_FOR_NEW_ACCOUNT",
            "imageResolution": "740x304",
            "imageScale": "1366",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH010",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "560x308",
            "imageScale": "640",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH011",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "668x728",
            "imageScale": "1024",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH012",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "740x304",
            "imageScale": "1366",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH013",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "343x198",
            "imageScale": "1x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH014",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "686x396",
            "imageScale": "2x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH015",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "1029x594",
            "imageScale": "3x",
            "imageSize": "51200"
        }
    ]
}
Get Data Contexts
This API retrieves the list of datacontexts based on the dataContextId query parameter.

GET/v1.0.0/origination/campaigns/dataContexts

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/datacontexts
Sample Response
{
    "allDataContexts": [
        {
            "dataContextId": "DC001",
            "dataContextName": "Next Best Product Model flow",
            "dataContextDescription": "DataContext created for Next Best Product Model flow Profiles",
            "dataContextSource": "Analytics",
            "dataContextServiceName": "Dataset_AllCustomersNBP",
            "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP"
        },   
    ]
}
Get Campaign Details For Events
This API retrieves the list of campaigns associated with eventcode as path param and channelSubType as query param.

GET/v1.0.0/origination/campaigns/events/{eventCode}/campaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/events/UPDATEPOSTALCODE/campaigns
Sample Response
{
    "campaignLists": [
        {
            "campaignId": "CP100",
            "campaignName": "Personal Loan campaign",
            "campaignDescription": "This is a campaign to sell personal loan product",
            "objectiveType": "UPSELL",
            "productId": "PERSONAL.LOAN",
            "productGroupId": "PERSONAL.LOANS",
            "campaignPriority": 0,
            "campaignType": "SINGLE",
            "campaignStatus": "SCHEDULED_ACTIVE_COMPLETED",
            "startDate": "2025-02-28 00:00:00.0",
            "endDate": "2025-02-19 00:00:00.0",
            "channelTypes": [
                "ONLINE",
                "OFFLINE"
            ],
            "eventTriggerDetailss": [
                {
                    "eventTriggerId": "ET002",
                    "eventName": "UpdatePostalCode",
                    "eventDescription": "The Postal Code of the primary address of the customer is updated",
                    "triggerType": "External",
                    "eventSource": "CRM",
                    "eventCode": "UPDATEPOSTALCODE"
                }
            ],
            "profileDetailss": [
                {
                    "profileId": "PRF001",
                    "profileName": "RUBY",
                    "profileDescription": "RUBY Profile created for internal testing",
                    "profileConditionss": [
                        {
                            "profileConditionId": "PC3846934823",
                            "conditionExpression": "CustomerType eq 'RUBY'",
                            "dataContextId": "DC3143771713",
                            "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP",
                            "dataContextName": "RUBY_DATACONTEXT",
                            "dataContextDescription": "DataContext created for RUBY Profiles"
                        }
                    ]
                }
            ],
            "channelDetailss": [
                {
                    "channelSubType": "MOBILE",
                    "channelPriority": "2"
                }
            ],
            "onlineContents": [
                {
                    "onlineContentId": "OC3847045488",
                    "placeholderId": "PH001",
                    "placeholderName": "Homepage",
                    "placeholderDescription": "Sample place holder description",
                    "channelSubType": "MOBILE",
                    "placeholderIdentifier": "PRELOGIN",
                    "imageResolution": "375x106",
                    "imageScale": "1x",
                    "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Personal_Loan",
                    "imageURL": "/personalloan.jpg",
                    "imageIndex": 0
                }
            ],
            "offlineTemplates": [
                {
                    "offlineTemplateId": "OT3847045489",
                    "channelSubType": "SMS",
                    "subject": "TEST SMS ",
                    "content": "Hello SMS"
                }
            ]
        }
    ]
}
Get Default Campaign Details
This API retrieves the list of default campaign details based on the query parameters, such as channelSubType, placeholderIdentifier and imageScale.

GET/v1.0.0/origination/campaigns/defaultCampaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/defaultcampaigns
Sample Response
{
    "campaignLists": [
        {
            "onlineContentId": "OC019",
            "placeholderId": "PH013",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "343x198",
            "imageScale": "1x",
            "targetURL": "https://google.com",
            "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-1x-1.png",
            "imageIndex": 1
        },
        {
            "onlineContentId": "OC020",
            "placeholderId": "PH013",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "343x198",
            "imageScale": "1x",
            "targetURL": "https://google.com",
            "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-1x-2.png",
            "imageIndex": 2
        },
        {
            "onlineContentId": "OC021",
            "placeholderId": "PH013",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "343x198",
            "imageScale": "1x",
            "targetURL": "https://google.com",
            "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-1x-3.png",
            "imageIndex": 3
        }
    ]
}
create Campaign
This API allows to store the campaign details.

POST/v1.0.0/origination/campaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns
Sample Request
{
  "createCampaign": {
	"campaignId": "CP100",
    "campaignName": "Personal Loan campaign",
    "campaignDescription": "This is a campaign to sell personal loan product",
    "objectiveType": "UPSELL",
    "productId": "PERSONAL.LOAN",
    "productGroupId": "PERSONAL.LOANS",
    "campaignPriority": 0,
    "campaignType": "SINGLE",
    "startDate": "2025-02-28",
    "endDate": "2025-02-19",
    "channelType": [
      "ONLINE","OFFLINE"
    ],
    "eventTriggerIdList": [
      "ET002"
    ],
    "profileIdList": [
    	"PRF001"
    ],
    "channelDetails": [
      {
        "channelSubType": "MOBILE",
        "channelPriority": 2
      }
    ], "offlineTemplate": [
      {
        "channelSubType": "SMS",
        "subject": "TEST SMS ",
        "content": "Hello SMS"
      }
    ],
    "onlineContent": [
      {
        "placeholderId": "PH001",
        "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Personal_Loan",
        "imageURL": "/personalloan.jpg"
      }
    ]
  }
}
Sample Response
{
    "id": "CP100",
    "status": "Success",
    "message": "Campaign created successfully"
}
update Campaign
This API updates the details of a specific campaign.

PUT/v1.0.0/origination/campaigns/{campaignId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/CP100
Sample Request
{
    "updateCampaign": {
        "campaignId": "CP100",
        "campaignName": "Home Loan campaign",
        "campaignDescription": "This is a campaign to sell home loan product",
        "objectiveType": "UPSELL",
        "productId": "HOME.LOAN",
        "productGroupId": "PERSONAL.LOANS",
        "campaignPriority": 3,
        "campaignStatus": "Active",
        "campaignType": "SINGLE",
        "startDate": "2022-02-21",
        "endDate": "2022-02-29",
        "channelType": [
            "ONLINE"
        ],
        "eventTriggerIdList": [
            "ET004"
        ],
        "profileIdList": [
            "PRF001"
        ],
        "channelDetails": [
            {
                "channelSubType": "WEB",
                "channelPriority": 1
            },
            {
                "channelSubType": "SMS",
                "channelPriority": 2
            }
        ],
        "offlineTemplate": [
            {
                "channelSubType": "EMAIL",
                "subject": "TEST EMAIL ",
                "content": "Hello EMAIL"
            }
        ],
        "onlineContent": [
            {
                "onlineContentId": "OC0050",
                "placeholderId": "PH002",
                "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Home_loan",
                "imageURL": "/personalloan.jpg"
            },
            {
                "placeholderId": "PH007",
                "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Home_loan777",
                "imageURL": "/personalloan7.jpg"
            }
        ]
    }
}
Sample Response
{
    "id": "CP100",
    "status": "Success",
    "message": "Campaign updated successfully"
}
create Profile
This API allows to store the profile details.

POST/v1.0.0/origination/campaigns/profiles

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/profiles
Sample Request
{
  "profile": {
    "profileId": "",
    "profileName": "PLATINUM",
    "profileDescription": "PLATINUM Profile created for internal purpose",
    "profileConditions": [
      {
        "profileConditionId": "",
        "conditionExpression": "CustomerType eq 'PLATINUM'",
        "dataContextId": "DC3504276234"
      }
    ]
  }
}
Sample Response
{
    "id": "PRF001",
    "status": "Success",
    "message": "Profile created successfully"
}
update Profile
This API updates the details of a specific profile.

PUT/v1.0.0/origination/campaigns/profiles/{profileId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/profiles/PRF001
Sample Request
{
  "profile": {
    "profileId": "PRF001",
    "profileName": "PLATINUM",
    "profileDescription": "PLATINUM Profile created for internal purpose",
    "profileConditions": [
      {
        "profileConditionId": "PC3505597003",
        "conditionExpression": "CustomerType eq 'PLATINUM'",
        "dataContextId": "DC3480049371"
      }
    ]
  }
}
Sample Response
{
    "id": "PRF001",
    "status": "Success",
    "message": "Profile updated successfully"
}
create Event Trigger
This API allows to store the event trigger details.

POST/v1.0.0/origination/campaigns/eventTriggers

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/eventTriggers
Sample Request
{
  "eventTrigger": {
    "eventTriggerId": "ET123",
    "eventName": "SurplusFunds",
    "eventDescription": "Customer has surplus Funds in the selected account",
    "triggerType": "External",
    "eventSource": "Transact/DS",
    "eventCode": "SURPLUSFUNDS"
  }
}
Sample Response
{
    "id": "ET123",
    "status": "Success",
    "message": "Event trigger created successfully"
}
update Event Trigger
This API updates the details of a specific event trigger.

PUT/v1.0.0/origination/campaigns/eventTriggers/{eventTriggerId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/eventTriggers/ET123
Sample Request
{
  "eventTrigger": {
    "eventTriggerId": "ET123",
    "eventName": "SurplusFunds",
    "eventDescription": "Customer has surplus Funds in the selected account",
    "triggerType": "External",
    "eventSource": "Transact/DS",
    "eventCode": "SURPLUSFUNDS"
  }
}
Sample Response
{
    "id": "ET123",
    "status": "Success",
    "message": "Event trigger updated successfully"
}
create Place holder
This API allows to store the placeholder details.

POST/v1.0.0/origination/campaigns/placeholders

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/placeholders
Sample Request
{
    "placeHolder": {
        "placeholderId": "PH010",
        "placeholderName": "Homepage",
        "placeholderDescription": " Insert Testing ",
        "channelSubType": "Internet Banking",
        "application": "RETAIL BANKING",
        "placeholderIdentifier": "PRELOGIN",
        "imageResolution": "375x106",
        "imageScale": "1x",
        "imageSize": "51200 kb"
    }
}
Sample Response
{
    "id": "PH010",
    "status": "Success",
    "message": "Placeholder created successfully"
}
update Placeholder
This API updates the details of a specific placeholder.

PUT/v1.0.0/origination/campaigns/placeholders/{placeholderId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/placeholders/PH010
Sample Request
{
    "placeHolder": {
        "placeholderId": "PH010",
        "placeholderName": "Dashboard ",
        "placeholderDescription": " Update Testing Dashboard placeholder",
        "channelSubType": "Mobile Banking",
        "application": "CORPORATE BANKING",
        "placeholderIdentifier": "POSTLOGIN",
        "imageResolution": "375x166",
        "imageScale": "2x",
        "imageSize": "512 kb"
    }
}
Sample Response
{
    "id": "PH010",
    "status": "Success",
    "message": "Placeholder updated successfully"
}
update Default Campaigns
This API updates the details of the default campaigns.

PUT/v1.0.0/origination/campaigns/defaultCampaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/defaultCampaigns
Sample Request
{
  "defaultCampaign": [
    {
      "onlineContentId": "OC001",
      "placeholderId": "PH001",
      "targetURL": "https://youtube.com",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-4.jpg",
      "imageIndex": "2"
    },
    {
      "onlineContentId": "OC002",
      "placeholderId": "PH001",
      "targetURL": "https://youtube.com",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-5.jpg",
      "imageIndex": "2"
    },
    {
      "onlineContentId": "OC003",
      "placeholderId": "PH001",
      "targetURL": "https://youtube.com",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-6.jpg",
      "imageIndex": "2"
    }
  ]
}
Sample Response
{
    "id": " OC001 OC002 OC003",
    "status": "Success",
    "message": "Default campaigns updated successfully"
}
create Data context
This API creates a new context.

POST/v1.0.0//origination/campaigns/dataContexts

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/dataContexts
Sample Request
{
  "dataContext": {
     "dataContextId": "DC009",
     "dataContextName": "Next Best Product Model flow",
     "dataContextDescription": "DataContext created for Next Best Product Model flow Profiles",
     "dataContextSource": "Analytics",
     "dataContextServiceName": "Dataset_AllCustomersNBP",
     "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP"
  }
}					}
Sample Response
{
    "id": "DC009",
    "status": "Success",
    "message": "Data context created successfully"
}
update Data context
This API updates the existing details of data context.

PUT/v1.0.0//origination/campaigns/dataContexts/{dataContextId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.0/origination/campaigns/dataContexts/DC001
Sample Request
{
  "dataContext": {
    "dataContextId": "DC001",
    "dataContextName": "Next Best Product Model flow",
    "dataContextDescription": "DataContext created for Next Best Product Model flow Profiles",
    "dataContextSource": "Analytics",
    "dataContextServiceName": "Dataset_AllCustomersNBP",
    "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP"
  }
}					}
Sample Response
{
    "id": "DC001",
    "status": "Success",
    "message": "Data context updated successfully"
}

Version 1.0.1

In this version, the names of the collections (arrays) in all GET API responses have been modified based on the naming standard followed in the API defintions.

Get campaigns
This API retrieves the list of campaigns based on the query parameters, such as campaignId and campaignStatus.

GET/v1.0.1/origination/campaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns
Sample Response
{
    "campaignList": [
        {
            "campaignId": "CP100",
            "campaignName": "Home Loan campaign",
            "campaignDescription": "This is a campaign to sell home loan product",
            "objectiveType": "UPSELL",
            "productId": "HOME.LOAN",
            "productGroupId": "PERSONAL.LOANS",
            "campaignPriority": 3,
            "campaignType": "SINGLE",
            "campaignStatus": "Active",
            "startDate": "2022-02-21 00:00:00.0",
            "endDate": "2022-03-01 00:00:00.0",
            "channelType": [
                "ONLINE"
            ],
            "eventTriggerDetails": [
                {
                    "eventTriggerId": "ET004",
                    "eventName": "Birthday",
                    "eventDescription": "Customer’s Birthday ",
                    "triggerType": "External",
                    "eventSource": "CRM",
                    "eventCode": "BIRTHDAY"
                }
            ],
            "profileDetails": [
                {
                    "profileId": "PRF001",
                    "profileName": "RUBY",
                    "profileDescription": "RUBY Profile created for internal testing",
                    "profileConditionss": [
                        {
                            "profileConditionId": "PC3846934823",
                            "conditionExpression": "CustomerType eq 'RUBY'",
                            "dataContextId": "DC3143771713",
                            "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP",
                            "dataContextName": "RUBY_DATACONTEXT",
                            "dataContextDescription": "DataContext created for RUBY Profiles"
                        }
                    ]
                }
            ],
            "channelDetails": [
                {
                    "channelSubType": "SMS",
                    "channelPriority": "2"
                },
                {
                    "channelSubType": "WEB",
                    "channelPriority": "1"
                }
            ],
            "onlineContent": [
                {
                    "onlineContentId": "OC3851279899",
                    "placeholderId": "PH007",
                    "placeholderName": "Apply for new account",
                    "placeholderDescription": "Sample place holder description",
                    "channelSubType": "WEB",
                    "placeholderIdentifier": "APPLY_FOR_NEW_ACCOUNT",
                    "imageResolution": "560x308",
                    "imageScale": "640",
                    "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Home_loan777",
                    "imageURL": "/personalloan7.jpg",
                    "imageIndex": 0
                },
                {
                    "onlineContentId": "OC0050",
                    "placeholderId": "PH002",
                    "placeholderName": "Homepage",
                    "placeholderDescription": "Sample place holder description",
                    "channelSubType": "MOBILE",
                    "placeholderIdentifier": "PRELOGIN",
                    "imageResolution": "750x212",
                    "imageScale": "2x",
                    "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Home_loan",
                    "imageURL": "/personalloan.jpg",
                    "imageIndex": 0
                }
            ],
            "offlineTemplate": [
                {
                    "offlineTemplateId": "OT3851279899",
                    "channelSubType": "EMAIL",
                    "subject": "TEST EMAIL ",
                    "content": "Hello EMAIL"
                }
            ]
        }
    ]
}
GET PROFILES
This API retrieves the list of profiles based on the profileId query parameter.

GET/v1.0.1/origination/campaigns/profiles

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/profiles
Sample Response
{
    "allProfiles": [
        {
            "profileId": "PRF2008528933",
            "profileName": "PLATINUM",
            "profileDescription": "PLATINUM Profile created for internal purpose",
            "profileConditions": [
                {
                    "profileConditionId": "PC2008528934",
                    "conditionExpression": "CustomerType eq 'PLATINUM'",
                    "dataContextId": "DC2008528918",
                    "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP",
                    "dataContextName": "PLATINUM_DATACONTEXT",
                    "dataContextDescription": "DataContext created for PLATINUM Profiles"
                }
            ]
        },
        {
            "profileId": "PRF2008529086",
            "profileName": "ELITE",
            "profileDescription": "ELITE Profile created for internal purpose",
            "profileConditions": [
                {
                    "profileConditionId": "PC2008529087",
                    "conditionExpression": "CustomerType eq 'ELITE'",
                    "dataContextId": "DC2008529043",
                    "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP",
                    "dataContextName": "ELITE_DATACONTEXT",
                    "dataContextDescription": "DataContext created for ELITE Profiles"
                }
            ]
        }
    ]
}
Get Event Triggers
This API retrieves the list of event triggers based on the query parameters, such as eventTriggerId, triggerType, eventCode and eventSource.

GET/v1.0.1/origination/campaigns/eventTriggers

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/eventtriggers
Sample Response
{
    "eventTrigger": [
        {
            "eventTriggerId": "ET001",
            "eventName": "SurplusFunds",
            "eventDescription": "Customer has surplus Funds in the selected account",
            "triggerType": "External",
            "eventSource": "Transact",
            "eventCode": "SURPLUSFUNDS"
        },
        {
            "eventTriggerId": "ET002",
            "eventName": "UpdatePostalCode",
            "eventDescription": "The Postal Code of the primary address of the customer is updated",
            "triggerType": "External",
            "eventSource": "CRM",
            "eventCode": "UPDATEPOSTALCODE"
        },
        {
            "eventTriggerId": "ET003",
            "eventName": "OverdrawnAccount",
            "eventDescription": "The account in consideration is overdrawn",
            "triggerType": "External",
            "eventSource": "Transact",
            "eventCode": "OVERDRAWNACCOUNT"
        },
        {
            "eventTriggerId": "ET004",
            "eventName": "Birthday",
            "eventDescription": "Customers Birthday ",
            "triggerType": "External",
            "eventSource": "CRM",
            "eventCode": "BIRTHDAY"
        },
        {
            "eventTriggerId": "ET005",
            "eventName": "PhoneUpdate",
            "eventDescription": "Customer updated the phone number ",
            "triggerType": "Internal",
            "eventSource": "Transact",
            "eventCode": "UPDATEPHONE"
        }
    ]
}
Get Placeholders
This API retrieves the list of place holders based on the query parameters, such as placeholderId, channelSubType, application and placeholderIdentifier.

GET/v1.0.1/origination/campaigns/placeholders

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/placeholders
Sample Response
{
    "placeHolder": [
        {
            "placeholderId": "PH001",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "PRELOGIN",
            "imageResolution": "375x106",
            "imageScale": "1x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH002",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "PRELOGIN",
            "imageResolution": "750x212",
            "imageScale": "2x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH003",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "PRELOGIN",
            "imageResolution": "1125x318",
            "imageScale": "3x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH004",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "POSTLOGIN",
            "imageResolution": "375x812",
            "imageScale": "1x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH005",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "POSTLOGIN",
            "imageResolution": "750x1624",
            "imageScale": "2x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH006",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "POSTLOGIN",
            "imageResolution": "1125x2436",
            "imageScale": "3x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH007",
            "placeholderName": "Apply for new account",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "APPLY_FOR_NEW_ACCOUNT",
            "imageResolution": "560x308",
            "imageScale": "640",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH008",
            "placeholderName": "Apply for new account",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "APPLY_FOR_NEW_ACCOUNT",
            "imageResolution": "668x728",
            "imageScale": "1024",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH009",
            "placeholderName": "Apply for new account",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "APPLY_FOR_NEW_ACCOUNT",
            "imageResolution": "740x304",
            "imageScale": "1366",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH010",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "560x308",
            "imageScale": "640",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH011",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "668x728",
            "imageScale": "1024",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH012",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "WEB",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "740x304",
            "imageScale": "1366",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH013",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "343x198",
            "imageScale": "1x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH014",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "686x396",
            "imageScale": "2x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH015",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": " RETAIL_BANKING",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "1029x594",
            "imageScale": "3x",
            "imageSize": "51200"
        }
    ]
}
Get Data Contexts
This API retrieves the list of datacontexts based on the dataContextId query parameter.

GET/v1.0.1/origination/campaigns/dataContexts

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/datacontexts
Sample Response
{
    "allDataContext": [
        {
            "dataContextId": "DC001",
            "dataContextName": "Next Best Product Model flow",
            "dataContextDescription": "DataContext created for Next Best Product Model flow Profiles",
            "dataContextSource": "Analytics",
            "dataContextServiceName": "Dataset_AllCustomersNBP",
            "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP"
        },   
    ]
}
Get Campaign Details For Events
This API retrieves the list of campaigns associated with eventcode as path param and channelSubType as query param.

GET/v1.0.1/origination/campaigns/events/{eventCode}/campaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/events/UPDATEPOSTALCODE/campaigns
Sample Response
{
    "campaignList": [
        {
            "campaignId": "CP100",
            "campaignName": "Personal Loan campaign",
            "campaignDescription": "This is a campaign to sell personal loan product",
            "objectiveType": "UPSELL",
            "productId": "PERSONAL.LOAN",
            "productGroupId": "PERSONAL.LOANS",
            "campaignPriority": 0,
            "campaignType": "SINGLE",
            "campaignStatus": "SCHEDULED_ACTIVE_COMPLETED",
            "startDate": "2025-02-28 00:00:00.0",
            "endDate": "2025-02-19 00:00:00.0",
            "channelType": [
                "ONLINE",
                "OFFLINE"
            ],
            "eventTriggerDetails": [
                {
                    "eventTriggerId": "ET002",
                    "eventName": "UpdatePostalCode",
                    "eventDescription": "The Postal Code of the primary address of the customer is updated",
                    "triggerType": "External",
                    "eventSource": "CRM",
                    "eventCode": "UPDATEPOSTALCODE"
                }
            ],
            "profileDetails": [
                {
                    "profileId": "PRF001",
                    "profileName": "RUBY",
                    "profileDescription": "RUBY Profile created for internal testing",
                    "profileConditions": [
                        {
                            "profileConditionId": "PC3846934823",
                            "conditionExpression": "CustomerType eq 'RUBY'",
                            "dataContextId": "DC3143771713",
                            "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP",
                            "dataContextName": "RUBY_DATACONTEXT",
                            "dataContextDescription": "DataContext created for RUBY Profiles"
                        }
                    ]
                }
            ],
            "channelDetails": [
                {
                    "channelSubType": "MOBILE",
                    "channelPriority": "2"
                }
            ],
            "onlineContent": [
                {
                    "onlineContentId": "OC3847045488",
                    "placeholderId": "PH001",
                    "placeholderName": "Homepage",
                    "placeholderDescription": "Sample place holder description",
                    "channelSubType": "MOBILE",
                    "placeholderIdentifier": "PRELOGIN",
                    "imageResolution": "375x106",
                    "imageScale": "1x",
                    "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Personal_Loan",
                    "imageURL": "/personalloan.jpg",
                    "imageIndex": 0
                }
            ],
            "offlineTemplate": [
                {
                    "offlineTemplateId": "OT3847045489",
                    "channelSubType": "SMS",
                    "subject": "TEST SMS ",
                    "content": "Hello SMS"
                }
            ]
        }
    ]
}
Get Default Campaign Details
This API retrieves the list of default campaign details based on the query parameters, such as channelSubType, placeholderIdentifier and imageScale.

GET/v1.0.1/origination/campaigns/defaultCampaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/defaultcampaigns
Sample Response
{
    "campaignList": [
        {
            "onlineContentId": "OC019",
            "placeholderId": "PH013",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "343x198",
            "imageScale": "1x",
            "targetURL": "https://google.com",
            "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-1x-1.png",
            "imageIndex": 1
        },
        {
            "onlineContentId": "OC020",
            "placeholderId": "PH013",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "343x198",
            "imageScale": "1x",
            "targetURL": "https://google.com",
            "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-1x-2.png",
            "imageIndex": 2
        },
        {
            "onlineContentId": "OC021",
            "placeholderId": "PH013",
            "placeholderName": "Account Dashboard",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "placeholderIdentifier": "ACCOUNT_DASHBOARD",
            "imageResolution": "343x198",
            "imageScale": "1x",
            "targetURL": "https://google.com",
            "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-1x-3.png",
            "imageIndex": 3
        }
    ]
}
create Campaign
This API allows to store the campaign details.

POST/v1.0.1/origination/campaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns
Sample Request
{
  "createCampaign": {
	"campaignId": "CP100",
    "campaignName": "Personal Loan campaign",
    "campaignDescription": "This is a campaign to sell personal loan product",
    "objectiveType": "UPSELL",
    "productId": "PERSONAL.LOAN",
    "productGroupId": "PERSONAL.LOANS",
    "campaignPriority": 0,
    "campaignType": "SINGLE",
    "startDate": "2025-02-28",
    "endDate": "2025-02-19",
    "channelType": [
      "ONLINE","OFFLINE"
    ],
    "eventTriggerIdList": [
      "ET002"
    ],
    "profileIdList": [
    	"PRF001"
    ],
    "channelDetails": [
      {
        "channelSubType": "MOBILE",
        "channelPriority": 2
      }
    ], "offlineTemplate": [
      {
        "channelSubType": "SMS",
        "subject": "TEST SMS ",
        "content": "Hello SMS"
      }
    ],
    "onlineContent": [
      {
        "placeholderId": "PH001",
        "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Personal_Loan",
        "imageURL": "/personalloan.jpg"
      }
    ]
  }
}
Sample Response
{
    "id": "CP100",
    "status": "Success",
    "message": "Campaign created successfully"
}
update Campaign
This API updates the details of a specific campaign.

PUT/v1.0.1/origination/campaigns/{campaignId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/CP100
Sample Request
{
    "updateCampaign": {
        "campaignId": "CP100",
        "campaignName": "Home Loan campaign",
        "campaignDescription": "This is a campaign to sell home loan product",
        "objectiveType": "UPSELL",
        "productId": "HOME.LOAN",
        "productGroupId": "PERSONAL.LOANS",
        "campaignPriority": 3,
        "campaignStatus": "Active",
        "campaignType": "SINGLE",
        "startDate": "2022-02-21",
        "endDate": "2022-02-29",
        "channelType": [
            "ONLINE"
        ],
        "eventTriggerIdList": [
            "ET004"
        ],
        "profileIdList": [
            "PRF001"
        ],
        "channelDetails": [
            {
                "channelSubType": "WEB",
                "channelPriority": 1
            },
            {
                "channelSubType": "SMS",
                "channelPriority": 2
            }
        ],
        "offlineTemplate": [
            {
                "channelSubType": "EMAIL",
                "subject": "TEST EMAIL ",
                "content": "Hello EMAIL"
            }
        ],
        "onlineContent": [
            {
                "onlineContentId": "OC0050",
                "placeholderId": "PH002",
                "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Home_loan",
                "imageURL": "/personalloan.jpg"
            },
            {
                "placeholderId": "PH007",
                "targetURL": "https://dbxint5.konylabs.net:8443/apps/konyOLB/?actionType=internal&moduleName=Home_loan777",
                "imageURL": "/personalloan7.jpg"
            }
        ]
    }
}
Sample Response
{
    "id": "CP100",
    "status": "Success",
    "message": "Campaign updated successfully"
}
create Profile
This API allows to store the profile details.

POST/v1.0.1/origination/campaigns/profiles

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/profiles
Sample Request
{
  "profile": {
    "profileId": "",
    "profileName": "PLATINUM",
    "profileDescription": "PLATINUM Profile created for internal purpose",
    "profileConditions": [
      {
        "profileConditionId": "",
        "conditionExpression": "CustomerType eq 'PLATINUM'",
        "dataContextId": "DC3504276234"
      }
    ]
  }
}
Sample Response
{
    "id": "PRF001",
    "status": "Success",
    "message": "Profile created successfully"
}
update Profile
This API updates the details of a specific profile.

PUT/v1.0.1/origination/campaigns/profiles/{profileId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/profiles/PRF001
Sample Request
{
  "profile": {
    "profileId": "PRF001",
    "profileName": "PLATINUM",
    "profileDescription": "PLATINUM Profile created for internal purpose",
    "profileConditions": [
      {
        "profileConditionId": "PC3505597003",
        "conditionExpression": "CustomerType eq 'PLATINUM'",
        "dataContextId": "DC3480049371"
      }
    ]
  }
}
Sample Response
{
    "id": "PRF001",
    "status": "Success",
    "message": "Profile updated successfully"
}
create Event Trigger
This API allows to store the event trigger details.

POST/v1.0.1/origination/campaigns/eventTriggers

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/eventTriggers
Sample Request
{
  "eventTrigger": {
    "eventTriggerId": "ET123",
    "eventName": "SurplusFunds",
    "eventDescription": "Customer has surplus Funds in the selected account",
    "triggerType": "External",
    "eventSource": "Transact/DS",
    "eventCode": "SURPLUSFUNDS"
  }
}
Sample Response
{
    "id": "ET123",
    "status": "Success",
    "message": "Event trigger created successfully"
}
update Event Trigger
This API updates the details of a specific event trigger.

PUT/v1.0.1/origination/campaigns/eventTriggers/{eventTriggerId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/eventTriggers/ET123
Sample Request
{
  "eventTrigger": {
    "eventTriggerId": "ET123",
    "eventName": "SurplusFunds",
    "eventDescription": "Customer has surplus Funds in the selected account",
    "triggerType": "External",
    "eventSource": "Transact/DS",
    "eventCode": "SURPLUSFUNDS"
  }
}
Sample Response
{
    "id": "ET123",
    "status": "Success",
    "message": "Event trigger updated successfully"
}
create Place holder
This API allows to store the placeholder details.

POST/v1.0.1/origination/campaigns/placeholders

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/placeholders
Sample Request
{
    "placeHolder": {
        "placeholderId": "PH010",
        "placeholderName": "Homepage",
        "placeholderDescription": " Insert Testing ",
        "channelSubType": "Internet Banking",
        "application": "RETAIL BANKING",
        "placeholderIdentifier": "PRELOGIN",
        "imageResolution": "375x106",
        "imageScale": "1x",
        "imageSize": "51200 kb"
    }
}
Sample Response
{
    "id": "PH010",
    "status": "Success",
    "message": "Placeholder created successfully"
}
update Placeholder
This API updates the details of a specific placeholder.

PUT/v1.0.1/origination/campaigns/placeholders/{placeholderId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/placeholders/PH010
Sample Request
{
    "placeHolder": {
        "placeholderId": "PH010",
        "placeholderName": "Dashboard ",
        "placeholderDescription": " Update Testing Dashboard placeholder",
        "channelSubType": "Mobile Banking",
        "application": "CORPORATE BANKING",
        "placeholderIdentifier": "POSTLOGIN",
        "imageResolution": "375x166",
        "imageScale": "2x",
        "imageSize": "512 kb"
    }
}
Sample Response
{
    "id": "PH010",
    "status": "Success",
    "message": "Placeholder updated successfully"
}
update Default Campaigns
This API updates the details of the default campaigns.

PUT/v1.0.1/origination/campaigns/defaultCampaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/defaultCampaigns
Sample Request
{
  "defaultCampaign": [
    {
      "onlineContentId": "OC001",
      "placeholderId": "PH001",
      "targetURL": "https://youtube.com",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-4.jpg",
      "imageIndex": "2"
    },
    {
      "onlineContentId": "OC002",
      "placeholderId": "PH001",
      "targetURL": "https://youtube.com",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-5.jpg",
      "imageIndex": "2"
    },
    {
      "onlineContentId": "OC003",
      "placeholderId": "PH001",
      "targetURL": "https://youtube.com",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-6.jpg",
      "imageIndex": "2"
    }
  ]
}
Sample Response
{
    "id": " OC001 OC002 OC003",
    "status": "Success",
    "message": "Default campaigns updated successfully"
}
create Data context
This API creates a new context.

POST/v1.0.1//origination/campaigns/dataContexts

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/dataContexts
Sample Request
{
  "dataContext": {
     "dataContextId": "DC009",
     "dataContextName": "Next Best Product Model flow",
     "dataContextDescription": "DataContext created for Next Best Product Model flow Profiles",
     "dataContextSource": "Analytics",
     "dataContextServiceName": "Dataset_AllCustomersNBP",
     "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP"
  }
}					}
Sample Response
{
    "id": "DC009",
    "status": "Success",
    "message": "Data context created successfully"
}
update Data context
This API updates the existing details of data context.

PUT/v1.0.1//origination/campaigns/dataContexts/{dataContextId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v1.0.1/origination/campaigns/dataContexts/DC001
Sample Request
{
  "dataContext": {
    "dataContextId": "DC001",
    "dataContextName": "Next Best Product Model flow",
    "dataContextDescription": "DataContext created for Next Best Product Model flow Profiles",
    "dataContextSource": "Analytics",
    "dataContextServiceName": "Dataset_AllCustomersNBP",
    "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP"
  }
}					}
Sample Response
{
    "id": "DC001",
    "status": "Success",
    "message": "Data context updated successfully"
}

Version 2.0.0

This version supports the following capabilities and features:

  • End to end support to configure the Pop up message content details which can enable the display of campaigns in a Pop up window. Pop up message content details includes banner title, banner description, call to action button details, button label and button target URL.
  • Capability to store the additional details (related to Campaign Profiles), such as profile status, profile creation date, profile deactivated date and number of users.
Get campaigns
This API retrieves the list of campaigns based on the query parameters, such as campaignId and campaignStatus.

GET/v2.0.0/origination/campaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/
Sample Response
{
    "campaignList": [
        {
            "campaignId": "CP1001",
            "campaignName": "CREDIT CARD Campaign",
            "campaignDescription": "campaign for CREDIT CARD",
            "objectiveType": "YES",
            "productId": "POPUP_ADs",
            "productGroupId": "POPUP_ADs",
            "campaignPriority": 0,
            "campaignType": "POPUP",
            "campaignStatus": "ACTIVE",
            "startDate": "2020-06-11 00:00:00.0",
            "endDate": "2021-05-21 00:00:00.0",
            "channelType": [
                "ONLINE"
            ],
            "eventTriggerDetails": [
                {
                    "eventTriggerId": "ET007",
                    "eventName": "AccountDashboard",
                    "eventDescription": "User landed on the account dashboard page",
                    "eventTriggerType": "Internal",
                    "eventSource": "Transact/CRM/DS",
                    "eventCode": "ACCOUNTDASHBOARD"
                }
            ],
            "profileDetails": [
                {
                    "profileId": "PRF1001",
                    "profileName": "PEARL",
                    "profileDescription": "PEARL Profile created for Credit Card Offers",
                    "profileStatus": "Active",
                    "profileCreationDate": "2020-06-11 00:00:00.0",
                    "profileConditions": [
                        {
                            "profileConditionId": "PC1001",
                            "conditionExpression": "where group_operator = 'OR' and select _operator = 'OR'",
                            "dataContextId": "DC1001",
                            "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomers",
                            "dataContextName": "PEARL DATACONTEXT",
                            "dataContextDescription": "DataContext created for PEARL Profiles"
                        }
                    ]
                }
            ],
            "channelDetails": [
                {
                    "channelSubType": "MOBILE",
                    "channelPriority": "0"
                }
            ],
            "onlineContent": [
                {
                    "onlineContentId": "OC1001",
                    "placeholderId": "PH013",
                    "placeholderName": "Account Dashboard",
                    "placeholderDescription": "Sample place holder description",
                    "channelSubType": "MOBILE",
                    "placeholderIdentifier": "ACCOUNT_DASHBOARD",
                    "imageResolution": "343x198",
                    "imageScale": "1x",
                    "targetURL": "https://google.com",
                    "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-1x-1.png",
                    "imageIndex": 0,
                    "callToActionButtonLabel": "GOT IT",
                    "callToActionTargetURL": "",
                    "showReadLaterButton": "Y",
                    "showCloseIcon": "Y",
                    "bannerTitle": "Credit Card Offer",
                    "bannerDescription": "Campaign popup for Credit Card"
                }
            ],
            "offlineTemplate": [
                {
                    "offlineTemplateId": "OT1001",
                    "channelSubType": "SMS",
					"subject": "Credit Card offer",
					"messageContent": "LifeTime free credit card offer. Please check with nearest centre"
                }
            ]
        }
    ]
}
GET PROFILES
This API retrieves the list of profiles based on the profileId query parameter.

GET/v2.0.0/origination/campaigns/profiles

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/profiles/
Sample Response
{
    "allProfiles": [
        {
            "profileId": "PRF1001",
            "profileName": "PEARL PROFILE",
            "profileDescription": "PEARL Profile created for internal testing",
            "profileStatus": "Active",
            "profileCreationDate": "2020-06-11 00:00:00.0",
            "numberOfCampaigns": 0,
            "associatedCampaignDetails": [],
            "profileConditions": [
                {
                    "profileConditionId": "PC1001",
                    "conditionExpression": "where group_operator = 'OR' and select _operator = 'OR'",
                    "dataContextId": "DC1001",
                    "dataContextEndPoints": "http://localhost:8080/ms-campaign-api/api/v2.0.0/campaignmanagement",
                    "dataContextName": "PEARL DATACONTEXT",
                    "dataContextDescription": "DataContext created for PEARL Profiles"
                }
            ]
        }
    ]
}
Get Event Triggers
This API retrieves the list of event triggers based on the query parameters, such as eventTriggerId, triggerType, eventCode and eventSource.

GET/v2.0.0/origination/campaigns/eventTriggers

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/eventTriggers/
Sample Response
{
    "eventTrigger": [
        {
            "eventTriggerId": "ET001",
            "eventName": "SurplusFunds",
            "eventDescription": "Customer has surplus Funds in the selected account",
            "eventTriggerType": "External",
            "eventSource": "Transact/DS",
            "eventCode": "SURPLUSFUNDS"
        },
        {
            "eventTriggerId": "ET002",
            "eventName": "OverdrawnAccount",
            "eventDescription": "The account in consideration is overdrawn",
            "eventTriggerType": "External",
            "eventSource": "Transact/DS",
            "eventCode": "OVERDRAWNACCOUNT"
        },
        {
            "eventTriggerId": "ET1001",
			"eventName": "Pearl CreditCards",
			"eventDescription": "Event for Pearl CreditCards",
			"eventTriggerType": "external",
			"eventSource": "crm",
			"eventCode": "Pearl"
        }
    ]
}
Get Placeholders
This API retrieves the list of place holders based on the query parameters, such as placeholderId, channelSubType, application and placeholderIdentifier.

GET/v2.0.0/origination/campaigns/placeholders

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/placeholders/
Sample Response
{
    "placeHolder": [
        {
            "placeholderId": "PH001",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": "RETAIL BANKING",
            "placeholderIdentifier": "PRELOGIN",
            "imageResolution": "375x106",
            "imageScale": "1x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH002",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "application": "RETAIL BANKING",
            "placeholderIdentifier": "PRELOGIN",
            "imageResolution": "750x212",
            "imageScale": "2x",
            "imageSize": "51200"
        },
        {
            "placeholderId": "PH1001",
            "placeholderName": "Homepage",
            "placeholderDescription": "Homepage Placeholder",
            "channelSubType": "Internet Banking",
            "application": "RETAIL BANKING",
            "placeholderIdentifier": "Pre-Login",
            "imageResolution": "375x106",
            "imageScale": "1x",
            "imageSize": "51200 kb"
        }
    ]
}
Get Data Contexts
This API retrieves the list of datacontexts based on the dataContextId query parameter.

GET/v2.0.0/origination/campaigns/dataContexts

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/datacontexts/
Sample Response
{
    {
      "dataContextId":"DC001",
      "dataContextName":"Next Best Product Model flow",
      "dataContextDescription":"DataContext created for Next Best Product Model flow Profiles",
      "dataContextSource":"Analytics",
      "dataContextServiceName":"Dataset_AllCustomersNBP",
      "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP"
   },
   {
      "dataContextId":"DC002",
      "dataContextName":"Customer Attrition Model flow",
      "dataContextDescription":"Customer Attrition Model flow",
      "dataContextSource":"Analytics",
      "dataContextServiceName":"Dataset_AllCustomersAttrition",
      "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomers"
   },
   {
      "dataContextId":"DC003",
      "dataContextName":"Funds flow",
      "dataContextDescription":"Funds flow",
      "dataContextSource":"Analytics",
      "dataContextServiceName":"Dataset_AllCustomersFunds",
      "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomers"
   }
]
}
Get Campaigns BY Event
This API retrieves the list of campaigns associated with eventcode as path param and channelSubType as query param.

GET/v2.0.0/origination/events/{eventId}/campaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/events/ACCOUNTDASHBOARD/campaigns
Sample Response
{
    "campaignList": [
        {
            "campaignId": "CP2016340981",
            "campaignName": "POPUP_AD_Campaign",
            "campaignDescription": "campaign for POPUP ADs",
            "objectiveType": "YES",
            "productId": "POPUP_AD",
            "productGroupId": "POPUP_AD",
            "campaignPriority": 0,
            "campaignType": "POPUP",
            "campaignStatus": "ACTIVE",
            "startDate": "2020-06-11 00:00:00.0",
            "endDate": "2021-05-21 00:00:00.0",
            "channelType": [
                "ONLINE"
            ],
            "eventTriggerDetails": [
                {
                    "eventTriggerId": "ET007",
                    "eventName": "AccountDashboard",
                    "eventDescription": "User landed on the account dashboard page",
                    "eventTriggerType": "Internal",
                    "eventSource": "Transact/CRM/DS",
                    "eventCode": "ACCOUNTDASHBOARD"
                }
            ],
            "profileDetails": [
                {
                    "profileId": "PRF1001",
                    "profileName": "PEARL",
                    "profileDescription": "PEARL Profile created for Credit Card Offers",
                    "profileStatus": "Active",
                    "profileCreationDate": "2020-06-11 00:00:00.0",
                    "profileConditions": [
                        {
                            "profileConditionId": "PC1001",
                            "conditionExpression": "where group_operator = 'OR' and select _operator = 'OR'",
                            "dataContextId": "DC1001",
                            "dataContextEndPoints": "http://localhost:8080/ms-campaign-api/api/v2.0.0/campaignmanagement",
                            "dataContextName": "PEARL DATACONTEXT",
                            "dataContextDescription": "DataContext created for PEARL Profiles"
                        }
                    ]
                }
            ],
            "channelDetails": [
                {
                    "channelSubType": "MOBILE",
                    "channelPriority": "0"
                }
            ],
            "onlineContent": [
                {
                    "onlineContentId": "OC1001",
                    "placeholderId": "PH013",
                    "placeholderName": "Account Dashboard",
                    "placeholderDescription": "Sample place holder description",
                    "channelSubType": "MOBILE",
                    "placeholderIdentifier": "ACCOUNT_DASHBOARD",
                    "imageResolution": "343x198",
                    "imageScale": "1x",
                    "targetURL": "https://google.com",
                    "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-1x-1.png",
                    "imageIndex": 0,
                    "callToActionButtonLabel": "GOT IT",
                    "callToActionTargetURL": "",
                    "showReadLaterButton": "Y",
                    "showCloseIcon": "Y",
                    "bannerTitle": "Credit Card Offer",
                    "bannerDescription": "Campaign popup for Credit Card Offer"
                }
            ],
            "offlineTemplate": [
                {
                    "offlineTemplateId": "OT1001",
                    "channelSubType": "SMS",
					"subject": "Credit Card offer",
					"messageContent": "LifeTime free credit card offer. Please check with nearest centre"
                }
            ]
        }
    ]
}
Get Default Campaigns
This API retrieves the list of default campaign details based on the query parameters, such as channelSubType, placeholderIdentifier and imageScale.

GET/v2.0.0/origination/campaigns/defaultCampaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/defaultCampaigns
Sample Response
{
    "campaignList": [
        {
            "onlineContentId": "OC001",
            "placeholderId": "PH001",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "placeholderIdentifier": "PRELOGIN",
            "imageResolution": "375x106",
            "imageScale": "1x",
            "targetURL": "https://google.com",
            "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-1.jpg",
            "imageIndex": 1
        },
        {
            "onlineContentId": "OC002",
            "placeholderId": "PH001",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "placeholderIdentifier": "PRELOGIN",
            "imageResolution": "375x106",
            "imageScale": "1x",
            "targetURL": "https://google.com",
            "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-2.jpg",
            "imageIndex": 2
        },
        {
            "onlineContentId": "OC003",
            "placeholderId": "PH001",
            "placeholderName": "Homepage",
            "placeholderDescription": "Sample place holder description",
            "channelSubType": "MOBILE",
            "placeholderIdentifier": "PRELOGIN",
            "imageResolution": "375x106",
            "imageScale": "1x",
            "targetURL": "https://google.com",
            "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-3.jpg",
            "imageIndex": 3
        }
    ]
}
create Campaign
This API allows to store the campaign details.

POST/v2.0.0/origination/campaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/
Sample Request
{
  "createCampaign": {
    "campaignId": "",
    "campaignName": "CREDIT CARD Campaign",
    "campaignDescription": "campaign for CREDIT CARD",
    "objectiveType": "YES",
    "productId": "POPUP_ADs",
    "productGroupId": "POPUP_ADs",
    "campaignPriority": 0,
    "campaignType": "POPUP",
    "campaignStatus": "ACTIVE",
    "startDate": "2020-06-11",
    "endDate": "2021-05-21",
    "channelType": [
      "ONLINE"
    ],
    "eventTriggerIdList": [
      "ET007"
    ],
    "profileIdList": [
      "PRF1001"
    ],
    "channelDetails": [
      {
        "channelSubType": "MOBILE",
        "channelPriority": 0
      }
    ],
    "onlineContent": [
      {
        "onlineContentId": "",
        "placeholderId": "PH013",
        "targetURL": "https://google.com",
        "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-1x-1.png",
        "callToActionButtonLabel": "GOT IT",
        "callToActionTargetURL": "",
        "showReadLaterButton": "Y",
        "showCloseIcon": "Y",
        "bannerTitle": "Credit Card offer",
        "bannerDescription": "Campaign popup for Credit Card"
        
      }
    ],
    "offlineTemplate": [
      {
        "offlineTemplateId": "",
        "channelSubType": "SMS",
        "subject": "Credit Card offer",
        "messageContent": "LifeTime free credit card offer. Please check with nearest centre"
      }
    ]
  }
}
Sample Response
{
    "campaignId": "CP1001",
    "status": "Success",
    "message": "Campaign created successfully"
}
update Campaign
This API updates the details of a specific campaign.

PUT/v2.0.0/origination/campaigns/{campaignId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/CP1001
Sample Request
{
  "updateCampaign": {
     "campaignId": "CP1001",
    "campaignName": "CREDIT CARD Campaign",
    "campaignDescription": "campaign for CREDIT CARD",
    "objectiveType": "YES",
    "productId": "POPUP_ADs",
    "productGroupId": "POPUP_ADs",
    "campaignPriority": 0,
    "campaignType": "POPUP",
    "campaignStatus": "ACTIVE",
    "startDate": "2020-06-11",
    "endDate": "2021-05-21",
    "channelType": [
      "ONLINE"
    ],
    "eventTriggerIdList": [
      "ET007"
    ],
    "profileIdList": [
      "PRF1001"
    ],
    "channelDetails": [
      {
        "channelSubType": "MOBILE",
        "channelPriority": 0
      }
    ],
    "onlineContent": [
      {
        "onlineContentId": "OC1001",
        "placeholderId": "PH013",
        "targetURL": "https://google.com",
        "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-dashboard-1x-1.png",
        "callToActionButtonLabel": "GOT IT",
        "callToActionTargetURL": "",
        "showReadLaterButton": "Y",
        "showCloseIcon": "Y",
        "bannerTitle": "Credit Card offer",
        "bannerDescription": "Campaign popup for Credit Card"
        
      }
    ],
    "offlineTemplate": [
      {
        "offlineTemplateId": "OT1001",
        "channelSubType": "SMS",
        "subject": "Credit Card offer",
        "messageContent": "LifeTime free credit card offer. Please check with nearest centre"
      }
    ]
  }
}
Sample Response
{
    "campaignId": "CP1001",
    "status": "Success",
    "message": "Campaign updated successfully"
}
create Profile
This API allows to store the profile details.

POST/v2.0.0/origination/campaigns/profiles

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/profiles/
Sample Request
{
  "profile": {
    "profileId": "",
    "profileName": "PEARL PROFILE",
    "profileDescription": "PEARL Profile created for Credit cards",
    "profileConditions": [
      {
        "profileConditionId": "",
        "conditionExpression": "where group_operator = 'OR' and select _operator = 'OR'",
        "dataContextId": "DC1001"
    
      }
    ]
    }
}
Sample Response
{
    "profileId": "PRF1001",
    "status": "Success",
    "message": "Profile created successfully"
}
update Profile
This API updates the details of a specific profile.

PUT/v2.0.0/origination/campaigns/profiles/{profileId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/profiles/PRF1001
Sample Request
{
  "profile": {
    "profileId": "PRF1001",
    "profileName": "PEARL PROFILE",
    "profileDescription": "PEARL Profile created for Credit cards",
    "profileConditions": [
      {
        "profileConditionId": "PC1001",
        "conditionExpression": "where group_operator = 'OR' and select _operator = 'OR'",
        "dataContextId": "DC1001"
    
      }
    ]
    }
}
Sample Response
{
    "profileId": "PRF1001",
    "status": "Success",
    "message": "Profile updated successfully"
}
update ALL PROFILES
This API updates the details of all profiles.

PUT/v2.0.0/origination/engagements/profiles/

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/engagements/profiles/
Sample Request
{
  "profiles": [
    {
      "profileId": "PRF1001",
      "numberOfUsers": 25
    },
    {
      "profileId": "PRF1002",
      "numberOfUsers": 35
    }
  ]
}
Sample Response
{
    "profileId": "PRF1001, PRF1002",
    "status": "Success",
    "message": "Profiles updated successfully"
}
create Event Trigger
This API allows to store the event trigger details.

POST/v2.0.0/origination/campaigns/eventTriggers

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/eventTriggers
Sample Request
{
  "eventTrigger": {
    "eventTriggerId": "",
    "eventName": "Pearl CreditCards",
    "eventDescription": "Event for Pearl CreditCards",
    "eventTriggerType": "External",
    "eventSource": "crm",
    "eventCode": "Pearl"
  }
}
Sample Response
{
    "eventTriggerId": "ET1001",
    "status": "Success",
    "message": "Event trigger created successfully"
}
update Event Trigger
This API updates the details of a specific event trigger.

PUT/v2.0.0/origination/campaigns/eventTriggers/{eventTriggerId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/eventTriggers/ET1001
Sample Request
{
  "eventTrigger": {
    "eventTriggerId": "ET1001",
    "eventName": "Pearl CreditCards",
    "eventDescription": "Event for Pearl CreditCards",
    "eventTriggerType": "External",
    "eventSource": "crm",
    "eventCode": "Pearl"
  }
}
Sample Response
{
    "eventTriggerId": "ET1001",
    "status": "Success",
    "message": "Event trigger updated successfully"
}
create Place holder
This API allows to store the placeholder details.

POST/v2.0.0/origination/campaigns/placeholders

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/placeholders/
Sample Request
{
    "placeHolder": {
        "placeholderId": "",
    	"placeholderName": "Homepage",
        "placeholderDescription": "Homepage Placeholder",
        "channelSubType": "Internet Banking",
        "application": "RETAIL BANKING", 
        "placeholderIdentifier": "Pre-Login",
        "imageResolution": "375x106",
        "imageScale": "1x",
        "imageSize": "51200 kb"
    }
}
Sample Response
{
    "placeholderId": "PH1001",
    "status": "Success",
    "message": "Placeholder created successfully"
}
update Placeholder
This API updates the details of a specific placeholder.

PUT/v2.0.0/origination/campaigns/placeholders/{placeholderId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/placeholders/PH1001
Sample Request
{
    "placeHolder": {
        "placeholderId": "PH1001",
    	"placeholderName": "Homepage",
        "placeholderDescription": "Homepage Placeholder",
        "channelSubType": "Internet Banking",
        "application": "RETAIL BANKING", 
        "placeholderIdentifier": "Pre-Login",
        "imageResolution": "375x106",
        "imageScale": "1x",
        "imageSize": "51200 kb"
    }
}
Sample Response
{
    "placeholderId": "PH1001",
    "status": "Success",
    "message": "Placeholder updated successfully"
}
update Default Campaigns
This API updates the details of the default campaigns.

PUT/v2.0.0/origination/engagements/defaultCampaigns

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/engagements/defaultCampaigns
Sample Request
{
  "defaultCampaign": [
    {
      "onlineContentId": "OC001",
      "placeholderId": "PH001",
      "targetURL": "https://google.com",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-1.jpg",
      "imageIndex": 1
    }
  ]
}
Sample Response
{
    "onlineContentId": " OC001",
    "status": "Success",
    "message": "Default campaigns updated successfully"
}
create Data context
This API creates a new context.

POST/v2.0.0//origination/campaigns/dataContexts

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/campaignmanagement/datacontexts/
Sample Request
{
  "dataContext": {
    "dataContextId": "",
    "dataContextName": "PEARL DATACONTEXT",
    "dataContextDescription": "DataContext created for PEARL Profiles",
    "dataContextSource": "DataContext.class",
    "dataContextServiceName": "pearlDataContext",
   "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomers"
  }
}					}
Sample Response
{
    "dataContextId": "DC1001",
    "status": "Success",
    "message": "Data context created successfully"
}
update Data context
This API updates the existing details of data context.

PUT/v2.0.0//origination/campaigns/dataContexts/{dataContextId}

Sample URL
http://localhost:8080/ms-campaign-api/api/v2.0.0/origination/campaigns/datacontexts/DC1001
Sample Request
{
  "dataContext": {
    "dataContextId": "DC1001",
    "dataContextName": "PEARL DATACONTEXT",
    "dataContextDescription": "DataContext created for PEARL Profiles",
    "dataContextSource": "DataContext.class",
    "dataContextServiceName": "pearlDataContext",
    "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomers"
  }
}					}
Sample Response
{
    "dataContextId": "DC1001",
    "status": "Success",
    "message": "Data context updated successfully"
}

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?