Eligible Market Products, Offers, or Bundles Derivation Request and Response - Attribute/Value Pairs in JSON Format
Note: We recommend you to refer the topics Eligible Market Products, Offers, or Bundles Derivation Request in the JSON Format and Eligible Market Products, Offers, or Bundles Derivation Response in the JSON Format in parallel while understanding the below mentioned attributes.
This will help you to understand how the attributes/values are structured
in the JSON format.
Before calling the C1_GETELIGIBLEPROD business service through an inbound web service, you need to ensure that the eligible active market products, offers, or bundles derivation request contains the following attributes:
| Attribute Name | Attribute Description | Mandatory (Yes or No) |
|---|---|---|
| productCode | Used to specify the product code to derive the details of
the eligible active entities. Note: Entity is referred to market product,
offer or bundle.
|
Yes(Conditional) Note: This field is required if the product
category, entity type, or entity code are not entered.
|
| productCategoryFlg | Used to specify the product category flag to derive the details
of the eligible active entities. Note: Entity is referred to market
product, offer or bundle.
|
No |
| division | Used to specify the division to derive the details of the eligible active entities which are associated with a particular division. | Yes(Conditional) Note: This field is required with product
code, product category, entity type or entity code to extract the
entities of the specific division.
|
| entityType | Used to indicate the entity type to derive the details of the eligible active entities. | Yes(Conditional) Note: This field is required if the entity
code is entered.
Note: This field is required if the product
code, or product category are not entered.
|
| entityCode | Used to specify the entity code to derive the details of the eligible active entities. | Yes(Conditional) Note: This field is required if the product
code or product category are not entered.
|
| processDate | Used to specify the date to derive the details of effective market products, offers, or bundles for that date. | Yes(Conditional) Note: If the date is not entered then it
will display the default date from the system on which the enquiry
is made.
|
| accountId | Used to indicate the account for which you want to derive the details of the eligible active entities. | Yes(Conditional) Note: If this field is not entered then all
active entity will be extract.
Note: This field is required
if you want to derive the details of eligible active entities for
specific person or account.
|
| acctIdtype | Used to indicate the type of account identifier type for which you to derive the details of the eligible active entities. | No |
| acctIdentifierValue | Used to specify the value for the account identifier type for which you to derive the details of the eligible active entity. | Yes(Conditional) Note: This field is required if you want
to derive the details of eligible active entities for specific person
or account.
|
| personId | Used to specify the person account for which you want to derive the details of eligible active market products, offers, or bundles. | Yes(Conditional) Note: This field is required if you want
to derive the details of eligible active entities for specific person
or account.
|
| custIdTypeCd | Used to indicate the customer ID type for which you want to derive the details of eligible active market products, offers, or bundles. | No |
| perIdentifireVal | Used to specify the value of person identifier for which you want to derive the details of eligible active market products, offers, or bundles. | No |
| productLinkedEntity | Used to specify product linked entity(market product code) for which you want to derive the details of eligible active offers or bundles linked with that particular code. | No |
| linkedEntityCode | Used to specify code of the linked entity(market product code) for which you want to derive the details of eligible active offers or bundles linked with that particular code. | Yes(Conditional) Note: This field is required when you want
to derive offer or bundle linked with the particular market product.
|
| linkedEntityType | Used to indicate type of the linked entity(market product code) for which you want to derive the details of eligible active offer or bundle linked with that particular code. | Yes(Conditional) Note: This field is required when you want
to derive offer or bundle linked with the particular market product.
|
| eligibleParameter | Used to specify the eligibility parameter based on which you want to derive the details of eligible active market products, offers, or bundles. | Yes(Conditional) Note: If this field is not entered then system
will take the eligibility details from the person or account.
|
| priceParmCode | Used to specify the eligibility parameter code based on which you want to derive the details of eligible active market products, offers, or bundles. | Yes(Conditional) Note: If this field is not entered then system
will take the eligibility details from the person or account.
|
| priceParmVal | Used to specify the eligibility parameter value based on which you want to derive the details of eligible active market products, offers, or bundles. | Yes(Conditional) Note: If this field is not entered then system
will take the eligibility details from the person or account.
|
The following table lists and describes the attributes which appear in the eligible active market products, offers, or bundles derivation response JSON format:
| Attribute Name | Attribute Description |
|---|---|
| entityList | Displays the list of eligible market products, offers, or bundles. |
| entityCode | Displays the entity code. |
| entityType | Displays the entity type. |
| entityName | Displays the entity name. |
| entityStartDate | Displays the date from when the entity is effective. |
| entityEndDate | Displays the date till when the entity is effective. |
| entityCodeDescr | Displays the description of the entity. |
| termsAndCondition | Displays the terms and condition of the entity. |
| termAndConditionDescr | Displays the description of the terms and conditions of the entity. |
| status | Displays the status of the entity. |
| productList | Displays the list of the eligible products to which the requested entity belongs. |
| productCode | Displays the code of the eligible product to which the requested entity belongs. |
| productDescription | Displays the description of the eligible product to which the requested entity belongs. |
| productTypFlgDesc | Displays the description of the eligible product type flag to which the requested entity belongs. |
| productCategoryFlgDesc | Displays the description of the eligible product category flag to which the requested entity belongs. |
| productLinkedEntity | Displays the list of eligible market products, offers, and bundles. |
| linkedEntityStartDate | Displays the date from when the linked entity is effective. |
| linkedEntityEndDate | Displays the date till when the linked entity is effective. |
| linkedEntityCode | Displays the linked entity code for the requested entity code. |
| linkedEntityType | Displays the linked entity for the requested entity code. Note: It is applicable in case of offer and bundle.
|
| EntityDivision | Displays the division to which the requested entity belongs. |
| divisionCode | Displays the division code to which the requested entity belongs. |
| eligibilityDetails | Indicates the name of group tag. |
| eligibilityStartDate | Displays the date from when the eligibility of the entity is effective. |
| eligibilityEndDate | Displays the date till when the eligibility of the entity is effective. |
| eligibilityDescription | Displays the description of the eligibility to which the requested entity belongs. |
| eligibilityRule | Indicates the name of group tag. |
| sequenceNumber | Indicates the sequence number of eligibility condition. |
| lhsPriceParmCd | Indicates the left side parameter code of the eligibility condition. |
| operator | Indicates the operator to evaluate the condition |
| rhsPriceParmCd | Indicates the right side parameter code of the eligibility condition. |
| rhsPriceParmVal | Indicates the right side parameter value of the eligibility condition. |
| lhsPriceParmCd1 | Indicates the left side parameter code of the eligibility condition. |
| rhsPriceParmTypeFlg | Indicates the value of the right side flag. |
| trueFlag | Indicates the true condition. |
| falseFlag | Indicates the false condition. |
| insufficientFlag | Indicates the insufficient condition. |
| services | Indicates the name of group tag. |
| serviceName | Displays the service configured at the requested entity code. |
| mandatoryFlag | Indicates the mandatory or optional type of the services. |
| pricing | Indicates the name of group tag. |
| priority | Displays the priority in sequence of the price list of the entities. |
| priceListId | Displays the Price List ID. |
| priceListDescription | Displays the description of the price list. |
| priceListStartDate | Displays the date from when the price list of the entity is effective. |
| priceListEndDate | Displays the date till when the price list of the entity is effective. |
| noOfDays | Displays the validity of price list in number of days. |
| priceItemCode | Displays the price item code. |
| priceitemDescr | Displays the description of the price item. |
| priceAsgnId | Displays the price assignment ID. |
| validityFlag | Indicates the validity of the price item. |
| sourceEntityType | Displays the source entity type. |
| sourceEntityCode | Displays the source entity code. |
| priceListInfo | Displays the information of the price list. |
| priceComponent | Indicates the name of group tag. |
| priceCompId | Displays the price component ID. |
| pricecomptier | Indicates the name of group tag. |
| priceCompSequenceNo | Displays the sequence number of the price component. |
| priceItemParmGroupId | Displays the parameter group ID of the price item. |
| toVal | Indicates the tiering to value of the price item. |
| fromVal | Indicates the tiering from value of the price item. |
| timeOfUse | Indicates the tiering time of use. |
| priceItemCode | Displays the price item code. |
| priceCriteria | Displays the price criteria of the price item. |
| priceCompId | Displays the price component ID. |
| tieSeqNum | Indicates the tiering sequence number. |
| version | Displays the version number. |
| priceComponentDescription | Displays the description of the price component. |
| valueAmt | Displays the value amount of the price component. |
| priceComponentDisplay | Displays the price component. |
| rcMapId | Displays the rate component map ID. |
| tieredFlag | Indicates the tire flag. |
| priceCompSequenceNo2 | Displays the sequence of the price component. |
| messageCategory | Indicates the category of the message. |
| messageNumber | Indicates the number of the message. |
| messageText | Displays the message. |
| longDescription | Displays the long description. |
| inquiryTypeFlag | Displays the inquiry type flag. Note: If the inquiry type
flag value is SMRY then service will provide
details of eligible entities without price component and if the inquiry
type flag value is DETL then service will provide
details of eligible entities with price component
|
Related Topics
| For more information on... | See... |
|---|---|
| Sample Eligible Market Product Derivation Request and Response in the JSON Format | Sample Eligible Market Product Derivation Request and Response in the JSON Format |
| Sample Eligible Offer Derivation Request and Response in the JSON Format | Sample Eligible Offer Derivation Request and Response in the JSON Format |
| Sample Eligible Bundle Derivation Request and Response in the JSON Format | Sample Eligible Bundle Derivation Request and Response in the JSON Format |