getProductWithDomainRelationships

Description
This transaction retrieves the details for a product instance, with associated product-party roles and parties.
Web Services
Operation name: getProductWithDomainRelationships

Service name: CrossDomainServices

Example
Retrieve the details of the product record for the Everyday Savings Plan product and its associated product-party roles.
Usage information
Use this transaction to retrieve product details with associated product-party roles and parties, based on specified input criteria.

This is a coarse-grained, aggregated transaction.

Preconditions
Not applicable
Mandatory input
  • ProductId
  • Filter
Inquiry levels
A set of optional inquiry levels can be provided in the request. The inquiry levels control the type and extent of information returned.
partyInqLevel:
  • Level 0 - returns party data only, including names, identifications, and personal data (if a Person party) or organizational data (if an Organization party).
  • Level 1 - returns level 0 data plus all party addresses and contact methods.
  • Level 2 - returns level 1 data plus all party relationship data.
  • Level 3 - returns level 2 data plus all party bank account, party charge card, and income source data.
  • Level 4 - returns level 3 data plus all party value data.
ProductInquiryLevel:
  • Level 0 - returns product data. If the requested product is a variant product, the root product's information is also returned.
  • Level 1 - returns level 0 data plus product spec values information, optionally filtered by SpecId.
  • Level 2 - returns level 1 data plus product identifier information.
  • Level 3 - returns level 2 data plus product relationship data and product category association information. Category information is based on the CategoryInquiryLevel.
  • Level 4 - returns level 3 data plus product term condition information.
CategoryInquiryLevel:
Important: CategoryInquiryLevel is only applicable when the ProductInquiryLevel >= 3.
  • Level 0 - returns category information plus category entity spec uses.
  • Level 1 - returns level 0 data plus category relationship information.
RelatedProductInquiryLevel:
  • Level 0 - returns the details of products that are related to the requested product and, if applicable, product relationships between each related product and the requested product:
    • If the requested product is a bundle (product structure type is Bundle), then each of the bundle components and their product relationships with the bundle are returned.
    • If the requested product is a stand-alone root product (VariantAllowedIndicator is not set to N), then the variant products are returned.
    • If the requested product is both a root product and a bundle, then the product's bundle components and variant products are returned along with the appropriate product relationship details.
    • InfoSphere® MDM recursively retrieves closely related products for each related bundle or variant product that it returns. If the product is a bundle, this transaction returns all of its bundle components. If the related product is a variant, this transaction returns the root product. If the related product is a root product, no variants are returned. Variants are returned only if the main requested product is a root product and the RelatedProductInquiryLevel is 0 or greater.
  • Level 1 - returns level 0 data plus all product spec value data for each related product. If spec IDs are provided in the request, they are only filtered for the main requested product. Spec IDs in the request are not filtered for the returned related products.
  • Level 2 - returns level 1 data plus product identifier data for each related product.
  • Level 3 - returns level 2 data plus product relationship data and product category association data for each related product. Additional category information is returned based on the CategoryInquiryLevel.
  • Level 4 - returns level 3 data plus product term condition data for each related product.
Filter values
This transaction supports filters for product-party role data. The following values are valid:
  • ACTIVE - returns only active product-party role records.
  • INACTIVE - returns only inactive product-party role records.
  • ALL - returns all product-party role records.

Filter values are case sensitive.

Any filter values other than ACTIVE, INACTIVE, or ALL will result in an error.

Transaction behavior
This transaction returns party records and associated roles and products. If the ProductInquiryLevel input is not provided, the transaction uses a default value of 0.

The following table describes the behavior of this transaction depending on which attributes are included in the request.

Table 1. getPartyWithDomainRelationships transaction behavior
Attributes included in the request Transaction behavior
partyId and filter Returns party and product-party role records corresponding to the given product ID.
partyId, productId, and filter Returns party and product-party role records corresponding to the given party ID and product ID.
partyId, productPartyRoleCodeType, and filter Returns party and product-party role records corresponding to the given party ID and role type.
partyId, productId, productPartyRoleCodeType, and filter Returns party and product-party role records corresponding to the given party ID, product ID, and role type.
partyId, adminProductId, adminSysTpCd, and filter Returns party and product-party role records corresponding to the given party ID, admin product ID, and admin system type.
partyId, adminProductId, adminSysTpCd, productPartyRoleCodeType, and filter Returns party and product-party role records corresponding to the given party ID, admin product ID, admin system type, and role type.
Any of the above, plus partyInqLevel This attribute is optional. If partyInqLevel is not provided, then the default value of 0 is used.
Any of the above, plus productInquiryLevel This attribute is optional. If productInquiryLevel is provided, then product details will be retrieved at the specified inquiry level.
Any of the above, plus SpecId, CategoryLevel, and/or RelatedProductInquiryLevel These attributes are optional. When provided with a product ID, they are used for retrieving product details.

Any combination of inputs other than those described in the table will result in an error.

The filter is always a mandatory input. Any request that does not include a filter value will result in an error.

Request message
<TCRMTxType> getProductWithDomainRelationships

<TCRMTxObject> CrossDomainProductRequestBObj

<TCRMObject> CrossDomainProductRequestBObj

Response objects
CrossDomainProductRequestBObj
With a mandatory business object (one of the following):
And optional business object:

Additional business objects may be returned according to inquiry levels provided.

Special note
Not applicable