Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >
CatalogWebService
NOTE: This version of CatalogWebService is available only for implementations of Siebel CRM from version 8.1 and later. To use CatalogWebService with Siebel CRM version 8.0, see version 8.0 of Siebel CRM Web Services Reference.
Use this Web service to make available promotional offerings related to products, as well as related products and categories. CatalogWebService Operations
For a list of operations associated with this Web service, see Table 63.
Table 63. CatalogWebService operations
|
|
GetRelatedPromotions |
Retrieves a list of related promotions. |
GetRelatedProducts |
Retrieves a list of related products. |
GetCategory |
Retrieves a flat, non-hierarchical list of categories. |
UDSPublishCatalog |
Publish a category and product catalog with support of pagination and visibility. |
Request Message Description: GetRelatedPromotions
For a description of this request message, see Table 64.
Table 64. Request Message: GetRelatedPromotions
|
|
|
PDS Related Promotions Interface |
An instance of the integration object PDS Related Promotions Interface. |
Integration Object |
PricingMode |
Y or N (calculates price or not). Optional. The default value is Y. |
String |
EligibilityMode |
0, 1, 2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1. |
String |
ContextMode |
SiebelContext or ExternalContext. Optional. However, you must provide ContextMode to run pricing and eligibility. |
String |
Context |
An instance of the integration object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided, then it is required. |
Integration Object |
Response Message Description: GetRelatedPromotions
For a description of this response message, see Table 65.
Table 65. Response Message: GetRelatedPromotions
|
|
|
PDS Related Promotions Interface |
PDS Related Promotions Interface. After running Eligibility and Pricing, the List Price, Net Price, Eligibility status and Eligibility Reason fields will be updated. |
Integration Object |
Request Message Description: GetRelatedProducts
For a description of this request message, see Table 66.
Table 66. Request Message: GetRelatedProducts
|
|
|
PDS Related Products Interface |
An instance of the integration object PDS Related Products Interface. |
Integration Object |
PricingMode |
Y or N (calculates price or not). Optional. The default value is Y. |
String |
EligibilityMode |
0, 1, 2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1. |
String |
ContextMode |
SiebelContext or ExternalContext. Optional. However, provide ContextMode to run pricing and eligibility. |
String |
Context |
An instance of the integration object PDS Catalog Context. The instance either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided, then it is required. |
Integration Object |
Response Message Description: GetRelatedProducts
For a description of this response message, see Table 67.
Table 67. Response Message: GetRelatedProducts
|
|
|
PDS Related Products Interface |
An instance of the integration object PDS Related Products Interface. After running Eligibility and Pricing, the List Price, Net Price, Eligibility status and Eligibility Reason fields will be updated. |
Integration Object |
Request Message Description: GetCategory
For a description of this request message, see Table 68.
Table 68. Request Message: GetCategory
|
|
|
PDS Category Interface Integration Object |
An instance of the integration object PDS Category Interface. |
Integration Object |
Response Message Description: GetCategory
For a description of this response message, see Table 69.
Table 69. Response Message: GetCategory
|
|
|
PDS Category Interface Integration Object |
An instance of the integration object PDS Category Interface. |
Integration Object |
Request Message Description: UDSPublishCatalog
For a description of this request message, see Table 70.
Table 70. Request Message: UDSPublishCatalog
|
|
|
SiebelMessageIn |
An instance of the integration object PDS UDS Publish Catalog Interface. This is a required input. |
Integration Object |
PricingMode |
Y or N (calculates price or not). Optional. The default value is Y. |
String |
EligibilityMode |
0, 1, 2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1. |
String |
ContextMode |
SiebelContext or ExternalContext. Optional. However, provide ContextMode to run pricing and eligibility. |
String |
Context |
An instance of the integration object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided, then it is required. |
Integration Object |
LOVLanguageMode |
LIC, or LDC. |
String |
ViewMode |
Visibility algorithm used in addition to a search specification to determine which records will be retrieved. Catalog or Organization. |
String |
NamedSearchSpec |
Name of a predefined query. |
String |
Response Message Description: UDSPublishCatalog
For a description of this response message, see Table 71.
Table 71. Response Message: UDSPublishCatalog
|
|
|
SiebelMessageOut |
An instance of the integration object PDS UDS Publish Catalog Interface. |
Integration Object |
CatalogWebService Application Interface
This topic describes the application objects called by 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 72.
Table 72. CatalogWebService Application Interface
|
|
|
PDS Product Data Service |
BusService |
CSSProdDataSvc |
Data Object (Integration Object)
For a description of data objects for this Web service, see Table 73.
Table 73. CatalogWebService Data Objects
|
|
PDS Related Promotions Interface |
PDS Related Promotions Interface |
PDS Related Products Interface |
PDS Related Products Interface |
PDS Category Interface |
PDS Category Interface |
PDS UDS Publish Catalog Interface |
PDS UDS Publish Catalog Interface |
Interface Description (WSDL) for Siebel CatalogWebService
To view the interface description for this Web service, navigate to the documentation library for Siebel Business 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. ...\CatalogWebService\CatalogWebService.wsdl
|