Enterprise APIs
Marketing Catalog support the following versions of APIs:
Version 1.0.0
| TABLE NAME | OPERATION ID | URI | API DESCRIPTION |
|---|---|---|---|
| Product Information | getProductForMCV1 | /product/marketingCatalogue/products/{productRef} | Retrieves an already existing product information for the provided productRef and results can be further filtered based on currency |
| updateProductForMCV1 | /product/marketingCatalogue/products/{productRef} | Updates an already existing product for the provided productRef | |
| deleteProductForMCV1 | /product/marketingCatalogue/products | Deletes all the Product records for a particular productRef | |
| createProductForMCV1 | /product/marketingCatalogue/products | Creates a new product for the provided product data | |
| getAllProductsForMCV1 | /product/products/marketingCatalogue | Retrieves all the products available in the product catalogue or based on the product group and purpose | |
| updatePurposeInProductForMCV1 | /product/marketingCatalogue/purposes/products | Updates purpose for the products, product Id is mandatory for this API to update the purpose | |
| updateDescriptionInProductForMCV1 | /product/marketingCatalogue/products/{productRef}/descriptions | Updates description for an already existing product or a product feature | |
| Product Features | getProductFeaturesForMCV1 | /product/marketingCatalogue/products/{productRef}/features | Retrieves a product features detail based on product Id |
| createProductFeaturesForMCV1 | /product/marketingCatalogue/products/{productRef}/features | Creates the product features detail for a product Id | |
| updateProductFeaturesForMCV1 | /product/marketingCatalogue/products/{productRef}/features | Updates an already existing product features for a product | |
| deleteProductFeaturesForMCV1 | /product/marketingCatalogue/products/{productRef}/features | Deletes all the Product features for a particular product | |
| Product Facilities | createProductFacilitiesForMCV1 | /product/marketingCatalogue/facilities/{productId}/productFacilities | Creates the product facilities details for the particular product id |
| updateProductFacilitiesForMCV1 | /product/marketingCatalogue/facilities/{productId}/productFacilities | Updates an already existing product facilities details for the product | |
| getProductFacilitiesForMCV1 | /product/marketingCatalogue/facilities/{productId}/productFacilities | Retrieves all the product facilities record | |
| deleteProductFacilitiesForMCV1 | /product/marketingCatalogue/facilities/{productId}/productFacilities | Deletes the product facilities record | |
| Features | createFeaturesForMCV1 | /product/marketingCatalogue/productFacilities/features | Creates the feature record for the product facility |
| updateFeaturesForMCV1 | /product/marketingCatalogue/productFacilities/features | Updates an already existing feature record for the product facility | |
| getFeaturesForMCV1 | /product/marketingCatalogue/productFacilities/features | Retrieves all the feature records | |
| deleteFeaturesForMCV1 | /product/marketingCatalogue/productFacilities/features | Deletes the feature records | |
| Periodic Interest | getPeriodicInterestsForMCV1 |
/product/marketingCatalogue/{indexKey}/currencies/{currencyId}/periodicInterests |
Retrieves an already existing periodic interest details |
| createPeriodicInterestsForMCV1 |
/product/marketingCatalogue/products/interests/periodicInterests |
Creates the periodic interest record along with appropriate rates for given periods based on the indexkey and currency of a particular product | |
| updatePeriodicInterestsForMCV1 |
/product/marketingCatalogue/products/interests/periodicInterests |
Updates an already existing periodic interest details for the provided periodic Interest Id | |
| deletePeriodicInterestsForMCV1 |
/product/marketingCatalogue/products/interests/periodicInterests |
Deletes all the periodic interest records for a particular periodic Interest Id | |
| Facilities | createFacilitiesForMCV1 | /reference/marketingCatalogue/facility/facilities | Creates a facility record with the required details |
| updateFacilitiesForMCV1 | /reference/marketingCatalogue/facility/facilities | Updates an already existing facility record | |
| getFacilitiesForMCV1 | /reference/marketingCatalogue/facility/facilities | Retrieves all the facility records | |
| deleteFacilitiesForMCV1 | /reference/marketingCatalogue/facility/facilities | Deletes a facility record with the facility id | |
| Reference | createReferenceForMCV1 | /reference/references/marketingCatalogue | Creates a reference data for the provided reference type |
| updateReferenceForMCV1 | /reference/references/marketingCatalogue | Updates an already existing Reference data for the provided reference type | |
| getReferenceForMCV1 | /reference/references/marketingCatalogue | Retrieves all the Reference Data or for the provided reference type | |
| addReferenceForMCV1 | /reference/marketingCatalogue/referenceTypes/{referenceType} | Add reference data for the existing type provided. | |
| deleteReferenceForMCV1 | /reference/marketingCatalogue/referenceTypes/{referenceType} | Deletes all the Reference Data for a particular reference type or for the provided reference Id | |
| Product Line | createProductLinesForMCV1 | /reference/marketingCatalogue/productLines | Create product Lines in the marketing catalog |
| updateProductLinesForMCV1 | /reference/marketingCatalogue/productLines | Update product Lines in the marketing catalog | |
| getProductLinesForMCV1 | /reference/marketingCatalogue/productLines | Retrieves all the product Lines in the marketing catalog | |
| Product Group | createProductGroupsForMCV1 | /reference/marketingCatalogue/productGroups | Creates a new Product Group record for the already existing product line |
| updateProductGroupsForMCV1 |
/reference/marketingCatalogue/productGroups |
Updates the already existing Product Group record | |
| getProductGroupsForMCV1 | /reference/marketingCatalogue/productGroups | Retrieves the already existing Product Group record for the provided product line or all the product groups if product line is not provided | |
| deleteProductGroupsForMCV1 | /reference/marketingCatalogue/productGroups | Deletes all the Product Group records for a particular productGroupId | |
| updateDescriptionInProductgroupForMCV1 |
/product/marketingCatalogue/productGroups/{productGroupRef}/descriptions |
Updates description for an already existing product group |
To view the complete APIs specification, refer to Service Spec (Swagger) and the Swagger JSON file.
Version 2.0.0
|
TABLE NAME |
OPERATION ID |
URI |
API DESCRIPTION |
|---|---|---|---|
|
Product Information |
getProductForMCV2 |
/product/marketingCatalogue/products/{productRef} |
This API is used to retrieve an existing product information for the provided productReference and can be retrieved based on currency. |
|
updateProductForMCV2 |
/product/marketingCatalogue/products/{productRef} |
This API is used to update an already existing product for the provided productRef. |
|
|
createProductForMCV2 |
/product/marketingCatalogue/products |
This API is used to create a new product for the provided product data. |
|
|
getAllProductsForMCV2 |
/product/products/marketingCatalogue |
This API retrieves the products that are available in the product catalogue or based on the product group and purpose. |
|
|
Product Conditions |
updateProductConditionsForMCV2 |
/product/marketingCatalogue/products/{productRef}/productConditions |
|
|
Periodic Interest |
getPeriodicInterestsForMCV2 |
/product/marketingCatalogue/{indexKey}/currencies/{currencyId}/periodicInterests |
|
|
createPeriodicInterestsForMCV2 |
/product/marketingCatalogue/products/interests/periodicInterests |
This API is used to create periodic interest for a product. |
|
|
updatePeriodicInterestsForMCV2 |
/product/marketingCatalogue/products/interests/periodicInterests |
This API is used to update an existing periodic interest for a product. |
|
|
Image Details |
createImageDetailsForMCV2 |
/product/marketingCatalogue/products/{productRef}/imageDetails |
|
|
updateImageDetailsForMCV2 |
/product/marketingCatalogue/products/{productRef}/imageDetails |
This API is used to update an existing image details for a product. |
|
|
getImageDetailsForMCV2 |
/product/marketingCatalogue/products/{productRef}/imageDetails |
This API is used to retrieve image details for a particular product. |
|
|
deleteImageDetailsForMCV2 |
/product/marketingCatalogue/products/{productRef}/imageDetails |
This API is used to delete all the image details for a particular product or delete based on the image type provided. |
deleteImageDetailsForMCV2 |
|
Basic Interest |
getBasicInterestsForMCV2 |
/product/marketingCatalogue/{indexKey}/currencies/{currencyId}/basicInterests |
|
|
createBasicInterestsForMCV2 |
/product/marketingCatalogue/products/interests/basicInterests |
This API is used to create basic interest along with appropriate rates for given indexkey and currency. |
|
|
updateBasicInterestsForMCV2 |
/product/marketingCatalogue/products/interests/basicInterests |
This API is used to update an already existing basic interest details for the provided basic Interest ID. |
|
|
deleteBasicInterestsForMCV2 |
/product/marketingCatalogue/products/interests/basicInterests |
This API is used to delete the basic interests for a particular basicIntId. |
deleteBasicInterestsForMCV2 |
|
Loan Simulation |
getLoanSimulationDetailsForMCV2 |
/product/marketingCatalogue/products/{productRef}/loanSimulations |
|
|
TABLE NAME |
OPERATION ID |
URI |
|
|
Product Information |
getProductForMCV2 |
/product/marketingCatalogue/products/{productRef} |
|
|
updateProductForMCV2 |
/product/marketingCatalogue/products/{productRef} |
This API is used to update an already existing product for the provided productRef. |
|
|
createProductForMCV2 |
/product/marketingCatalogue/products |
This API is used to create a new product for the provided product data. |
createProductForMCV2 |
|
getAllProductsForMCV2 |
/product/products/marketingCatalogue |
This API retrieves the products that are available in the product catalogue or based on the product group and purpose. |
|
|
Product Conditions |
updateProductConditionsForMCV2 |
/product/marketingCatalogue/products/{productRef}/productConditions |
|
|
Periodic Interest |
getPeriodicInterestsForMCV2 |
/product/marketingCatalogue/{indexKey}/currencies/{currencyId}/periodicInterests |
|
|
createPeriodicInterestsForMCV2 |
/product/marketingCatalogue/products/interests/periodicInterests |
This API is used to create periodic interest for a product. |
createPeriodicInterestsForMCV2 |
|
updatePeriodicInterestsForMCV2 |
/product/marketingCatalogue/products/interests/periodicInterests |
This API is used to update an existing periodic interest for a product. |
|
|
Image Details |
createImageDetailsForMCV2 |
/product/marketingCatalogue/products/{productRef}/imageDetails |
|
|
updateImageDetailsForMCV2 |
/product/marketingCatalogue/products/{productRef}/imageDetails |
This API is used to update an existing image details for a product. |
|
|
getImageDetailsForMCV2 |
/product/marketingCatalogue/products/{productRef}/imageDetails |
This API is used to retrieve image details for a particular product. |
To view the complete APIs specification, refer to Service Spec (Swagger) and the Swagger JSON file.
Version 3.0.0
| TABLE NAME | OPERATION ID | URI | API DESCRIPTION |
|---|---|---|---|
| Product Information | getProductForMCV3 | /product/marketingCatalogue/products/{productRef} | Retrieves an already existing product information for the provided productRef and results can be further filtered based on currency |
| updateProductForMCV3 | /product/marketingCatalogue/products/{productRef} | Updates an already existing product for the provided productRef | |
| createProductForMCV3 | /product/marketingCatalogue/products | Creates a new product for the provided product data | |
| getAllProductsForMCV3 | /product/products/marketingCatalogue | Retrieves all the products available in the product catalogue or based on the product group and purpose |
To view the complete APIs specification, refer to Service Spec (Swagger) and the Swagger JSON file.
Latest Version
| TABLE NAME | OPERATION ID | VERSION | URI | API DESCRIPTION |
|---|---|---|---|---|
| Product Information | getProductForMCV3 | V3.0.0 | /product/marketingCatalogue/products/{productRef} | Retrieves an already existing product information for the provided productRef and results can be further filtered based on currency |
| updateProductForMCV3 | V3.0.0 | /product/marketingCatalogue/products/{productRef} | Updates an already existing product for the provided productRef | |
| createProductForMCV3 | V3.0.0 | /product/marketingCatalogue/products | Creates a new product for the provided product data | |
| getAllProductsForMCV3 | V3.0.0 | /product/products/marketingCatalogue | Retrieves all the products available in the product catalogue or based on the product group and purpose | |
| deleteProductForMCV1 | V1.0.0 | /product/marketingCatalogue/products | Deletes all the Product records for a particular productRef | |
| Purpose | updatePurposeInProductForMCV1 | V1.0.0 | /product/marketingCatalogue/purposes/products | Updates purpose for the products, product Id is mandatory for this API to update the purpose |
| Description | updateDescriptionInProductForMCV1 | V1.0.0 | /product/marketingCatalogue/products/{productRef}/descriptions | Updates description for an already existing product or a product feature |
| updateDescriptionInProductgroupForMCV1 | V1.0.0 | /product/marketingCatalogue/productGroups/{productGroupRef}/descriptions | Updates description for an already existing product group | |
| Product Features | getProductFeaturesForMCV1 | V1.0.0 | /product/marketingCatalogue/products/{productRef}/features | Retrieves a product features detail based on product Ref and branchRef |
| createProductFeaturesForMCV1 | V1.0.0 | /product/marketingCatalogue/products/{productRef}/features | Creates the product features detail for a product Id | |
| updateProductFeaturesForMCV1 | V1.0.0 | /product/marketingCatalogue/products/{productRef}/features | Updates an already existing product features for a product | |
| deleteProductFeaturesForMCV1 | V1.0.0 | /product/marketingCatalogue/products/{productRef}/features | Deletes all the Product features for a particular product | |
| Product Facilities | createProductFacilitiesForMCV1 | V1.0.0 | /product/marketingCatalogue/facilities/{productId}/productFacilities | Creates the product facilities details for the particular product id |
| updateProductFacilitiesForMCV1 | V1.0.0 | /product/marketingCatalogue/facilities/{productId}/productFacilities | Updates an already existing product facilities details for the product | |
| getProductFacilitiesForMCV1 | V1.0.0 | /product/marketingCatalogue/facilities/{productId}/productFacilities | Retrieves all the product facilities record | |
| deleteProductFacilitiesForMCV1 | V1.0.0 | /product/marketingCatalogue/facilities/{productId}/productFacilities | Deletes the product facilities record | |
| Features | createFeaturesForMCV1 | V1.0.0 | /product/marketingCatalogue/productFacilities/features | Creates the feature record for the product |
| updateFeaturesForMCV1 | V1.0.0 | /product/marketingCatalogue/productFacilities/features | Updates an already existing feature record for the product | |
| getFeaturesForMCV1 | V1.0.0 | /product/marketingCatalogue/productFacilities/features | Retrieves all the feature records | |
| deleteFeaturesForMCV1 | V1.0.0 | /product/marketingCatalogue/productFacilities/features | Deletes the feature records | |
| Facilities | createFacilitiesForMCV1 | V1.0.0 | /reference/marketingCatalogue/facility/facilities | Creates a facility record with the required details |
| updateFacilitiesForMCV1 | V1.0.0 | /reference/marketingCatalogue/facility/facilities | Updates an already existing facility record | |
| getFacilitiesForMCV1 | V1.0.0 | /reference/marketingCatalogue/facility/facilities | Retrieves all the facility records | |
| deleteFacilitiesForMCV1 | V1.0.0 | /reference/marketingCatalogue/facility/facilities | Deletes a facility record with the facility id | |
| Periodic Interest | getPeriodicInterestsForMCV2 | V2.0.0 | /product/marketingCatalogue/{indexKey}/currencies/{currencyId}/periodicInterests | Retrieves an already existing periodic interest details |
| createPeriodicInterestsForMCV2 | V2.0.0 | /product/marketingCatalogue/products/interests/periodicInterests | Creates the periodic interest record along with appropriate rates for given periods based on the indexkey and currency of a particular product | |
| updatePeriodicInterestsForMCV2 | V2.0.0 | /product/marketingCatalogue/products/interests/periodicInterests | Updates an already existing periodic interest details for the provided periodic Interest Id | |
| deletePeriodicInterestsForMCV1 | V1.0.0 | /product/marketingCatalogue/products/interests/periodicInterests | Deletes all the periodic interest records for a particular periodic Interest Id | |
| Product Conditions | updateProductConditionsForMCV2 | V2.0.0 | /product/marketingCatalogue/products/{productRef}/productConditions | Updates an already existing product with the product conditions. This API, allows to create new conditions or an existing condition can be updated. |
| Image Details | createImageDetailsForMCV2 | V2.0.0 | /product/marketingCatalogue/products/{productRef}/imageDetails | Creates new Image details for an existing product |
| updateImageDetailsForMCV2 | V2.0.0 | /product/marketingCatalogue/products/{productRef}/imageDetails | Updates an already existing Image details for the provided product | |
| getImageDetailsForMCV2 | V2.0.0 | /product/marketingCatalogue/products/{productRef}/imageDetails | Retrieves all the Image details for an existing product | |
| deleteImageDetailsForMCV2 | V2.0.0 | /product/marketingCatalogue/products/{productRef}/imageDetails | Deletes the existing Image details for a product | |
| Basic Interest | getBasicInterestsForMCV2 | V2.0.0 | /product/marketingCatalogue/{indexKey}/currencies/{currencyId}/basicInterests | Retrieves an already existing basic interest details for the provided index key and currency |
| createBasicInterestsForMCV2 | V2.0.0 | /product/marketingCatalogue/products/interests/basicInterests | Creates the basic interest record along with appropriate rates for the given index key and currency | |
| updateBasicInterestsForMCV2 | V2.0.0 | /product/marketingCatalogue/products/interests/basicInterests | Updates an already existing basic interest details for the provided basic Interest Id | |
| deleteBasicInterestsForMCV2 | V2.0.0 | /product/marketingCatalogue/products/interests/basicInterests | Deletes the existing basic record for the provided basic interest id | |
| Loan Simulation | getLoanSimulationDetailsForMCV2 | V2.0.0 | /product/marketingCatalogue/products/{productRef}/loanSimulations | Obtains the data required for the simulation of a loan contract. The Loan products configured can be only be simulated through this API |
| Reference | createReferenceForMCV1 | V1.0.0 | /reference/references/marketingCatalogue | Creates a reference data for the provided reference type |
| updateReferenceForMCV1 | V1.0.0 | /reference/references/marketingCatalogue | Updates an already existing Reference data for the provided reference type | |
| getReferenceForMCV1 | V1.0.0 | /reference/references/marketingCatalogue | Retrieves all the Reference Data or for the provided reference type | |
| addReferenceForMCV1 | V1.0.0 | /reference/marketingCatalogue/referenceTypes/{referenceType} | Add reference data for the existing type provided | |
| deleteReferenceForMCV1 | V1.0.0 | /reference/marketingCatalogue/referenceTypes/{referenceType} | Deletes all the Reference Data for a particular reference type or for the provided reference Id | |
| Product Line | createProductLinesForMCV2 | V2.0.0 | /reference/marketingCatalogue/productLines | Create product Lines in the marketing catalog |
| updateProductLinesForMCV2 | V2.0.0 | /reference/marketingCatalogue/productLines | Update product Lines in the marketing catalog | |
| getProductLinesForMCV2 | V2.0.0 | /reference/marketingCatalogue/productLines | Retrieves all the product Lines in the marketing catalog | |
| Product Group | createProductGroupsForMCV2 | V2.0.0 | /reference/marketingCatalogue/productGroups | Creates a new Product Group record for the already existing product line |
| updateProductGroupsForMCV2 | V2.0.0 | /reference/marketingCatalogue/productGroups | Updates the already existing Product Group record | |
| getProductGroupsForMCV2 | V2.0.0 | /reference/marketingCatalogue/productGroups | Retrieves the already existing Product Group record for the provided product line/branch Ref or all the product groups if product line is not provided | |
| deleteProductGroupsForMCV2 | V2.0.0 | /reference/marketingCatalogue/productGroups | Deletes all the Product Group records for a particular productGroupId |
In this topic