Reference APIs

This section gives an overview on Marketing Catalog reference data types and describes the associated APIs.

The following types of Reference Data are available in Marketing Catalog microservices:

User-defined Reference - User-defined codes are customer-specific codes that need to be configured and validated in the microservices.
MS Specific Reference - Reference data specific to a particular microservice.

User-defined Reference

In case of user-defined code type, you can make use of custom data for the attributes marked with reference data support (x-referencetype) in the API documentation. To create, update or delete the user defined references, see the APIs section.

MS Specific Reference

Reference data which are specific to marketing catalog microservice is handled by the marketing catalog APIs.

Below is the list of reference data supported in Marketing Catalog Microservice:

V1.0.0

API	Entity	Field	Reference Data	Reference Type
createProductForMCV1 / updateProductForMCV1	ProductInformation	productLine	ProductLine	MS-Specific
	ProductInformation	productGroup	ProductGroup	MS-Specific
	ProductDetails	productDetails.currency	Currency	User-defined
	ProductDetails	productDetails.debitInterests.type	InterestType	User-defined
	ProductDetails	productDetails.creditInterests.type	InterestType	User-defined
	ProductInformation	productFeatures.type	FeatureType	MS-Specific
	ProductInformation	productFeatures.optionDispType	OptionDisplayType	User-defined
	ProductInformation	imageDetails.imageType	ImageType	User-defined
createProductFeaturesForMCV1 / updateProductFeaturesForMCV1	ProductInformation	features.type	FeatureType	MS-Specific
createProductFeaturesForMCV1 / updateProductFeaturesForMCV1	ProductInformation	features.optionDispType	OptionDisplayType	User-defined
createPeriodicInterestsForMCV1 / updatePeriodicInterestsForMCV1	PeriodicInterest	periodicInterests.period	Period	User-defined
	PeriodicInterest	periodicInterests.currency	Currency	User-defined
createProductGroupsForMCV1 / updateProductGroupsForMCV1	ProductGroup	productGroups.productLineRef	ProductLine	MS-Specific
createProductGroupsForMCV1 / updateProductGroupsForMCV1	ProductGroup	productGroups.imageDetails.imageType	ImageType	User-defined

V2.0.0

API	Entity	Field	Reference Data
createProductForMCV2 / updateProductForMCV2	ProductInformation	productLine	ProductLine	MS-Specific
	ProductInformation	productGroup	ProductGroup	MS-Specific
	ProductConditions	currency	Currency	User-defined
	ProductConditions	interestDetails.property	InterestDetailsProperty	User-defined
	ProductConditions	interestDetails.period	PropertyPeriod	User-defined
	ProductConditions	interestDetails.rateTierType	InterestType	User-defined
	ProductConditions	interestDetails.debitInterests.periodicPeriod	FeatureType	MS-Specific
	ProductConditions	interestDetails.debitInterests.marginDetails.type	MarginType	User-defined
	ProductConditions	interestDetails.debitInterests.marginDetails.marginOperand	MarginOperand	User-defined
	ProductConditions	paymentSchedules.property	PaymentSchedulesProperty	User-defined
	ProductConditions	paymentSchedules.period	PropertyPeriod	User-defined
	ProductConditions	paymentSchedules.paymentTypes.property	PaymentTypeProperty	User-defined
	ProductConditions	chargeDetails.property	ChargesProperty	User-defined
	ProductConditions	chargeDetails.period	PropertyPeriod	User-defined
	ProductConditions	chargeDetails.type	ChargeType	User-defined
	ProductConditions	chargeDetails.chargeCurrency	Currency	User-defined
	ProductConditions	termAmounts.property	TermAmountProperty	User-defined
	ProductConditions	termAmounts.period	PropertyPeriod	User-defined
	ProductConditions	reportingDetails.property	ReportingDetailsProperty	User-defined
	ProductConditions	reportingDetails.period	PropertyPeriod	User-defined
	ProductConditions	reportingDetails.aprTypes.excludeProperty	AprTypesProperty	User-defined
createPeriodicInterestsForMCV2/ updatePeriodicInterestsForMCV2	PeriodicInterest	periodicInterests.period	Period	User-defined
	PeriodicInterest	periodicInterests.currency	Currency	User-defined
createBasicInterestsForMCV2 / updateBasicInterestsForMCV2	BasicInterest	basicInterests.currency	Currency	User-defined
createImageDetailsForMCV2/ updateImageDetailsForMCV2	ImageDetails	imageDetails.imageType	ImageType	User-defined

APIs

This section shows the reference APIs.

CREATE REFERENCE DATA

This API is used to create reference data with given details.

POST/reference

Sample URL

http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference

Request

{
  "references": {
    "ContactPointType": [
      {
        "value": "email",
        "description": "Electronic Address"
      },
      {
        "value": "phone",
        "description": "Phone Address"
      },
      {
        "value": "address",
        "description": "Physical Address"
      }
    ],
    "PhysicalAddressType": [
      {
        "value": "home",
        "description": "Home"
      },
      {
        "value": "residencial",
        "description": "Residencial"
      },
      {
        "value": "office",
        "description": "Office"
      }
    ]
  }
}

Response

{
  "status": 200,
  "message": "Operation successful"
}

GET THE LIST OF DYNAMIC REFERENCE DATA

This API is used to retrieve the list of dynamic reference data for given reference data type.

GET/reference

Sample URL

http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference

Response

{
  "references": {
    "LegalIdentifierType": [
      {
        "value": "passport",
        "description": "Passport"
      },
      {
        "value": "driverslicense",
        "description": "Driver's license"
      }
    ]
  },
  "status": 200,
  "message": "Operation successful"
}

UPDATE REFERENCE DATA

This API is used to update reference data's description of the given reference details.

PUT/reference

Sample URL

http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference

Request

{
  "references": {
    "ContactPointType": [
      {
        "value": "email",
        "description": "Electronic Address"
      },
      {
        "value": "phone",
        "description": "Phone Address"
      },
      {
        "value": "address",
        "description": "Physical Address"
      }
    ],
    "PhysicalAddressType": [
      {
        "value": "home",
        "description": "Home"
      },
      {
        "value": "residencial",
        "description": "Residencial"
      },
      {
        "value": "office",
        "description": "Office"
      }
    ]
  }
}

Response

{
  "status": 200,
  "message": "Operation successful"
}

ADD COLLECTION ITEM

This API is used to add an existing collection item with the new values.

POST/reference/{types}

Sample URL

http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/{types}

Request

{
  "value": "GuardianAddress",
  "description": "Guardian's Address"
}

Response

{
  "status": 200,
  "message": "Operation successful"
}

DELETE REFERENCE DATA

This API is used to delete the reference data for a given reference data type and value.

DELETE/reference/{types}

Sample URL

http://localhost:8002/ms-marketingcatalog-api/api/v1.0.0/reference/{types}

Response

{
  "status": 200,
  "message": "Delete successful"
}

Dark Mode

Expand/Collapse

In this topic