|
Siebel CRM Web Services Reference > Primary Web Services for Siebel CRM 8.0 >
EligibilityCompatibility
Use this Web service to validate the document's (Quote) eligibility and compatibility status. EligibilityCompatibility Operations
For a list of operations associated with this Web service, see Table 65.
Table 65. EligibilityCompatibility operations
|
|
CheckQuoteEligibilityCompatibility |
Checks the eligibility and compatibility status for the input Quote object. |
Request Message Description: CheckQuoteEligibilityCompatibility
For a description of this request message, see Table 66.
Table 66. Request Message Description: CheckQuoteEligibilityCompatibility
|
|
QuoteIO |
Required. An instance of the integration object PDS Quote. Some of the fields used in the eligibility and compatibility process are shown in the following table: Eligibility and Compatibility User fields. |
PSPMode |
The default value is External PDS Quote. This parameter will be parsed as Mode used in the Variable Map. |
PickMode |
Can be Pre-Pick or Post-Pick. Pre-Pick triggers only the eligibility check. Post-Pick executes both the eligibility and compatibility checks. |
ProjectedAssetIO |
An instance of the Projected Asset integration object. Used for a compatibility check with the current quote. |
Eligibility and Compatibility Used Fields
For a description of the Eligibility and Compatibility used fields, see Table 67.
Table 67. Eligibility and Compatibility Used Fields
PDS Quote (Quote) Mapping XML Name |
Variable Name (Map to Internal Variable Map) |
How It Is Used in Eligibility and Compatibility |
AccountContractedProductsOnlyFlag |
Account Contracted Products Only flag |
Used in the workflow |
AccountId |
Account Id |
Account (used in the Eligibility Matrix) |
AccountType |
Account Type |
Account Type (used in the Eligibility Matrix) |
ShippingCity |
City |
City (used in the Eligibility Matrix) |
ShippingCountry |
Country |
Country (used in the Eligibility Matrix) |
ShippingPostalCode |
Postal Code |
Postal Code (used in the Eligibility Matrix) |
PriceListId |
Price List Id |
Price List (checks in the workflow if the product is included in the price list) |
ShippingState |
State |
State (used in the Eligibility Matrix) |
PDS Quote Fields
For a descripiton of PDS Quote Fields, see Table 68.
Table 68. PDS Quote Fields
PDS Quote (Quote Line Item) XML Name |
|
|
AccountId |
Account Id |
Account (used in the Eligibility Matrix). |
ClassId |
Class Id |
Product Class (used in the Compatibility Matrix). |
EffectiveFrom |
Effective From |
Checks if the product is effective. |
EffectiveTo |
Effective To |
Checks if the product is effective. |
InclusiveEligibilityFlag |
Inclusive Eligibility Flag |
Defines the type of rules used. If value is set to Y, a comparison with the Inclusive rules is executed. If the value is set to N, a comparison with the Exclusive rules is executed. For more information about definining product and promotion eligibility rules, see Siebel Product Administration Guide. |
Name |
Name |
Name of the line item. |
PrePickCD |
Pre Pick |
Determines if the line item will trigger the eligibility and compatibility checking. The value must be set to Y to enable the eligibility and compatibility check. |
PriceListId |
Price List Id |
Price List (checks if the product is included in the price list). |
ProductId |
Product Id |
Product (used in the Eligibility and Compatibility Matrix). |
ProductLineId |
Product Line Id |
Product Line (used in the Eligibility and Compatibility Matrix). |
Response Message Description: CheckQuoteEligiblityCompatibility
For a description of this response message, see Table 69.
Table 69. Response Message Description: CheckQuoteEligiblityCompatibility
|
|
QuoteIO |
An instance of the integration object PDS Quote. After running the eligibility and compatibility process, the Eligibility Status and Eligibility Reason fields will be updated. |
EligibilityCompatibility Application Interface
This topic describes the application objects called by the this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network. Service Object (Business Service or Workflow)
For a description of the service objects for this Web service, see Table 70.
Table 70. EligibilityCompatibility Service Object
|
|
|
Web Channel Product Eligibility & Compatibility Driver Workflow |
Workflow |
Not applicable |
Data Object (Integration Object)
For a description of data objects for this Web service, see Table 71.
Table 71. EligibilityCompatibility Data Objects
|
|
PDS Quote |
PDS Simplified Quote |
Projected Asset |
Projected Asset |
Example Package for EligibilityCompatibility
To view an example of messages for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. Request
Go to the following directory in the SampleCode.zip file to view the sample code: ...\EligibilityCompatibility\EligibilityCompatibility_request.xml
Response
Go to the following directory in the SampleCode.zip file to view the sample code: ...\EligibilityCompatibility\EligibilityCompatibility_response.xml
Message Schema (WSDL) of EligibilityCompatibility
To view the message schema for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. ...\EligibilityCompatibility\EligibilityCompatibility.wsdl
| 
