![Siebel CRM Primary Web Services ■ CMU Account Query
Request Message Description: CMU Account Query Page
For a description of this request message, see Table 87.
Table 87. Request Message Description: CMU Account Query Page
Node Description
AccountId The ID of the account for the billing profile.
BillingProfileId The ID of the billing profile for the account.
CMU Account Query 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 88.
Table 88. CMU Account Query Service Object
Name Boundary Object Type Class (If Business Service)
CMU Account Query Service Business Service CSSEAIUIDataService
Data Object (Integration Object)
For a description of data objects for this Web service, see Table 89.
Table 89. CMU Account Query Data Object
Siebel Repository Name External Name
CMU Query Account Io CMU - Account
Methods
For a description of methods for this Web service, see Table 90.
Table 90. CMU Account Query Methods
Operation Method
CMU Account QueryPage [BS: CMU Account Query Service].QueryPage
Example Package for CMU Account Query
To view an example of messages 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.
Siebel CRM Web Services Reference Version 8.1/8.2 77](https://image.slidesharecdn.com/crmweb8182-141005075557-conversion-gate01/85/Crm-web-8182-77-320.jpg)
![Siebel CRM Primary Web Services ■ CMU Account Update
CMU Account Update 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 93.
Table 93. CMU Account Update Service Object
Name Boundary Object Type Class (If Business Service)
CMU Account Update Business Service CSSEAIDataSyncService
Data Object (Integration Object)
For a description of data objects for this Web service, see Table 94.
Table 94. CMU Account Update Data Object
Siebel Repository Name External Name
CMU Update Account Io Account
Methods
For a description of methods for this Web service, see Table 95.
Table 95. CMU Account Update Methods
Operation Method
CMU Account Update [BS: CMU Account Update].Update
Example Package for CMU Account Update
To view an example of messages 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.
Request
See the following file to view the sample code:
...CMUAccountUpdateCMUAccountUpdate.xml
Response
See the following file to view the sample code:
...CMUAccountUpdateCMUAccountUpdate.xml
Siebel CRM Web Services Reference Version 8.1/8.2 79](https://image.slidesharecdn.com/crmweb8182-141005075557-conversion-gate01/85/Crm-web-8182-79-320.jpg)
![Siebel CRM Primary Web Services ■ ISS Price List Item WS
Data Object (Integration Object)
For a description of data objects for this Web service, see Table 170.
Table 170. ISS Price List Item WS Data Object
Siebel Repository Name External Name
ISS Price List Item Integration Object Admin Price List
Methods
For a description of methods for this Web service, see Table 171.
Table 171. ISS Price List Item WS Methods
Operation Method
Price List Item InsertOrUpdate [BS: ISS Price List Item WS].InsertOrUpdate
Price List Item Insert [BS: ISS Price List Item WS].Insert
Price List Item Update [BS: ISS Price List Item WS].Update
Price List Item Delete [BS: ISS Price List Item WS].Delete
Example Package for ISS Price List Item WS
To view an example of messages 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.
Request
See the following file to view the sample code:
...ISSPriceListItemISS Price List Item WS.xml
Response
See the following file to view the sample code:
...ISSPriceListItemWSISS Price List Item WS.xml
Interface Description (WSDL) for ISS Price List Item WS
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.
...ISSPriceListItemISS Price List Item WS.wsdl
Siebel CRM Web Services Reference Version 8.1/8.2
108](https://image.slidesharecdn.com/crmweb8182-141005075557-conversion-gate01/85/Crm-web-8182-108-320.jpg)
![Siebel CRM Primary Web Services ■ ProcessSalesOrderSiebelJMSProducer
Request Message Description: Process
For a description of this request message, see Table 825.
Table 825. Request Message Description: Process
Node Description
Order The details of the header for the order.
OrderItem The details of the order item.
OrderItemXA The properties of the order item.
ProcessSalesOrderSiebelJMSProducer 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 826.
Table 826. ProcessSalesOrderSiebelJMSProducer Service Object
Name Boundary Object Type Class (If Business Service)
ProcessSalesOrderSiebelJMSProducer Business Service CSSWSOutboundDispatcher
Data Object (Integration Object)
For a description of data objects for this Web service, see Table 827.
Table 827. ProcessSalesOrderSiebelJMSProducer Data Object
Siebel Repository Name External Name
PDS Order - No Hierarchy PDS Simplified Order
Methods
For a description of the methods for this Web service, see Table 828.
Table 828. ProcessSalesOrderSiebelJMSProducer Methods
Operation Method
process [BS: ProcessSalesOrderSiebelJMSProducer].process
Example Package for ProcessSalesOrderSiebelJMSProducer
To view an example of messages 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.
Siebel CRM Web Services Reference Version 8.1/8.2 327](https://image.slidesharecdn.com/crmweb8182-141005075557-conversion-gate01/85/Crm-web-8182-327-320.jpg)
![Siebel CRM Primary Web Services ■ Product Offer
Methods
For a description of the methods for this Web service, see Table 860.
Table 860. Product Import Methods
Operation Method
Product Import Insert [BS: Product Import].Insert
Product Import Update [BS: Product Import]. Update
Product Import Upsert [BS: Product Import]. Upsert
Example Package for Product Import
To view an example of messages 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.
Request
See the following file to view the sample code:
...ProductImportProductImport_request.xml
Response
See the following file to view the sample code:
...ProductImportProductImport_response.xml
Interface Description for Product Import
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.
...ProductImportProduct Import.wsdl
Product Offer
Use this Web service to retrieve and apply product offer information.
Siebel CRM Web Services Reference Version 8.1/8.2 365](https://image.slidesharecdn.com/crmweb8182-141005075557-conversion-gate01/85/Crm-web-8182-365-320.jpg)
![Siebel CRM Primary Web Services ■ SWI Update Order Line Item
Service Object (Business Service or Workflow)
For a description of the service objects for this Web service, see Table 1297.
Table 1297.SWI Update Order Line Item Service Objects
Name Boundary Object Type Class (If Business Service)
CMU Order Line Item Update (For
Business Service CSSEAIDataSyncService
simple products)
SIS OM UpdateOrderItem (For
complex products)
Workflow Not applicable
SIS OM NSB Update Order Line (For
nested service bundles)
Workflow Not applicable
Data Object (Integration Object)
For a description of data objects for this Web service, see Table 1298.
Table 1298.SWI Update Order Line Item Data Object
Siebel Repository Name External Name
Order Entry Line Item Update Order Entry Line Item Update
Methods
For a description of the methods for this Web service, see Table 1299.
Table 1299.SWI Update Order Line Item Methods
Operation Method
UpdateLineItems [BS: CMU Order Line Item Update].Update
Example Package for SWI Update Order Line Item
To view an example of messages 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.
Request
See the following file to view the sample code:
...SWIUpdateOrderLineItemSWIUpdateOrderLineItem.xml
Response
See the following file to view the sample code:
...SWIUpdateOrderLineItemSWIUpdateOrderLineItem.xml
Siebel CRM Web Services Reference Version 8.1/8.2 609](https://image.slidesharecdn.com/crmweb8182-141005075557-conversion-gate01/85/Crm-web-8182-609-320.jpg)
![Siebel CRM Primary Web Services ■ Ulnbox Contact Item
Specifying parameters while invoking Web service
1 Run the WSDL file through a proxy generator.
This creates a C# class that must be modified to construct Input Integration Objects.
For performance reasons, Page size can also be specified here.
Following is the sample client side code showing how page size and other input parameters can
be specified.
Siebel CRM Web Services Reference Version 8.1/8.2
622
AccountQueryPageMSO_Input input = new AccountQueryPageMSO_Input ();
input.ViewMode = "All";
input.PageSize = "10";
input.StartRowNum = "0";
input.ListOfAccount = new Account[1];
input.ListOfAccount[0] = new Account ();
input.ListOfAccount[0].Name = "MngoTestAccount";
input.ListOfAccount[0].Location = "";
proxy.AccountQueryPageMSO (input);
2 Records can be filtered based on logged in resource and context by specifying these values in
Input Integration Objects.
Possible Performance and Scalability Issues
The volume of Inbox data loaded by the Web service for a specific user and context can be extremely
huge depending on implementations. There will be performance issues if is all retrieved together.
This issue can be overcome by specifying the page size during each call.
Possible Deployment Issues
Authentication URL can be changed during deployment to supply changed information such as user,
password and so on. These changes need to be done in the WSDL file.
Error Conditions
All error conditions will be handled by Web services framework.](https://image.slidesharecdn.com/crmweb8182-141005075557-conversion-gate01/85/Crm-web-8182-622-320.jpg)
Crm web 8182
- 1. Siebel CRM Web Services Reference Siebel Innovation Pack 2013 Version 8.1/8.2 September 2013
- 2. Copyright © 2005, 2013 Oracle and/or its affiliates. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are “commercial computer software” pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc. Access to Oracle Support Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.
- 3. Contents Siebel CRM Web Services Reference 1 Chapter 1: What’s New in This Release Chapter 2: Siebel CRM Web Services Overview How Siebel Business Applications Are Deployed as Web Services 15 About Siebel Web Services 15 Core Technologies for Web Services 16 Web Services Deployment Cycle 17 Siebel Web Service Documentation 18 Support for Siebel Web Services 18 Siebel Web Services Architecture 22 Process of Making Available a Siebel Web Service 22 About Siebel Web Service Modeling 24 Exposing a Business Service as a Web Service 24 Exposing a Workflow as a Web Service 26 Using the Web Services Deployment Wizard 27 About Siebel Web Service Authentication and Performance 27 Invoking Web Services from the Siebel Mobile Client 28 Chapter 3: Siebel CRM Primary Web Services Primary Siebel CRM Web Services 34 ABOWebService 44 Account 51 AccountBalanceSiebelCommsReqABCS 54 AdjustmentSiebelCommsReqABCS 58 AssetManagementComplex 61 CalculateShippingChargeSalesOrderSiebelReqABCSImpl 65 CatalogWebService 67 Siebel CRM Web Services Reference Version 8.1/8.2 3
- 4. Contents ■ CheckATPSalesOrderSiebelReqABCS Impl 71 ClinicalSubject 73 CMU Account Query 76 CMU Account Update 78 ConfiguratorUserLangSiebelAdapter 80 Contact 82 CreateLeads Web Service 84 CreditCheckSalesOrderSiebelReqABCSImpl 87 FetchAccountSiebelReqABCSImpl 89 FetchContactSiebelReqABCSImpl 92 FS Asset Warranty Service 95 GetCampaigns Web Service 97 GetMktgWebSurvey 99 InvoiceSiebelCommsReqABCS 101 ISS Price List Item WS 106 ISS Web Commerce Export Attributes 109 ISS Web Commerce Export Class 111 ISS Web Commerce Export Content 114 ISS Web Commerce Export Error 117 ISS Web Commerce Export Price Lists 121 ISS Web Commerce Export Recommended Products 124 ISS Web Commerce Export Volume Discounts 127 LeadProcessingService 129 LeadService 134 List 139 ListMgmtProspect 142 LoyaltyAccrualService 144 LoyaltyBatchEnrollment 148 LoyaltyImportBusinessService 154 LoyaltyMemberService 155 LoyaltyRedemptionService 168 Siebel CRM Web Services Reference Version 8.1/8.2 4
- 5. Contents ■ LoyaltyVoucherService 183 LSSGOP_Account 185 LSSGOP_AccountAddress 187 LSSGOP_Activity 190 LSSGOP_ActivityContact 193 LSSGOP_CatalogCategory 196 LSSGOP_Contact 199 LSSGOP_ContactAccount 201 LSSGOP_ContactAddress 204 LSSGOP_ContactBestTime 207 LSSGOP_ContactLicense 210 LSSGOP_CurrentUser 213 LSSGOP_LanguageLOV 215 LSSGOP_Literature 216 LSSGOP_Literature_ALL 219 LSSGOP_LiteratureCatalog 222 LSSGOP_MessagePlan 225 LSSGOP_MessagePlan_ALL 228 LSSGOP_MessagePlanCatalog 232 LSSGOP_MessageResponse 235 LSSGOP_ MsgPlanItem 238 LSSGOP_MsgPlanItem_ALL 241 LSSGOP_MsgPlanItemRelation 244 LSSGOP_MsgPlanItemRelation_ALL 247 LSSGOP_PersonalList 250 LSSGOP_PositionContactAddress 253 LSSGOP_Product 256 LSSGOP_ProductIndication 257 LSSGOP_ProductsDetailed 258 LSSGOP_PromotionalItemsDropped 262 LSSGOP_RelatedAccount 265 Siebel CRM Web Services Reference Version 8.1/8.2 5
- 6. Contents ■ LSSGOP_RelatedContact 268 LSSGOP_RelatedLiterature 271 LSSGOP_RetailObjective 274 LSSGOP_Revenue 278 LSSGOP_SampleDisclaimer 280 LSSGOP_SampleDropped 283 LSSGOP_SampleInventory 286 LSSGOP_SampleTransaction 290 LSSGOP_Signature 293 LSSGOP_TransactionItem 296 ModificationTracking 299 LSSGOP_ModificationTrackingPurge 301 MatchAccountSiebelReqABCSImpl 302 MatchContactSiebelReqABCSImpl 304 MktgDeduplicationService 306 MktgImportService 311 NetworkOrderEntry 313 OrderDetailWebService 315 PaymentAuthorizationSalesOrderSiebelReqABCSImpl 317 PaymentSiebelCommsReqABCS 319 PDSOrderHeader 324 PriceListsWS 325 ProcessSalesOrderSiebelJMSProducer 326 Product Configurator Web Service 328 Product Configurator Web Service for Orders 343 Product Import 358 Product Offer 365 ProductSearchService 374 PromotionWebService 377 QueryTransportationSalesOrder ItineraryListSiebelReqABCSImpl Web Service 382 QuoteCheckOutWebService 384 Siebel CRM Web Services Reference Version 8.1/8.2 6
- 7. Contents ■ QuoteDetailWebService 386 QuotingWebService 388 Response 390 RetrieveAttachmentService 393 SCOAExportWS 396 searchSolution 398 SelfServiceAccount 401 SelfServiceAccountRootPath 408 SelfServiceAllAccountsList 411 SelfServiceContact 415 SelfServicePaymentHistory 422 SelfServicePostLoginProcess 424 SelfServiceRegistration 429 SelfServiceResponsibility 443 SelfServiceSmtpEmail 445 SelfServiceTemplateEmail 448 SelfServiceTimeZone 450 SelfServiceUser 452 SelfServiceWebSite 456 ServiceRequest 459 SessionAccessWS 464 SFA_Activity_BS 466 SWIAdjustmentStatusUpdate 468 SWIAdminISSAttributeDefnIO 469 SWIAdminISSClassDefinitionIO 471 SWIAssetManagement 473 SWIContactServices 476 SWICreateAdjustment 483 SWICustomerParty 485 SWILocationServices 492 SWILocationSync 494 Siebel CRM Web Services Reference Version 8.1/8.2 7
- 8. Contents ■ SWILSClinicalActivityTemplate 495 SWILSClinicalCreateSiteVisitGeo Location 498 SWILSClinicalGetEmployees 500 SWILSClinicalGetSiteContacts 504 SWILSClinicalGetStateModelService 509 SWILSClinicalGetSubjectVisitDetails 513 SWILSClinicalInsertEmployees 518 SWILSClinicalListOfValues 520 SWILSClinicalProtocolSiteGetSites 525 SWILSClinicalQueryProtocolSite_ SiteVisits 531 SWI LS Clinical Payments Inbound 537 SWILSClinicalTripReportInterface Service 538 SWI LS Medical Product Issue Create Inbox Item Inbound 567 SWI LS Medical Update Product Issue Inbound 569 SWIMergeServices 571 SWIOrderUpsert 573 SWI Price List IO 575 SWIISSPriceListItemIO 580 SWIProductAttributeImport 584 SWIProductClassImport 586 SWIProductImport 588 SWIPromotionIntegration 594 SWIQuoteUpsert 596 SWISpecialRatingList 598 SWISubmitOrder 599 SWISubmitOrder_o2c 600 SWISubmitQuote_o2c 602 SWISyncProduct 603 SWITroubleTicket 605 Siebel CRM Web Services Reference Version 8.1/8.2 8
- 9. Contents ■ SWI Update Order Line Item 607 SyncCustomerSiebelEventAggregator 610 TNT History Oppty Insert 619 Ulnbox Contact Item 620 UnbilledUsageSiebelCommsReqABCS 624 Universal Inbox 628 UpdateCreditAlertSiebelCommsReqABCSImpl 630 UpdateCustomerSiebelJMSProducer 631 WC_PickList_Payment_Profile_BS 634 WebMarketing 637 Index Siebel CRM Web Services Reference Version 8.1/8.2 9
- 10. Contents ■ Siebel CRM Web Services Reference Version 8.1/8.2 10
- 11. 1 What’s New in This Release What’s New in Siebel CRM Web Services Reference, Version 8.1/8.2 Table 1 lists the changes described in this version of the documentation to support this release of the software. The new features described in Table 1 are available in Siebel CRM version 8.1.1.11, Siebel CRM version 8.2.2.4, and later. Table 1. New Product Features in Siebel CRM Web Services Reference, Version 8.1/8.2 Topic Description LoyaltyRedemptionService on page 168 Modified topic. Added a new operation, ProcessRealTimeRedemption, which checks all pending redemption transactions and verifies the loyalty point balance in an account. What’s New in Siebel CRM Web Services Reference, Version 8.1, Rev. I Table 2 lists changes described in this version of the documentation to support release 8.1 of the software. Siebel CRM Web Services Reference Version 8.1/8.2 11 SWI LS Clinical Payments Inbound on page 537 Modified topic. Added a description of the VATAmount node to the UpdateClinicalPayment table. Table 2. New Product Features in Siebel CRM Web Services Reference, Version 8.1, Rev. I Topic Description CreateLeads Web Service on page 84 New topic. It describes how the Web service can create lead records. GetCampaigns Web Service on page 97 New topic. It describes how the Web service retrieves campaigns and associated details from Siebel CRM. ISS Price List Item WS on page 106 New topic. It describes how the Web service is used to add, update, and delete items in a price list in the Siebel application. ISS Web Commerce Export Attributes on page 109 New topic. It describes how the Web service is used to query for attribute definitions and values that were created in Siebel Customer Order Management. ISS Web Commerce Export Class on page 111 New topic. It describes how the Web service is used to query for class definitions that were created in Siebel Customer Order Management.
- 12. What’s New in This Release ■ Table 2. New Product Features in Siebel CRM Web Services Reference, Version 8.1, Rev. I Topic Description ISS Web Commerce Export Content on page 114 Siebel CRM Web Services Reference Version 8.1/8.2 12 New topic. It describes how the Web service is used to query or update content job header or line items that were created in Siebel Customer Order Management. ISS Web Commerce Export Error on page 117 New topic. It describes how the Web service is used to query, update, or insert export content error messages for export job header or line items that were created in Siebel Customer Order Management. ISS Web Commerce Export Price Lists on page 121 New topic. It describes how the Web service is used to query for price lists that were created in Siebel Customer Order Management. ISS Web Commerce Export Recommended Products on page 124 New topic. It describes how the Web service is used to query for recommended products that were created in Siebel Customer Order Management. ISS Web Commerce Export Volume Discounts on page 127 New topic. It describes how the Web service is used to query for volume discounts and volume discount items that were created in Siebel Customer Order Management. LoyaltyAccrualService on page 144 Modified topic. Added a new operation, ProcessSocialActionTxn, which captures customers’ social actions and processes their rewards in Siebel Loyalty. LoyaltyBatchEnrollment on page 148 Modified topic. Added a new operation, EnrolContactAsMember that creates a Siebel Loyalty membership for an existing Siebel contact from social networks. LoyaltyMemberService on page 155 Modified topic. Added a new operation, PromotionEnrolmentForSMS that rewards Siebel Loyalty members with a referral bonus when their social networking friends enroll in promotions. Product Configurator Web Service on page 328 New topic. It describes how the Web service is used to query for information contained within the product model, such as relationships, attributes, linked items, resources, UI groups. Product Configurator Web Service for Orders on page 343 New topic. It describes how the Web service enables queries on information contained within the product model. Product Offer on page 365 New topic. It describes how the Web service is used to retrieve and apply product offer information.
- 13. What’s New in This Release ■ Table 2. New Product Features in Siebel CRM Web Services Reference, Version 8.1, Rev. I Topic Description SCOAExportWS on page 396 New topic. It describes how the Web service is used to export an update commerce job to Siebel Commerce Object Aggregator (SCOA). SWI Price List IO on page 575 New topic. It describes how the Web service is used to query, create, update, and delete price lists. SWIISSPriceListItemIO on page 580 New topic. It describes how the Web service is used to perform basic operations, such as create, update, modify, and delete price list line items SyncCustomerSiebelEventAggregator on page 610 Modified topic. Added information about the aggregatespevent operation that allows you to aggregate statement profiles. What’s New in Siebel CRM Web Services Reference, Version 8.2, Rev. A Table 3 lists changes described in this version of the documentation to support release 8.1 of the software. Table 3. New Product Features in Siebel CRM Web Services Reference, Version 8.2, Rev. A Topic Description LoyaltyAccrualService on page 144 Modified topic. Added a new operation, ProcessSocialActionTxn, which captures customers’ social actions and processes their rewards in Siebel Loyalty. LoyaltyBatchEnrollment on page 148 Modified topic. Added a new operation, EnrolContactAsMember that creates a Siebel Loyalty membership for an existing Siebel contact from social networks. LoyaltyMemberService on page 155 Modified topic. Added a new operation, PromotionEnrolmentForSMS that rewards Siebel Loyalty members with a referral bonus when their social networking friends enroll in promotions. Siebel CRM Web Services Reference Version 8.1/8.2 13
- 14. What’s New in This Release ■ Siebel CRM Web Services Reference Version 8.1/8.2 14
- 15. 2 Siebel CRM Web Services Overview This chapter provides an overview of Web services and guidance for implementing Oracle’s Siebel Web services. It contains the following topics: ■ How Siebel Business Applications Are Deployed as Web Services on page 15 ■ About Siebel Web Services on page 15 ■ Core Technologies for Web Services on page 16 ■ Web Services Deployment Cycle on page 17 ■ Siebel Web Service Documentation on page 18 ■ Support for Siebel Web Services on page 18 ■ Siebel Web Services Architecture on page 22 ■ Process of Making Available a Siebel Web Service on page 22 ■ About Siebel Web Service Modeling on page 24 ■ Using the Web Services Deployment Wizard on page 27 ■ About Siebel Web Service Authentication and Performance on page 27 ■ Invoking Web Services from the Siebel Mobile Client on page 28 How Siebel Business Applications Are Deployed as Web Services Siebel Business Applications are Web service deployed through the following means: ■ Inbound and Outbound Web services Siebel CRM Web Services Reference Version 8.1/8.2 15 ■ Integration Objects ■ The Siebel application ■ Business Services and Workflows About Siebel Web Services A Web service is a discrete piece of business logic, located somewhere on the Internet, which is accessible through Internet protocols. It is distinguished by the following: ■ It is specified using Web Services Description Language (WSDL). ■ It contains data represented in Extensible Markup Language (XML) and defined by XML Schema. ■ It is transported by Simple Object Access Protocol (SOAP), an XML-based transport protocol.
- 16. Siebel CRM Web Services Overview ■ Core Technologies for Web Services Web Service as a Server-Side Service A Web service is considered a server-side service if the following are true: ■ It is the basis for interoperable, heterogeneous applications. ■ Its interface is defined by XML (XML Schema and WSDL). ■ Makes available coarse-grained, loosely-coupled operations on document-structured data. ■ It is independent of underlying implementation. ■ It is accessible through open standard protocols such as HTTP, SMTP, FTP, or JMS. Web services are all of the following: ■ A delivery mechanism for integrating loosely coupled software components. ■ Delivered over standard Internet technologies. ■ Rooted in: Siebel CRM Web Services Reference Version 8.1/8.2 16 ■ Interoperability ■ Standards ■ XML ■ Coarse-grained exposure of functionality Core Technologies for Web Services Oracle’s Siebel Web services use industry standard core technologies. The following topics provide an overview of each main core technology: ■ “About Web Services Description Language (WSDL)” on page 16 ■ “About XML and XML Schema” on page 17 ■ “About Simple Object Access Protocol (SOAP)” on page 17 About Web Services Description Language (WSDL) WSDL is an XML-based format for describing the interface of a Web service. WSDL describes the endpoints, location, protocol binding, operations, parameters, and data types of all aspects of a Web service: ■ The WSDL file that describes a Web service has the following characteristics: ■ It is published by the service provider. ■ It is used by the client to format requests and interpret responses. ■ It can be optionally submitted to a registry or service broker to advertise a service. ■ Additionally, the WSDL file describes the following: ■ The operations provided by a Web service. ■ The input and output message structures for each Web service operation.
- 17. Siebel CRM Web Services Overview ■ Web Services Deployment Cycle ■ The mechanism to contact the Web service. About XML and XML Schema A WSDL file is published in the form of an XML document instance. Document or Literal is required as part of the WS-I interoperability standard that forms the basis of modern Web service usage, where: ■ Document means that the payload for an operation, however complex, must be defined in a Siebel CRM Web Services Reference Version 8.1/8.2 17 single XML element. ■ Literal means that the definition of that element must be described by an XML Schema embedded in the WSDL file. When using Document/Literal formatting, the WSDL file will contain an XML Schema definition that defines all messages and data types that will be used for a particular service. The payload itself will consist entirely of XML data structures. About Simple Object Access Protocol (SOAP) SOAP is a lightweight protocol intended for exchanging structured information in a decentralized, distributed environment. SOAP uses XML to define an extensible messaging framework. SOAP messages consist of the following: ■ An envelope for wrapping messages, including addressing and security information. ■ A set of serialized rules for encoding data types in XML. ■ Conventions for a procedure call and or response. Web Services Deployment Cycle A service provider describes its service in the form of a WSDL file. Typically, the WSDL file is obtained directly by the developer of the service client consumer. At the time of the design of a Web service, the service consumer uses the WSDL to generate a proxy in his own native development environment, allowing him to program interactions with the service provider. At run time the following occurs: ■ The service consumer formats a request in accordance with the WSDL definition. ■ The service provider provides the expected response to the service consumer.
- 18. Siebel CRM Web Services Overview ■ Siebel Web Service Documentation Siebel Web Service Documentation In addition to the documentation provided here, detailed documentation on the use of Siebel objects to create and maintain Web services can be found on the Siebel Bookshelf in Integration Platform Technologies: Siebel Enterprise Application Integration. NOTE: The Siebel Bookshelf is available on Oracle Technology Network (http://www.oracle.com/ technetwork/indexes/documentation/index.html) and Oracle Software Delivery Cloud. It might also be installed locally on your intranet or on a network location. Information can be found on Siebel Web service technology and on Siebel Enterprise Application Integration (EAI) technologies like the Siebel Adapter (ASI) and the UI Data Service (UDS), which are designed for direct data-level access to the Siebel Object Manager. Information is also available there on XML Schema development, WSDL generation, Outbound Web service configuration, file attachments, authentication and security. Support for Siebel Web Services The following elements contribute to the deployment of Siebel Web services. ■ Inbound and Outbound Web Services on page 18 ■ Integration Objects on page 19 ■ Business Services on page 20 Inbound and Outbound Web Services Siebel Business Applications support both inbound and outbound Web services: ■ Inbound Web services allow external clients to access Siebel functionality. For example, a custom Siebel CRM Web Services Reference Version 8.1/8.2 18 UI that wants to view and modify Siebel service requests.
- 19. Siebel CRM Web Services Overview ■ Support for Siebel Web Services ■ Outbound Web services allow Siebel Business Applications to make requests of external applications. For example, if the Siebel Server wanted to provide its clients the option of either searching internally or searching the Internet, then the Siebel Server would invoke an Outbound Web service operation against a third-party search engine, incorporating the results in its own reply to the client. Figure 1 displays Inbound and Outbound Web services. Figure 1. Inbound and Outbound Web Services Integration Objects Integration objects provide the primary means of structuring Web service messages. An integration object can be used to support both inbound and outbound Web services, its use with inbound Web services is more tightly bound to the Siebel Object Manager. An integration object represents a subset of a Siebel Business object. The ways in which the elements of the integration object correspond to the elements of the business component are explained as follows: ■ Integration components represent business components. ■ Integration component fields represent business component fields. ■ Typically defines the structure of data being exchanged between a Siebel application and an Siebel CRM Web Services Reference Version 8.1/8.2 19 external application.
- 20. Siebel CRM Web Services Overview ■ Support for Siebel Web Services ■ Internal Component Field names and WSDL element, and attribute names can be different. In Figure 2. Integration Objects Siebel CRM Web Services Reference Version 8.1/8.2 20 Siebel Tools, In the Integration Component Fields applet, the column XML Tag governs the way the field name will appear in the WSDL. Figure 2 displays the correspondence between Siebel objects and Integration objects. Business Services Business services allow you to deploy a reusable object that contains a predefined set of methods. Additionally, deploying business services allows you to model your Web services within Siebel Tools. Siebel Web services employ two types of business service: ■ CRUD (Create, Read, Update, Delete) data services, of the type: UDS and ASI.
- 21. Siebel CRM Web Services Overview ■ Support for Siebel Web Services ■ Functional Services such as custom business services and workflow. Figure 3 displays business services and their corresponding Web service entities. Figure 3. Business Services Siebel CRM Web Services Reference Version 8.1/8.2 21
- 22. Siebel CRM Web Services Overview ■ Siebel Web Services Architecture Siebel Web Services Architecture Figure 4 displays the basic architecture for Siebel Web services. Figure 4. Siebel Web Services Architecture Process of Making Available a Siebel Web Service There are two major phases to the development of Siebel Web services. The Siebel objects involved meaning workflows, business services, and integration objects must be configured at design time in Siebel Tools. Then, those objects must be assembled into Web services using Siebel Business Applications. This topic describes the steps you must perform to make a Siebel Web service available. Determine Which Siebel Objects to Make Available When exposing a Siebel Web service, you must first use Siebel Tools to determine which Siebel objects, such as business services, workflows or integration objects, you will make available. Business Services and Workflows Consider the following when exposing business services and workflows: Siebel CRM Web Services Reference Version 8.1/8.2 22
- 23. Siebel CRM Web Services Overview ■ Process of Making Available a Siebel Web Service ■ Business service methods and arguments correspond to Web service operations and messages. Most business services with methods registered in Siebel Tools can be designated for participation in a Web service. ■ A workflow is one-to-one equivalent to a single Web service operation, and its process properties are the arguments to that operation. Like most business services, most workflows can be designated for participation in a Web service. Integration Objects Consider the following when exposing integration objects: ■ Integration objects allow mapping of complex business service and workflow data structures to XML Schema as required by Web services. ■ Integration objects act as boundary proxies for business objects and business components. General Guidelines for Business Services, Workflows and Integration Objects Consider the following general guidelines when exposing Siebel objects: ■ In Siebel Tools make changes to business services, workflows and integration objects to model desired Web service interfaces. ■ Compile the SRF and deploy the objects to be made available. Assemble the Services ■ In the Siebel application, the Administration - Web Services screens and views allow you to create and configure all Web services at run time. ■ In the Administration - Web Services screens and views, administrators can select business services and associated methods that they want to make available as Web services. ■ All Siebel objects must be design-time configured and deployed in the application SRF file before they can be used in Web service administration screens and views. ■ For a limited subset of Web services, a Siebel Tools design-time wizard is available to set up most required configuration elements for UDS (UI Data Service) Web service exposure. These elements must also be compiled in the SRF before they can be referenced in the Web service administration screens and views. To assemble your Web services, do the following: To assemble a Web service in the Web Service Administration view 1 In the Siebel Mobile Web client, navigate to the Administration – Web Services screen. 2 Select either Inbound Web Services or Outbound Web Services. 3 Click New to create a new Web service, or select a Web service in the Inbound or Outbound Web Siebel CRM Web Services Reference Version 8.1/8.2 23 Services list.
- 24. Siebel CRM Web Services Overview ■ About Siebel Web Service Modeling 4 In the Service Ports list applet, select a business service or workflow to act as Web service Siebel CRM Web Services Reference Version 8.1/8.2 24 invocation boundary object. To combine the operations of several business services or workflows into a single service, add them to the port for the Web service. 5 In the Operations list, model WSDL by configuring methods belonging to the business service, or services and or the workflow or workflows listed in the service port. 6 Click the Generate WSDL button in the Inbound or Outbound Web Services list. About Siebel Web Service Modeling This topic includes the following information: ■ Exposing a Business Service as a Web Service on page 24 ■ Exposing a Workflow as a Web Service on page 26 Exposing a Business Service as a Web Service The following statements can be applied to business services consumed as Web services: ■ Business service methods are Web service operations. ■ Business service method arguments are Web service methods. You can make business services available through the following means: Classifying Business Service State Requirements in Siebel Tools ■ Most Siebel Web service operations are classified as Stateless. In the Siebel Tools Object List editor, under business service, you can determine state requirements. ■ Stateless means that each Web service operation exists independently of any other. ■ Stateful means that Siebel Object Manager context must be maintained and correlated from one Web service operation invocation to the next. ■ If a Web service operation is classified as Stateful, then the application data needs to be retained by the Siebel Server between method calls to determine whether the service could be made logically stateless. ■ If a business service is either Stateless, or Server Managed, then it must be classified as Server Managed. When a Web service operation is classified as Server Managed, the business service can participate in either a Stateless or a Stateful Web service exchange. When Stateless is chosen, a business service cannot be enlisted at run time for participation in a Stateful exchange. NOTE: At run time, the encoding of the SOAP header determines whether an operation is Stateful, Stateless, or Server Managed. For more information, see Siebel Web UI Dynamic Developer Kit Guide on the Siebel Bookshelf.
- 25. Siebel CRM Web Services Overview ■ About Siebel Web Service Modeling Registering Public Methods in Siebel Tools ■ Specify the complete input and output arguments for each of these methods. ■ If any of the arguments are a property set hierarchy, then do the following: ■ Define the property set structure as an integration object in Siebel Tools. ■ Specify the data type for this argument as Hierarchy and associate with integration objects. ■ To specify whether an argument appears in the input operation and or the output operation, use the Business Service Method Args Type column. Choose Input, Input/Output, or Output to direct the use of the argument in generating the WSDL. ■ Once the preceding configuration steps in Siebel Tools are complete, and the SRF has been compiled and deployed, continue creating a Web service definition for this business service in Siebel Business Applications. ■ In the Administration - Web Services screen, Inbound Web Services view, configure the business service in the Service Ports list, create a service operation or operations in the Operations view and designate the business service method to execute. ■ Create a new Web service or choose an existing Web service in the Inbound Web Services view. Enter the WSDL XML namespace here. ■ Create a record in the Service Ports view, choose the business service in the Business Service/Business Process name column, set the Transport and URL, and select SOAP_DOC_LITERAL in the Binding column. ■ Create a service operation in the Operations view, set the WSDL operation name in the Operation Name column, and designate the Business Service method as the Siebel method to execute in the ‘Method Display Name’ column. Operations are mapped in Operations applet. NOTE: The Siebel Inbound Web Service Dispatcher is set up with a name resolution mechanism that requires entries in the Operation Name field to be unique within a Siebel database instance. Generally, this uniqueness requirement can be simplified by combining the Service Name with the Method Display Name. Deploying a Business Service as a Web Service You deploy business services as Web services in Siebel Tools. To be deployed, a business service must have at least one accessible method that is supported in Siebel inbound Web services. The business service must include a valid integration object name for any hierarchical argument. The following procedure explains how to deploy a business service as a Web service. To deploy a business service as a Web service 1 In the Siebel Tools Object Explorer, select the Business Service object. The Business Services list appears. 2 In the Object List Editor, right-click the business service to deploy, and then choose Deploy as Siebel CRM Web Services Reference Version 8.1/8.2 25 Web Service. 3 Specify the following in the dialog box, and then click Finish:
- 26. Siebel CRM Web Services Overview ■ About Siebel Web Service Modeling Siebel CRM Web Services Reference Version 8.1/8.2 26 ■ Business Service methods to make available. The operation names for the business service methods are system generated. To edit an operation name, click it in the list. ■ URL for Web service. Replace webserver with a valid host name and lang with a valid language code, such as ENU. ■ Generate WSDL checkbox. To generate a Web Services Description Language (WSDL) file, click the checkbox, and then choose a location to save the WSDL file. The business service is deployed. Deployed business services are shown in the Administration - Business Services screen in the Siebel client. Deployed Web services are shown in the Administration - Inbound Web Services view. For more information about deploying business services as Web services, see Integration Platform Technologies: Siebel Enterprise Application Integration on the Siebel bookshelf. Exposing a Workflow as a Web Service The following statements can be applied to workflows consumed as Web services. ■ A workflow corresponds to a single Web service operation. ■ Workflow process properties are Web service messages. A workflow property set has no direct external representation but can be mapped to an Integration object. NOTE: Workflows that are either Persistent or Interactive must be refactored to work as Web services. The following procedure explains how to make workflows available as Web services. To make workflows available as a Web services 1 Identify process properties that are to be made available and correctly mark them as follows: ■ In if used as an input argument. ■ Out if used as an output argument. ■ In/Out if used as both input and output. NOTE: The In, In/Out, and Out arg types are included in the interface definition. 2 If any process property is a property set hierarchy, then complete the following steps: a Define the property set structure as an integration object in Siebel Tools. b Specify data type for this process property as hierarchy and associate with an integration object. NOTE: This is important as you must make available a strongly-typed interface, including arguments. 3 In the Administration – Web Services screen, Inbound Web Services view do the following: 4 Create a new Web service record or choose an existing Web service in the Inbound Web Services list. Enter the WSDL XML namespace here.
- 27. Siebel CRM Web Services Overview ■ Using the Web Services Deployment Wizard 5 Create a record in Service Ports, choose the workflow in the Business Service/Business Process name column, set the Transport and URL properties, and select SOAP_DOC_LITERAL in the Binding column. NOTE: To model a complete Web service with more than one operation, several service ports might be specified under a single Web service. This is normal and expected. 6 Create a service operation in Operations, set the WSDL operation name in the Operation Name column, and designate RunProcess as the Siebel method to execute in the Method Display Name column. NOTE: The observation about operation naming uniqueness noted in this topic applies here as well. Generally, Siebel Business Applications have resolved this uniqueness requirement by combining the service name with an abbreviation of the workflow name. Using the Web Services Deployment Wizard As a convenience, Siebel Tools has wizard-style tools to assist in the configuration of business services, workflows and integration objects into Web services. If you already have a business service configured and ready for use as a Web service, then right-click on the business service and select Deploy as Web Service... from the menu. You can perform this task for workflows by right-clicking on the desired workflow process record. If you have modeled an integration object and want to use it for low-level data operations like Create, Read, Update, Delete (CRUD) and the use of the UDS (UI Data Service) service meets your needs, then you can have a wizard build a business service based on the underlying UDS class (CSSEAIUIDataService) and publish the resulting business service as a Web service. From the Siebel Tools file menu, select File, New Object, EAI, and then Data Access Service. NOTE: This wizard does not create ASI-based Services. About Siebel Web Service Authentication and Performance In implementations where scalability is critical, a lightweight context management facility for authentication is available and its use is recommended. With this facility, authentication is managed using a combination of user credentials and a sessionID token: ■ When user credentials are presented in the SOAP header of a Web service request, formal authentication is performed prior to the application execution of the Web service operation. If the authentication succeeds, then the operation proceeds and a special SessionID token are placed in the SOAP header of the Web service reply. Siebel CRM Web Services Reference Version 8.1/8.2 27
- 28. Siebel CRM Web Services Overview ■ Invoking Web Services from the Siebel Mobile Client ■ Whenever the SessionID is included by the client in subsequent Web service requests, that Siebel CRM Web Services Reference Version 8.1/8.2 28 SessionID will be used to restore cached session information, thus bypassing the substantially more expensive process of re-executing the authentication. Note that, when presented with both the SessionID and a valid set of user credentials, an attempt will be made to use the SessionID before resorting to the user credentials and re-authentication. As expected, the session that is being tracked by the SessionID is subject to expiration and other security checks. The facility is a distinct alternative to the basic authentication standard described by WS-Security. Using the UserName token as provided in WS-Security, while fully supported as part of Siebel’s WS-I Basic Profile compliance, will not yield the same benefit as using the higher-performance session optimization facility provided by the Siebel implementation. For detailed information on authentication and security see Integration Platform Technologies: Siebel Enterprise Application Integration, and Siebel Security Guide. Invoking Web Services from the Siebel Mobile Client The Siebel Mobile Web Client can serve the same Web services as those deployed on the Siebel Server, while protecting access through simple authentication. Invoking Web services from the Siebvel Mobile Client allows developers to integrate external applications with Siebel Business Applications and to test their integrations, without having to install an entire Siebel Enterprise. NOTE: This functionality is provided as ACR 492. For release 8.1 of Siebel Business Applications, implementing this functionality requires installing a patch release and performing postinstallation configuration tasks. For an ACR that is included in a Siebel Fix Pack 8.1.1.x release, see the relevant instructions in the applicable Siebel Maintenance Release Guide on My Oracle Support. For more information on invoking Web services from the Siebel Mobile Web Client, see Integration Platform Technologies: Siebel Enterprise Application Integration.
- 29. 3 Siebel CRM Primary Web Services This chapter includes detailed descriptions and information about Siebel Web services. NOTE: This guide describes Web services supported by Siebel CRM, version 8.1 and later. For information on Siebel Web Services earlier than version 8.1, see Siebel CRM Web Services Reference, version 8.0 on Oracle Technology Network. Web services described in this chapter include the following: ■ Primary Siebel CRM Web Services on page 34 ■ ABOWebService on page 44 Siebel CRM Web Services Reference Version 8.1/8.2 29 ■ Account on page 51 ■ AccountBalanceSiebelCommsReqABCS on page 54 ■ AdjustmentSiebelCommsReqABCS on page 58 ■ AssetManagementComplex on page 61 ■ CalculateShippingChargeSalesOrderSiebelReqABCSImpl on page 65 ■ CatalogWebService on page 67 ■ CheckATPSalesOrderSiebelReqABCS Impl on page 71 ■ ClinicalSubject on page 73 ■ CMU Account Query on page 76 ■ CMU Account Update on page 78 ■ ConfiguratorUserLangSiebelAdapter on page 80 ■ Contact on page 82 ■ CreditCheckSalesOrderSiebelReqABCSImpl on page 87 ■ FetchAccountSiebelReqABCSImpl on page 89 ■ FetchContactSiebelReqABCSImpl on page 92 ■ FS Asset Warranty Service on page 95 ■ GetMktgWebSurvey on page 99 ■ InvoiceSiebelCommsReqABCS on page 101 ■ ISS Price List Item WS on page 106 ■ LeadProcessingService on page 129 ■ List on page 139 ■ ListMgmtProspect on page 142 ■ LoyaltyAccrualService on page 144
- 30. Siebel CRM Primary Web Services ■ ■ LoyaltyBatchEnrollment on page 148 ■ LoyaltyImportBusinessService on page 154 ■ LoyaltyMemberService on page 155 ■ LoyaltyRedemptionService on page 168 ■ LoyaltyVoucherService on page 183 ■ LSSGOP_Account on page 185 ■ LSSGOP_AccountAddress on page 187 ■ LSSGOP_Activity on page 190 ■ LSSGOP_ActivityContact on page 193 ■ LSSGOP_CatalogCategory on page 196 ■ LSSGOP_Contact on page 199 ■ LSSGOP_ContactAccount on page 201 ■ LSSGOP_ContactAddress on page 204 ■ LSSGOP_ContactBestTime on page 207 ■ LSSGOP_ContactLicense on page 210 ■ LSSGOP_CurrentUser on page 213 ■ LSSGOP_LanguageLOV on page 215 ■ LSSGOP_Literature on page 216 ■ LSSGOP_Literature_ALL on page 219 ■ LSSGOP_LiteratureCatalog on page 222 ■ LSSGOP_MessagePlan on page 225 ■ LSSGOP_MessagePlan_ALL on page 228 ■ LSSGOP_MessagePlanCatalog on page 232 ■ LSSGOP_MessageResponse on page 235 ■ LSSGOP_ MsgPlanItem on page 238 ■ LSSGOP_MsgPlanItem_ALL on page 241 ■ LSSGOP_MsgPlanItemRelation on page 244 ■ LSSGOP_MsgPlanItemRelation_ALL on page 247 ■ LSSGOP_PersonalList on page 250 ■ LSSGOP_PositionContactAddress on page 253 ■ LSSGOP_Product on page 256 ■ LSSGOP_ProductIndication on page 257 ■ LSSGOP_ProductsDetailed on page 258 Siebel CRM Web Services Reference Version 8.1/8.2 30
- 31. Siebel CRM Primary Web Services ■ ■ LSSGOP_PromotionalItemsDropped on page 262 ■ LSSGOP_RelatedAccount on page 265 ■ LSSGOP_RelatedContact on page 268 ■ LSSGOP_RelatedLiterature on page 271 ■ LSSGOP_RetailObjective on page 274 ■ LSSGOP_Revenue on page 278 ■ LSSGOP_SampleDisclaimer on page 280 ■ LSSGOP_SampleDropped on page 283 ■ LSSGOP_SampleInventory on page 286 ■ LSSGOP_SampleTransaction on page 290 ■ LSSGOP_Signature on page 293 ■ LSSGOP_TransactionItem on page 296 ■ ModificationTracking on page 299 ■ LSSGOP_ModificationTrackingPurge on page 301 ■ MatchAccountSiebelReqABCSImpl on page 302 ■ MatchContactSiebelReqABCSImpl on page 304 ■ MktgDeduplicationService on page 306 ■ MktgImportService on page 311 ■ NetworkOrderEntry on page 313 ■ OrderDetailWebService on page 315 ■ PaymentAuthorizationSalesOrderSiebelReqABCSImpl on page 317 ■ PaymentSiebelCommsReqABCS on page 319 ■ PDSOrderHeader on page 324 Siebel CRM Web Services Reference Version 8.1/8.2 31 ■ PriceListsWS on page 325 ■ SFA_Activity_BS on page 466 ■ ProcessSalesOrderSiebelJMSProducer on page 326 ■ Product Import on page 358 ■ PromotionWebService on page 377 ■ QueryTransportationSalesOrder ItineraryListSiebelReqABCSImpl Web Service on page 382 ■ QuoteCheckOutWebService on page 384 ■ QuoteDetailWebService on page 386 ■ QuotingWebService on page 388 ■ Response on page 390
- 32. Siebel CRM Primary Web Services ■ ■ RetrieveAttachmentService on page 393 ■ SCOAExportWS on page 396 ■ searchSolution on page 398 ■ SelfServiceAccount on page 401 ■ SelfServiceAccountRootPath on page 408 ■ SelfServiceAllAccountsList on page 411 ■ SelfServiceContact on page 415 ■ SelfServicePaymentHistory on page 422 ■ SelfServicePostLoginProcess on page 424 ■ SelfServiceRegistration on page 429 ■ SelfServiceResponsibility on page 443 ■ SelfServiceSmtpEmail on page 445 ■ SelfServiceTemplateEmail on page 448 ■ SelfServiceTimeZone on page 450 ■ SelfServiceUser on page 452 ■ SelfServiceWebSite on page 456 ■ ServiceRequest on page 459 ■ SessionAccessWS on page 464 ■ SFA_Activity_BS on page 466 ■ SWIAdjustmentStatusUpdate on page 468 ■ SWIAdminISSAttributeDefnIO on page 469 ■ SWIAdminISSClassDefinitionIO on page 471 ■ SWIAssetManagement on page 473 ■ SWIContactServices on page 476 ■ SWICreateAdjustment on page 483 ■ SWICustomerParty on page 485 ■ SWILocationServices on page 492 ■ SWILocationSync on page 494 ■ SWILSClinicalActivityTemplate on page 495 ■ SWILSClinicalCreateSiteVisitGeo Location on page 498 ■ SWILSClinicalGetEmployees on page 500 ■ SWILSClinicalGetSiteContacts on page 504 ■ SWILSClinicalGetStateModelService on page 509 Siebel CRM Web Services Reference Version 8.1/8.2 32
- 33. Siebel CRM Primary Web Services ■ ■ SWILSClinicalGetSubjectVisitDetails on page 513 ■ SWILSClinicalInsertEmployees on page 518 ■ SWILSClinicalListOfValues on page 520 ■ SWILSClinicalProtocolSiteGetSites on page 525 ■ SWILSClinicalQueryProtocolSite_ SiteVisits on page 531 ■ SWI LS Clinical Payments Inbound on page 537 ■ SWILSClinicalTripReportInterface Service on page 538 ■ SWI LS Medical Product Issue Create Inbox Item Inbound on page 567 ■ SWI LS Medical Update Product Issue Inbound on page 569 ■ SWIMergeServices on page 571 ■ SWIOrderUpsert on page 573 ■ SWIProductAttributeImport on page 584 ■ SWIProductClassImport on page 586 ■ SWIProductImport on page 588 ■ SWIPromotionIntegration on page 594 ■ SWIQuoteUpsert on page 596 ■ SWISpecialRatingList on page 598 ■ SWISubmitOrder on page 599 ■ SWISubmitOrder_o2c on page 600 ■ SWISubmitQuote_o2c on page 602 ■ SWISyncProduct on page 603 ■ SWITroubleTicket on page 605 ■ SWI Update Order Line Item on page 607 ■ SyncCustomerSiebelEventAggregator on page 610 ■ TNT History Oppty Insert on page 619 ■ Ulnbox Contact Item on page 620 ■ UnbilledUsageSiebelCommsReqABCS on page 624 ■ Universal Inbox on page 628 ■ UpdateCreditAlertSiebelCommsReqABCSImpl on page 630 ■ UpdateCustomerSiebelJMSProducer on page 631 ■ WC_PickList_Payment_Profile_BS on page 634 ■ WebMarketing on page 637 Siebel CRM Web Services Reference Version 8.1/8.2 33
- 34. Siebel CRM Primary Web Services ■ Primary Siebel CRM Web Services Primary Siebel CRM Web Services The following tables list the primary Web services available with Siebel CRM, version 8.2. The Web services and the namespaces for each are divided into tables by functional area. ■ Siebel Custom UI Primary Web Services on page 34 ■ Siebel Self-Service Primary Web Services on page 35 ■ Siebel Marketing Primary Web Services on page 36 ■ Siebel Loyalty Primary Web Services on page 36 ■ Siebel Service Primary Web Services on page 37 ■ Siebel Order Management Primary Web Services on page 37 ■ Siebel Financial Services Primary Web Services on page 39 ■ Siebel Communications Primary Web Services on page 39 ■ Siebel CRM and UCM Integration Web Services on page 41 ■ Siebel Hospitality Primary Web Service on page 42 ■ Siebel Life Sciences Web Services on page 42 Siebel Custom UI Primary Web Services Table 4 lists the primary Siebel Custom UI Web services. Table 4. Primary Siebel Custom UI Web Services Web Service Name Namespace Type ProductSearchService http://siebel.com/CustomUI Inbound RetrieveAttachmentService http://siebel.com/CustomUI Inbound searchSolution http://siebel.com/CustomUI Inbound MktgDeduplicationService http://siebel.com/CustomUI Inbound WC_PickList_Payment_Profile_BS http://siebel.com/CustomUI Inbound Universal Inbox http://siebel.com/CustomUI Inbound SiebelWebPasswdMgmtService http://siebel.com/CustomUI Inbound SiebelWebRegistrationService http://siebel.com/CustomUI Inbound SiebelWebRespMgmt http://siebel.com/CustomUI Inbound PDSOrderHeader http://siebel.com/CustomUI Inbound Ulnbox Contact Item http://siebel.com/CustomUI Inbound Siebel CRM Web Services Reference Version 8.1/8.2 34
- 35. Siebel CRM Primary Web Services ■ Primary Siebel CRM Web Services Siebel Self-Service Primary Web Services Table 5 lists the primary Self-Service Web services. Table 5. Primary Siebel Self-Service Web Services Web Service Name Namespace Type SelfServiceAccount http://siebel.com/SelfService/ Common/Account Inbound SelfServiceAccountRootPath http://siebel.com/SelfService/ Common/Account Inbound SelfServiceAllAccountsList http://siebel.com/SelfService/ Common/Account Inbound SelfServiceContact http://siebel.com/SelfService/ Common/Contact Inbound SelfServicePaymentHistory http://siebel.com/SelfService/ eCommerce/Payment Inbound SelfServicePostLoginProcess http://siebel.com/SelfService/ Common/Login Inbound SelfServiceRegistration http://siebel.com/SelfService/ Common/Registration Inbound SelfServiceResponsibility http://siebel.com/SelfService/ Common/Responsibility Inbound SelfServiceSmtpEmail http://siebel.com/SelfService/ Common/Utility Inbound SelfServiceTemplateEmail http://siebel.com/SelfService/ Common/Utility Inbound SelfServiceTimeZone http://siebel.com/SelfService/ Common/Utility Inbound SelfServiceUser http://siebel.com/SelfService/ Common/User Inbound SelfServiceWebSite http://siebel.com/SelfService/ Common/Setup Inbound Siebel CRM Web Services Reference Version 8.1/8.2 35
- 36. Siebel CRM Primary Web Services ■ Primary Siebel CRM Web Services Siebel Marketing Primary Web Services Table 6 lists the primary Siebel Marketing Web services. Table 6. Primary Siebel Marketing Web Services Web Service Name Namespace Type Account http://siebel.com/marketing/account Inbound Contact http://siebel.com/marketing/contact Inbound CreateLeads http://siebel.com/SocialMediaService Inbound GetCampaigns http://siebel.com/SocialMediaService Inbound LeadService http://siebel.com/marketing/leads Inbound LeadProcessingService http://siebel.com/marketing/leads Inbound List http://siebel.com/marketing/list Inbound ListMgmtProspect http://siebel.com/marketing/prospect Inbound MktgImportService http://siebel.com/marketing/ Siebel Loyalty Primary Web Services Table 7 lists the primary Siebel Loyalty Web services. Siebel CRM Web Services Reference Version 8.1/8.2 36 webmarketing Inbound GetMktgWebSurvey http://siebel.com/marketing/ webmarketing Inbound Response http://siebel.com/marketing/response Inbound WebMarketing http://siebel.com/marketing/ webmarketing Inbound Table 7. Primary Siebel Loyalty Web Services Web Service Name Namespace Type LoyaltyAccruralService http://siebel.com/Loyalty/ LoyaltyAccruralService Inbound LoyaltyBatchEnrollment http://siebel.com/Loyalty/ LoyaltyEnrolmentServices Inbound LoyaltyImportBusinessService http://siebel.com/Loyalty/ LoyaltyImportService Inbound LoyaltyMemberService http://siebel.com/Loyalty/ LoyaltyMemberServices Inbound LoyaltyRedemptionService http://siebel.com/Loyalty/ LoyaltyRedemptionService Inbound LoyaltyVoucherService http://siebel.com/Loyalty/ LoyaltyVoucherService Inbound
- 37. Siebel CRM Primary Web Services ■ Primary Siebel CRM Web Services Siebel Service Primary Web Services Table 8 lists the primary Siebel Service Web services. Table 8. Primary Siebel Service Web Services Web Service Name Namespace Type ServiceRequest http://siebel.com/Service/ ServiceReqs Siebel Order Management Primary Web Services Table 9 lists the primary Siebel Order Management Web services. Inbound Table 9. Primary Siebel Order Management Web Services Web Service Name Namespace Type OrderDetailWebService http://siebel.com/ OrderManagement/Order/Details Inbound CatalogWebService http://siebel.com/ OrderManagement/Catalog Inbound CalculatePriceWS http://siebel.com/ OrderManagement/Quote/PSP Inbound PriceListsWS http://siebel.com/ OrderManagement/PriceLists Inbound QueryTransportationSalesOrderItiner aryListSiebelReqABCSImpl http://xmlns.oracle.com/ABCSImpl/ Siebel/ CoreQueryTransportationSalesOrderI tineraryListSiebelReqABCSImpl/V1 Outbound QuoteCheckOutWebService http://siebel.com/ OrderManagement/Quote/Quoting Inbound QuoteDetailWebService http://siebel.com/ OrderManagement/Quote/Details Inbound QuotingWebService http://siebel.com/ OrderManagement/Quote/Quoting Inbound ABOWebService http://siebel.com/ OrderManagement/ABO Inbound Siebel Product Configurator Web Service http://siebel.com/ OrderManagement/Configurator Inbound PromotionWebService http://siebel.com/ OrderManagement/Promotion Inbound SessionAccessWS http://www.siebel.com/xml/ SessionAccess Inbound SWIAdminISSAttributeDefnIO http://siebel.com/asi Inbound Siebel CRM Web Services Reference Version 8.1/8.2 37
- 38. Siebel CRM Primary Web Services ■ Primary Siebel CRM Web Services Table 9. Primary Siebel Order Management Web Services Web Service Name Namespace Type SWIAdminISSClassDefintionIO http://siebel.com/asi Inbound SWILocationServices http://siebel.com/asi/V0 Inbound SWILocationSync http://siebel.com/asi Inbound SWIISSPriceListItemIO http://siebel.com/asi Inbound SWIOrderUpsert http://siebel.com/asi Inbound SWI Price List IO http://siebel.com/asi Inbound SWIProductImport http://siebel.com/asi/VO Inbound SWISubmitOrder http://siebel.com/asi Outbound SWISyncProduct http://siebel.com/asi Inbound CalculateShippingChargeSalesOrderS iebelReqABCSImpl Siebel CRM Web Services Reference Version 8.1/8.2 38 http://xmlns.oracle.com/ABCSImpl/ Siebel/Core/ CalculateShippingChargeSalesOrder SiebelReqABCSImpl/V1 Outbound CheckATPSalesOrderSiebelReqABCSI mpl http://xmlns.oracle.com/ABCSImpl/ Siebel/Core/ CalculateShippingChargeSalesOrder SiebelReqABCSImpl/V1 Outbound ConfiguratorUserLangSiebelAdapter http://xmlns.oracle.com/ ConfiguratorUserLangSiebelAdapter Outbound CreditCheckSalesOrderSiebelReqABC SImpl http://xmlns.oracle.com/ABCSImpl/ Siebel/Core/ CreditCheckSalesOrderSiebelReqABC SImpl/V1 Outbound PaymentAuthorizationSalesOrderSieb elReqABCSImpl http://xmlns.oracle.com/ABCSImpl/ Siebel/Core/ PaymentAuthorizationSalesOrderSie belReqABCSImpl/V1 Outbound SWIProductAttributeImport http://siebel.com/asi/ Inbound SWIProductClassImport http://siebel.com/asi/ Inbound SWIPromotionIntegration http://siebel.com/asi/ Inbound SWIQuoteUpsert http://siebel.com/asi/ Inbound SWISubmitOrder_o2c http://siebel.com/asi/ Outbound SWISubmitOrder_o2c http://siebel.com/asi/ Outbound ISS Web Commerce Export Attributes http://siebel.com/asi/ Inbound ISS Web Commerce Export Class http://siebel.com/asi/ Inbound
- 39. Siebel CRM Primary Web Services ■ Primary Siebel CRM Web Services Table 9. Primary Siebel Order Management Web Services Web Service Name Namespace Type ISS Web Commerce Export Contents http://siebel.com/asi/ Inbound ISS Web Commerce Export Error http://siebel.com/asi/ Inbound ISS Web Commerce Export Price Lists http://siebel.com/asi/ Inbound ISS Web Commerce Export http://siebel.com/asi/ Inbound Recommended Products ISS Web Commerce Export Volume Discounts http://siebel.com/asi/ Inbound SCOAExportWS http://service.scoa.oracle.com/ Outbound Siebel Financial Services Primary Web Services Table 10 lists the primary Siebel Financial Services Web services. Table 10. Siebel Financial Services Primary Web Services Web Service Name Namespace Type AssetManagementComplex http://www.siebel.com/Service/FS/Assets Inbound FS Asset Warranty Service http://siebel.com/Service/AssetWarranty Inbound Siebel Communications Primary Web Services Table 11 lists the primary Siebel Communications Web services. Table 11. Siebel Communications Primary Web Services Web Service Name Namespace Type AccountBalanceSiebelCommsReqABCS http://xmlns.oracle.com/ABCS/ Siebel/Industry/Communications/ AccountBalanaceSiebelCommsReqAB CS/V1 Inbound AdjustmentSiebelCommsReqABCS http://xmlns.oracle.com/ABCS/ Siebel/Industry/Communications/ AdjustmentSiebelCommsReqABCS/ V1 Inbound CMU Account Query http:siebel.com/asi/ Inbound CMU Account Update http:siebel.com/asi/ Inbound ISS Price List Item WS http:siebel.com/asi/ Inbound SWI Update Order Line Item http:siebel.com/asi/ Inbound Siebel CRM Web Services Reference Version 8.1/8.2 39
- 40. Siebel CRM Primary Web Services ■ Primary Siebel CRM Web Services Table 11. Siebel Communications Primary Web Services Web Service Name Namespace Type AccountBalanceSiebel ReqABCS_Service http://xmlns.oracle.com/ABCS/ Siebel CRM Web Services Reference Version 8.1/8.2 40 Siebel/Industry/Communications/ AccountBalanaceSiebelCommsReqAB CS/V1 Outbound AdjustmentSiebel ReqABCS_Service http://xmlns.oracle.com/ABCS/ Siebel/Industry/Telco/ AdjustmentSiebelReqABCS/V1 Outbound InvoiceSiebelCommsReqABCS http://xmlns.oracle.com/ABCS/ Siebel/Industry/Communications/ InvoiceSiebelCommsReqABCS/V1 Outbound PaymentSiebelCommsReqABCS_Service http://xmlns.oracle.com/ABCSImpl/ Siebel/Industry/Communications/ PaymentSiebelCommsReqABCS/V1 Outbound UnbilledUsageSiebelCommsReqABCS_Service http://xmlns.oracle.com/ABCS/ Siebel/Industry/Communications/ UnbilledUsageSiebelCommsReqABCS /V1 Outbound InvoiceSiebelCommsReqABCS http://xmlns.oracle.com/ABCS/ Siebel/Industry/Communications/ InvoiceSiebelCommsReqABCS/V1 Outbound PaymentSiebelCommsReqABCS http://xmlns.oracle.com/ABCSImpl/ Siebel/Industry/Communications/ PaymentSiebelCommsReqABCS/V1 Outbound ProcessSalesOrderSiebelCommsJMSProducer http://xmlns.oracle.com/ABCS/ Industry/Comms/SalesOrder/ ProcessSalesOrderSiebelCommsJMS Producer/V1 Outbound SWIAdjustmentStatusUpdate http://siebel.com/asi/ Inbound SWIContactServices http://siebel.com/asi/V0 Inbound SWICreateAdjustment http://siebel.com/asi Outbound SWICustomerParty http://siebel.com/asi/V0 Inbound SyncCustomerSiebelEventAggregator http://xmlns.oracle.com/ABCS/ Siebel/Core/ SyncCustomerSiebelEventAggregato r/V1 Outbound SWISpecialRatingList http://siebel.com/asi Outbound SWITroubleTicket http://siebel.com/asi Inbound SWI Update Order Line Item http:siebel.com/asi/ Inbound
- 41. Siebel CRM Primary Web Services ■ Primary Siebel CRM Web Services Table 11. Siebel Communications Primary Web Services Web Service Name Namespace Type UnbilledUsageSiebelCommsReqABCS http://xmlns.oracle.com/ABCS/ Siebel/Industry/Communications/ UnbilledUsageSiebelCommsReqABCS /V1 Outbound UpdateCustomerSiebelJMSProducer http://xmlns.oracle.com/ABCS/ Siebel/Industry/Telco/ UpdateCustomerSiebelJMSProducer/ V1 Outbound UpdateCreditAlertSiebelCommsReqABCSImpl http://xmlns.oracle.com/ABCSImpl/ Siebel/Industry/Comms/ UpdateCreditAlertSiebelCommsReqA BCSImpl/V1 Outbound Siebel CRM and UCM Integration Web Services Table 12 lists the primary Web services for integration between Siebel CRM and Siebel Universal Customer Master (UCM). Table 12. Siebel CRM and Siebel UCM Integration Primary Web Services Web Service Name Namespace Type FetchAccountSiebelReqABCSImpl http://xmlns.oracle.com/ABCSImpl/Siebel/ Core/FetchAccountSiebelReqABCSImpl/V1 Outbound FetchContactSiebelReqABCSImpl http://xmlns.oracle.com/ABCSImpl/Siebel/ Core/FetchContactSiebelReqABCSImpl/V1 Outbound MatchAccountSiebelReqABCSImpl http://xmlns.oracle.com/ABCSImpl/Siebel/ Core/MatchAccountSiebelReqABCSImpl/V1 Outbound MatchContactSiebelReqABCSImpl http://xmlns.oracle.com/ABCSImpl/Siebel/ Core/MatchContactSiebelReqABCSImpl/V1 Outbound SWIContactServices http://siebel.com/asi/V0 Inbound SWICustomerParty http://siebel.com/asi/V0 Inbound SWIMergeServices http://siebel.com/asi Inbound SWIProductImport http://siebel.com/asi/V0 Inbound SyncCustomerSiebelEventAggregator http://xmlns.oracle.com/ABCS/Siebel/ Core/ SyncCustomerSiebelEventAggregator/V1 Outbound Siebel CRM Web Services Reference Version 8.1/8.2 41
- 42. Siebel CRM Primary Web Services ■ Primary Siebel CRM Web Services Siebel Hospitality Primary Web Service Table 13 lists the primary Siebel Hospitality Web services. Table 13. Primary Siebel Hospitality Web Services Web Service Name Namespace Type TNT History Oppty Insert http://www.siebel.com/asi Inbound Siebel Life Sciences Web Services Table 14 lists the primary Siebel Life Sciences Web services. Table 14. Primary Siebel Life Sciences Web Services Web Service Name Namespace Type ClinicalSubject http://siebel.com/ClinicalSubject/asi Inbound LSSGOP_Account http://siebel.com/asi/ Inbound LSSGOP_AccountAddress http://siebel.com/asi/ Inbound LSSGOP_Activity http://siebel.com/asi/ Inbound LSSGOP_ActivityContact http://siebel.com/asi/ Inbound LSSGOP_CatalogCategory http://siebel.com/asi/ Inbound LSSGOP_Contact http://siebel.com/asi/ Inbound LSSGOP_ContactAccount http://siebel.com/asi/ Inbound LSSGOP_ContactAddress http://siebel.com/asi/ Inbound LSSGOP_ContactBestTime http://siebel.com/asi/ Inbound LSSGOP_ContactLicense http://siebel.com/asi/ Inbound LSSGOP_CurrentUser http://siebel.com/asi/ Inbound LSSGOP_LanguageLOV http://siebel.com/asi/ Inbound LSSGOP_Literature http://siebel.com/asi/ Inbound LSSGOP_Literature_ALL http://siebel.com/asi/ Inbound LSSGOP_LiteratureCatalog http://siebel.com/asi/ Inbound LSSGOP_MessagePlan http://siebel.com/asi/ Inbound LSSGOP_MessagePlan_ALL http://siebel.com/asi/ Inbound LSSGOP_MessagePlanCatalog http://siebel.com/asi/ Inbound LSSGOP_MessageResponse http://siebel.com/asi/ Inbound LSSGOP_ MsgPlanItem http://siebel.com/asi/ Inbound LSSGOP_MsgPlanItem_ALL http://siebel.com/asi/ Inbound LSSGOP_MsgPlanItemRelation http://siebel.com/asi/ Inbound Siebel CRM Web Services Reference Version 8.1/8.2 42
- 43. Siebel CRM Primary Web Services ■ Primary Siebel CRM Web Services Table 14. Primary Siebel Life Sciences Web Services Web Service Name Namespace Type LSSGOP_MsgPlanItemRelation_ALL http://siebel.com/asi/ Inbound LSSGOP_PersonalList http://siebel.com/asi/ Inbound LSSGOP_PositionContactAddress http://siebel.com/asi/ Inbound LSSGOP_Product http://siebel.com/asi/ Inbound LSSGOP_ProductIndication http://siebel.com/asi/ Inbound LSSGOP_ProductsDetailed http://siebel.com/asi/ Inbound LSSGOP_PromotionalItemsDropped http://siebel.com/asi/ Inbound LSSGOP_RelatedAccount http://siebel.com/asi/ Inbound LSSGOP_RelatedContact http://siebel.com/asi/ Inbound LSSGOP_RelatedLiterature http://siebel.com/asi/ Inbound LSSGOP_RetailObjective http://siebel.com/asi/ Inbound LSSGOP_Revenue http://siebel.com/asi/ Inbound LSSGOP_SampleDisclaimer http://siebel.com/asi/ Inbound LSSGOP_SampleDropped http://siebel.com/asi/ Inbound LSSGOP_SampleInventory http://siebel.com/asi/ Inbound LSSGOP_SampleTransaction http://siebel.com/asi/ Inbound LSSGOP_Signature http://siebel.com/asi/ Inbound LSSGOP_TransactionItem http://siebel.com/asi/ Inbound ModificationTracking http://siebel.com/asi/ Inbound LSSGOP_ModificationTrackingPurge http://siebel.com/asi/ Inbound SWILSClinicalActivityTemplate http://siebel.com/asi/ Inbound SWILSClinicalCreateSiteVisitGeo http://siebel.com/CustomUI Inbound Location SWILSClinicalGetEmployees http://siebel.com/asi/ Inbound SWILSClinicalGetSiteContacts http://siebel.com/asi/ Inbound SWILSClinicalGetStateModelService http://siebel.com/asi/ Inbound SWILSClinicalGetSubjectVisitDetails http://siebel.com/asi/ Inbound SWILSClinicalInsertEmployees http://siebel.com/asi/ Inbound SWILSClinicalListOfValues http://siebel.com/asi/ Inbound SWILSClinicalProtocolSiteGetSites http://siebel.com/CustomUI Inbound Siebel CRM Web Services Reference Version 8.1/8.2 43
- 44. Siebel CRM Primary Web Services ■ ABOWebService Table 14. Primary Siebel Life Sciences Web Services Web Service Name Namespace Type SWILSClinicalQueryProtocolSite_ SiteVisits ABOWebService NOTE: This version of ABOWebService is available only for implementations of Siebel CRM from version 8.1 and later. To use ABOWebService with Siebel CRM version 8.0, see version 8.0 of Siebel CRM Web Services Reference. Use this Web service to make available the following Asset-Based Ordering (ABO) functions: convert a quote into an order, submit an order to the back-end office, convert a completed order line item to an asset, modify an asset, disconnect an asset, suspend, or resume an asset. This Web service works only with an Asset-Based Ordering (ABO) enabled environment. A typical application that uses the Web service is Siebel Communication. ABOWebService Operations The asset operations Modify, Disconnect, Suspend, or Resume create a new line item, based on the account or contact profile. They have a similar input and output data schema. If AccountId is provided, then the Web service operates on the account profile. If AccountId is not provided, then it operates on the contact profile. Affixing ToQuote in the Web service name means: if an active quote is provided, then the Web service adds the quote item to the existing quote. If an active quote is not provided, then the Web service generates a new quote and adds the quote item to the new quote. Affixing ToOrder in the Web service name means: if an active order is provided, then the Web service adds the order item to the existing order. If an active order is not provided, then the Web service generates a new order and adds the order item to the new order. For a list of operations associated with this Web service, see Table 15. Siebel CRM Web Services Reference Version 8.1/8.2 44 http://siebel.com/CustomUI Inbound SWI LS Clinical Payments Inbound http://siebel.com/CustomUI Inbound SWILSClinicalTripReportInterface http://siebel.com/asi/ Inbound Service SWI LS Medical Product Issue Create Inbox Item Inbound http://siebel.com/CustomUI Inbound SWI LS Medical Update Product Issue Inbound http://siebel.com/CustomUI Inbound Table 15. ABOWebService Operations Name Description AutoOrder Converts a Quote to a Sales Order. SubmitOrder Submits an Order.
- 45. Siebel CRM Primary Web Services ■ ABOWebService Table 15. ABOWebService Operations Name Description AutoAsset Creates assets from the completed order line items or updates a current asset. ModifyAssetToQuote Modifies a Service Item asset, and generates a quote item to update the selected asset. ModifyAssetToOrder Modifies a Service Item asset, and generates an order item to update the selected asset. DisconnectAssetToQuote Disconnects a Service Item asset to generate a quote item to deactivate the selected asset. DisconnectAssetToOrder Disconnects a Service Item asset, and generates an order item to deactivate the selected asset. SuspendAssetToQuote Suspends an active a Service Item asset to generate a quote item to suspend the selected asset. SuspendAssetToOrder Suspends a Service Item asset and generates an order item to suspend the selected asset. ResumeAssetToQuote Resumes a suspended a Service Item asset to generate a quote item to resume the selected asset. ResumeAssetToOrder Resumes a Service Item asset, and generates an order item to resume the selected asset. Request Message Description: AutoOrder The following Web service operations AutoOrder, SubmitOrder, ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder, and DisconnectAssetToOrder share a common output message format: PDS Order. ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder, DisconnectAssetToOrder share a common request message format. ModifyAssetToQuote, SuspendAssetToQuote, ResumeAssetToQuote and DisconnectAssetToQuote share a common request message format, and a common response message format, PDS Quote. For a description of this request message, see Table 16. Table 16. Request Message: AutoOrder Node Description Object Id Required. Row ID of the quote to be converted to the Sale Order. Siebel CRM Web Services Reference Version 8.1/8.2 45
- 46. Siebel CRM Primary Web Services ■ ABOWebService Response Message Description: AutoOrder The integration object message format is PDS Order. For a description of this response message, see Table 17. Table 17. Response Message: AutoOrder Node Description PDS Order Instance of the integration object PDS Order. Header Order Header. Line Item Order Line Items. XA Order Line Item attributes. Request Message Description: SubmitOrder For a description of this request message, see Table 18. Table 18. Request Message: SubmitOrder Node Description OrderId Required. RowId of the order to be submitted. Response Message Description: SubmitOrder integration object message format: PDS Order, which has the same format as the AutoOrder response message. Request Message Description: AutoAsset For a description of this request message, see Table 19. Table 19. Request Message; AutoAsset Node Description Object Id Required. RowId of the corresponding Order that contains the Order Line Siebel CRM Web Services Reference Version 8.1/8.2 46 Item to be converted or applied to an asset. LineItemId Required. RowId of an Order Line Item to be converted or applied to an asset.
- 47. Siebel CRM Primary Web Services ■ ABOWebService Response Message Description: AutoAsset This integration object message format is PDS Asset. For a description of this response message, see Table 20. Table 20. Response Message: AutoAsset Node Description PDS Asset Required. Integration object. Header Asset header. Line Item Asset XA Asset attributes Request Message Description: ModifyAssetToQuote For a description of this request message, see Table 21 Table 21. Request Message: ModifyAssetToQuote Node Description AssetIntegrationId Asset integration ID of the selected asset. Provide either AssetIntegrationId or AssetNumber. AssetNumber Asset integration ID of the selected asset. Provide either AssetIntegrationId or AssetNumber. ActiveDocumentId A document in SiebelOrder Management which refers to either a quote or an order. Each Document can have multiple children, that is Quote Items, or Order Line Items. ActiveDocumentId refers to the current active Document that the current process is working on. In this Web service call, it is the Quote ID of the active Quote to which the generated quote item has to be added. This is an optional input. AccountId Account ID of the account that owns the selected Service Item asset. ContactId Contact ID of the contact who owns the selected Service Item asset to be modified. DueDate The due date of the generated line item. PriceListId Specifies a Price List ID that is associated with the quote if a new quote is requested to generate. CompoundProductNumber Compound Product Number for the Asset Based Ordering (ABO) network ordering. It is not required if network ordering is not used. Siebel CRM Web Services Reference Version 8.1/8.2 47
- 48. Siebel CRM Primary Web Services ■ ABOWebService Response Message Description: ModifyAssetToQuote The integration object message format is PDS Quote. For a description of this response message, see Table 22. Table 22. Response Message; ModifyAssetToQuote Node Description PDS Quote Required. Integration object. Header Quote header. Line Item Quote line item. XA Quote line item attributes. Request Message Description: ModifyAssetToOrder For a description of this request message, see Table 23. Table 23. Request Message: ModifyAssetToOrder Node Description AssetIntegrationId Asset integration ID of the selected asset. Provide either AssetIntegrationId Response Message Description: ModifyAssetToOrder Integration object message format: PDS Order, which has the same format as the AutoOrder response message. Siebel CRM Web Services Reference Version 8.1/8.2 48 or AssetNumber. AssetNumber Asset integration ID of the selected asset. Provide either AssetIntegrationId or AssetNumber. ActiveDocumentId A document in Siebel Order Management which refers to either a quote or an order. Each Document can have multiple children, which are Quote Items or Order Line Items. ActiveDocumentId refers to the current active document that the current process is working on. In this Web service call, it is the Quote ID of the active Quote to which the generated quote item has to be added. This is an optional input. AccountId Account ID of the account that owns the selected Service Item asset. ContactId Contact ID of the contact who owns the selected Service Item asset to be modified. DueDate The due date of the generated line item. PriceListId Specifies a Price List ID associated with the quote if a new quote is requested. CompoundProduct Compound Product Number for ABO network ordering. It is required only if Number network ordering is used.
- 49. Siebel CRM Primary Web Services ■ ABOWebService Request Message Description: SuspendAssetToQuote This is the same request message as ModifyAssetToQuote. Response Message Description: SuspendAssetToQuote Integration object message format: PDS Quote. Request Message Description: SuspendAssetToOrder This is the same request message as ModifyAssetToOrder. Response Message Description: SuspendAssetToOrder Integration object message format: PDS Order. Request Message Description: ResumeAssetToQuote This is the same request message as ModifyAssetToQuote. Response Message Description: ResumeAssetToQuote Integration object message format: PDS Quote. Request Message Description: ResumeAssetToOrder This is the same request message as ModifyAssetToOrder. Response Message Description: ResumeAssetToOrder Integration object message format: PDS Order. Request Message Description: DisconnectAssetToQuote This is the same request message as ModifyAssetToQuote. Response Message Description: DisconnectAssetToQuote Integration object message format: PDS Quote. Request Message Description: DisconnectAssetToOrder This is the same request message as ModifyAssetToOrder. Response Message Description: DisconnectAssetToOrder Integration object message format: PDS Order. Siebel CRM Web Services Reference Version 8.1/8.2 49
- 50. Siebel CRM Primary Web Services ■ ABOWebService ABOWebService 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 24. Table 24. ABOWebService Application Interface Name Boundary Object Type Class (if Business Service) SISOMAutoOrderWebService Workflow Not applicable SISOMSubmitWebService Workflow Not applicable SISOMAutoAssetWebService Workflow Not applicable SISOMModifyWebService-Quote Workflow Not applicable SISOMModifyWebService-Order Workflow Not applicable SISOMSuspendWebService-Quote Workflow Not applicable SISOMSuspendWebService-Order Workflow Not applicable SISOMResumeWebService-Quote Workflow Not applicable SISOMResumeWebService-Order Workflow Not applicable SISOMDisconnectWebService-Quote Workflow Not applicable SISOMDisconnectWebService-Order Workflow Not applicable Data Object (Integration Object) For a description of data objects for this Web service, see Table 25. Table 25. ABOWebService Data Objects Siebel Repository Name External Name PDS Quote PDS Quote PDS Order PDS Order PDS Asset PDS Asset Example Package for ABOWebService To view an example of messages 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. Siebel CRM Web Services Reference Version 8.1/8.2 50
- 51. Siebel CRM Primary Web Services ■ Account Request (AutoOrder) See the following file to view the sample code: ...ABOWebServiceAutoOrder_request.xml Response (AutoOrder) See the following file to view the sample code: ...ABOWebServiceAutoOrder_response.xml Request (ModifyAssetToQuote) See the following file to view the sample code: ...ABOWebServiceModifyAssetToQuote_request.xml Response (ModifyAssetToQuote) See the following file to view the sample code: ...ABOWebServiceModifyAssetToQuote_response.xml Request (AutoAsset) See the following file to view the sample code: ...ABOWebServiceAutoAsset_request.xml Response (AutoAsset) See the following file to view the sample code: ...ABOWebServiceAutoAsset_response.xml Interface Description (WSDL) for ABOWebservice 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. ...ABOWebServiceABOWebService.wsdl Account Use this Web service for the basic Siebel Marketing operations such as creating and updating accounts. Siebel CRM Web Services Reference Version 8.1/8.2 51
- 52. Siebel CRM Primary Web Services ■ Account Account Operations There are two operations associated with this Web service which allow you to create and update accounts in Marketing. For a list of operations associated with this Web service, see Table 26. Table 26. Account Operations Name Description AccountCreateAccount Creates an account. AccountUpdateAccount Updates an existing account. Request Message Description: AccountCreateAccount For a description of this request message, see Table 27. Table 27. Request Message Description: AccountCreateAccount Node Description Type Account IO Required. An instance of the integration object Response Message Description: AccountCreateAccount For a description of this response message, see Table 28. Request Message Description: AccountUpdateAccount For a description of this request message, see Table 29. Siebel CRM Web Services Reference Version 8.1/8.2 52 Account. Account is the Parent header and Account_BusinessAddress is the child. Integration Object Table 28. Response Message Description: AccountCreateAccount Node Description Type Account Id The new Account ID generated as a result of the new account creation. String Error Message Error message if any. String Success Flag Flag to indicate success or failure of the operation. String Table 29. Request Message Description: AccountUpdateAccount Node Description Type Account IO Required. An instance of the integration object Account. Account is the Parent header and Account_BusinessAddress is the child. Integration Object
- 53. Siebel CRM Primary Web Services ■ Account Response Message Description: AccountUpdateAccount For a description of this response message, see Table 30. Table 30. Response Message Description: AccountUpdateAccount Node Description Type Error Message Error message if any. String Success Flag Flag to indicate success or failure of the operation. String Account 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 31. Table 31. Account Application Interface Name Boundary Object Type Account Business Service Data Object (Integration Object) For a description of data objects for this Web service, see Table 32. Table 32. Account Data Object Siebel Repository Name External Name Account IO Account IO Example Package for Account To view an example of messages 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. Request (AccountCreate) See the following file to view the sample code: ...AccountAccountCreate_request.xml Response (AccountCreate) See the following file to view the sample code: Siebel CRM Web Services Reference Version 8.1/8.2 53
- 54. Siebel CRM Primary Web Services ■ AccountBalanceSiebelCommsReqABCS ...AccountAccountCreate_response.xml Request (AccountUpdate) See the following file to view the sample code: ...AccountAccountUpdate_request.xml Response (AccountUpdate) See the following file to view the sample code: ...AccountAccountUpdate_response.xml Interface Description (WSDL) for Account 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. ...AccountAccount.wsdl AccountBalanceSiebelCommsReqABCS Use this outbound Web service to query for account balance details in Oracle Communications Bill and Revenue Management and display it in the Billing view in Siebel Communications. AccountBalanceSiebelCommsReqABCS Operations For a list of operations associated with this Web service, see Table 33. Table 33. AccountBalanceSiebelCommsReqABCS operations Name Description QueryBalanceSummary Queries the balance summary for the billing profile in the Billing Siebel CRM Web Services Reference Version 8.1/8.2 54 view in Siebel Communications. QueryBalanceGroupList Queries the balance group list for the billing profile in the Billing view in Siebel Communications. QueryBalanceDetails Queries the balance details for the billing profile in the Billing view in Siebel Communications. QueryBalanceGroupServices Queries the balance group services for the billing profile in the Billing view in Siebel Communications.
- 55. Siebel CRM Primary Web Services ■ AccountBalanceSiebelCommsReqABCS Request Message Description: QueryBalanceSummary For a description of this request message, see Table 34. Table 34. Request Message Description: QueryBalanceSummary Node Description Type CustomHeaderContext Optional Hierarchy QueryBalanceSummaryReqMsg:ListOfCmuRequestBillingProfileIo Optional Integration Response Message Description: QueryBalanceSummary For a description of this response message, see Table 35. Table 35. Response Message Description: QueryBalanceSummary Node Description Type QueryBalanceSummaryRespMsg:ListOfCmuBalanceSummary ResponseIo SiebelFaultMsg:Fault Optional Integration Object Request Message Description: QueryBalanceGroupList For a description of this request message, see Table 36. Table 36. Request Message Description: QueryBalanceGroupList Node Description Type CustomHeaderContext Optional Hierarchy QueryBalanceGroupListReqMsg:ListOfCmuRequestBillingProfileIo Optional Integration Response Message Description: QueryBalanceGroupList For a description of this response message, see Table 37. Object Optional Integration Object Object Table 37. Response Message Description: QueryBalanceGroupList Node Description Type QueryBalanceGroupListRespMsg:ListOfSwiBalanceGroupIoRes Optional Integration Object SiebelFaultMsg:Fault Optional Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 55
- 56. Siebel CRM Primary Web Services ■ AccountBalanceSiebelCommsReqABCS Request Message Description: QueryBalanceDetails For a description of this request message, see Table 38. Table 38. Request Message Description: QueryBalanceDetails Node Description Type CustomHeaderContext Optional Hierarchy QueryBalanceDetailsReqMsg:ListOfSwiBillingGroupDetailIoReq Optional Integration Object Response Message Description: QueryBalanceDetails For a description of this response message, see Table 39. Table 39. Response Message Description: QueryBalanceDetails Node Description Type QueryBalanceDetailsRespMsg:ListOfSwiBillingGroupDetailIoRes Optional Integration Request Message Description: QueryBalanceGroupServices For a description of this request message, see Table 40. Response Message Description: QueryBalanceGroupServices For a description of this response message, see Table 41. Siebel CRM Web Services Reference Version 8.1/8.2 56 Object SiebelFaultMsg:Fault Optional Integration Object Table 40. Request Message Description: QueryBalanceGroupService Node Description Type CustomHeaderContext Optional Hierarchy QueryBalanceGroupServicesReqMsg:ListOfSwiBillingGroup DetailIoReq Optional Integration Object Table 41. Response Message Description: QueryBalanceGroupService Node Description Type QueryBalanceGroupServicesRespMsg:ListOfSwiBalanceGroup ServicesIoRes Optional Integration Object SiebelFaultMsg:Fault Optional Integration Object
- 57. Siebel CRM Primary Web Services ■ AccountBalanceSiebelCommsReqABCS AccountBalanceSiebelCommsReqABCS 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 42. Table 42. AccountBalanceSiebelCommsReqABCS Service Object Name Boundary Object Type Class AccountBalanceSiebelCommsReqABCS Business Service CSSWSOutboundDispatcher Data Object (Integration Object) For a description of the data objects for this Web service, see Table 43. Table 43. AccountBalanceSiebelCommsReqABCS Data Object Siebel Repository Name External Name SWIBalanceGroupServicesIORes Account SWIBillingGroupDetailIOReq Account CMU Request Billing Profile IO Account CMU Balance Summary Response IO Account SWIBalanceGroupIORes Account SWIBillingGroupDetailIORes Account Fault Fault Methods For a description of the methods for this Web service, see Table 44. Table 44. AccountBalanceSiebelCommsReqABCS Methods Operation Method QueryBalanceSummary QueryBalanceSummary QueryBalanceGroupList QueryBalanceGroupList QueryBalanceDetails QueryBalanceDetails QueryBalanceGroupServices QueryBalanceGroupServices Siebel CRM Web Services Reference Version 8.1/8.2 57
- 58. Siebel CRM Primary Web Services ■ AdjustmentSiebelCommsReqABCS Example Package for AccountBalanceSiebelCommsReqABCS To view an example of messages 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. Request See the following file to view the sample code: ...AccountBalanceSiebelCommsReqABCSRequest Response See the following file to view the sample code: ...AccountBalanceSiebelCommsReqABCSResponse Interface Description (WSDL) for AccountBalanceSiebelCommsReqABCS 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. ...AccountBalanceSiebelCommsReqABCSWSDL AdjustmentSiebelCommsReqABCS Use this outbound Web service to query for adjustments made to a bill in the external Oracle Communi-cations Siebel CRM Web Services Reference Version 8.1/8.2 58 Billing and Revenue Management application that will be displayed in the Billing view in Siebel Communications. AdjustmentSiebelCommsReqABCS Operations For a list of operations associated with this Web service, see Table 45. Table 45. AdjustmentSiebelCommsReqABCS Operations Name Description QueryAdjustment Queries the adjustment details in the Billing view in Siebel Communications. CreateAdjustment Creates adjustments. (currently not used.)
- 59. Siebel CRM Primary Web Services ■ AdjustmentSiebelCommsReqABCS Request Message Description: QueryAdjustment For a description of this request message, see Table 46. Table 46. Request Message Description: QueryAdjustment Node Description Type CustomHeaderContext Optional Hierarchy QueryAdjustmentReqMsg:ListOfCmuRequestBilledUsageIo Optional Integration Object Response Message Description: QueryAdjustment For a description of this response message, see Table 47. Table 47. Response Message Description: QueryAdjustment Node Description Type QueryAdjustmentRespMsg:ListOfCmuResponseBilledUsage ArItemsIo SiebelFaultMsg:Fault Optional Integration Object Request Message Description: CreateAdjustment For a description of this request message, see Table 48. Table 48. Request Message Description: CreateAdjustment Node Description Type CustomHeaderContext Optional Hierarchy CreateAdjustmentReqMsg:ListOfCmuRequestAdjustmentIo Optional Integration Object Response Message Description: CreateAdjustment For a description of this response message, see Table 49. Optional Integration Object Table 49. Response Message Description: CreateAdjustment Node Description Type CreateAdjustmentRespMsg:ListOfCmuResponseAdjustmentIo Optional Integration Object SiebelFaultMsg:Fault Optional Integration Object AdjustmentSiebelCommsReqABCS 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. Siebel CRM Web Services Reference Version 8.1/8.2 59
- 60. Siebel CRM Primary Web Services ■ AdjustmentSiebelCommsReqABCS Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 50. Table 50. AdjustmentSiebelCommsReqABCS Service Objects Name Boundary Object Type Class AdjustmentSiebelCommsReqABCS Business Service CSSWSOutboundDispatcher Data Object (Integration Object) For a description of the data objects for this Web service, see Table 51. Table 51. AdjustmentSiebelCommsReqABCS Data Objects Siebel Repository Name External Name CMU Request Billed Usage IO Account CMU Response Billed Usage AR Items IO Account Fault Fault Methods For a description of the methods for this Web service, see Table 52. Table 52. AdjustmentSiebelCommsReqABCS Methods Operation Method QueryAdjustment QueryAdjustment CreateAdjustment CreateAdjustment Example Package for AdjustmentSiebelCommsReqABCS To view an example of messages 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. Request See the following file to view the sample code: ...AdjustmentSiebelCommsReqABCSQueryAdjustmentRequestMessage.xml Response See the following file to view the sample code: ...AdjustmentSiebelCommsReqABCSQueryAdjustmentResponseMessage.xml Siebel CRM Web Services Reference Version 8.1/8.2 60
- 61. Siebel CRM Primary Web Services ■ AssetManagementComplex Interface Description (WSDL) for AdjustmentSiebelCommsReqABCS 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. ...AdjustmentSiebelCommsReqABCSAdjustmentSiebelCommsReqABCS.wsdl AssetManagementComplex To display the detail of a promotion, customizable product, or bundle asset, for example, to display the related products for a promotion, the child items for a customizable product, or bundle asset. AssetManagementComplex Operations The following operations are used for the AssetManagementComplex Web service. For a list of operations associated with this Web service, see Table 53. Table 53. AssetManagementComplex Operations Name Description AssetManagementComplexQueryPageQuoteAddItems The Web service fetches the details of promotion, customizable product or bundle asset. Request Message Description: AssetManagementComplexQueryPage Asset ManagementComplex Web service is called to query for the details of a promotion, customizable product, or bundle asset. Displays the related products for promotion, child items for a customizable product, or bundle asset. For a description of this request message, see Table 54. Table 54. Request Message Description: AssetManagementComplexQueryPage Node Description Type AssetManagementComplex IO Required Integration Object AssetDescription List Price String AssetNumber Adjusted Value String BillingAccount Billing Account String BillingAccountId Billing Account ID String InstallDate Install Date String IntegrationId Integration ID String OwnerContactId Owner Contact ID String ProductDescription Product Description String Siebel CRM Web Services Reference Version 8.1/8.2 61
- 62. Siebel CRM Primary Web Services ■ AssetManagementComplex Table 54. Request Message Description: AssetManagementComplexQueryPage Node Description Type ProductId Product ID String ProductName Product Name String ProductPartNumber Product Number String SerialNumber Serial Number String ServiceAccount Service Account String ServiceAccountId Service Account ID String Status Status String NRCCxTotal String MRCCxTotal String Id ID String AdjustedListPrice Adjusted List Price String AssetCurrencyCode Asset Currency Code String AssetDescription Asset Description String AssetId Asset ID String AssetNumber Asset Number String Comments Comments String InstallDate Install Date String IntegrationId Integration ID String Name Asset Name String ParentAssetId Parent Asset ID String PriceType Price Type String ProdPromId Product Prom ID String ProductDefTypeCode Product Def Type Code String ProductId Product ID String ProductName Product Name String ProductPartNumber Product Part Number String ProductType Product Type String Quantity2 Quantity String RootAssetId Root Asset ID String UnitofMeasure Unit of Measure String DataType Asset Data Type String Siebel CRM Web Services Reference Version 8.1/8.2 62
- 63. Siebel CRM Primary Web Services ■ AssetManagementComplex Table 54. Request Message Description: AssetManagementComplexQueryPage Node Description Type Description Asset Description String DisplayName Asset Display Name String Value Asset Value String Response Message Description: AssetManagementComplexQueryPage For a description of this response message, see Table 55. Table 55. Response Message Description: AssetManagementComplexQueryPage Node Description Type AssetDescription Asset Description String AssetNumber Asset Number String BillingAccount Billing Account String BillingAccountId Billing Account ID String InstallDate Install Date String IntegrationId Integration ID String OwnerContactId Owner contact ID String ProductDescription Product Description String ProdPromId Product Prom ID String ProductDefTypeCode Product Code String ProductId Product ID String ProductName Product Name String ProductPartNumber Product Part Number String ProductType Product Number String PriceType Price Type String SerialNumber Service Number String ServiceAccount Service Account String ServiceAccountId Service Account ID String Status Status String Id ID String AdjustedListPrice Asjusted List Price String AssetCurrencyCode Asset Currency Code String Comments Comments String Siebel CRM Web Services Reference Version 8.1/8.2 63
- 64. Siebel CRM Primary Web Services ■ AssetManagementComplex Table 55. Response Message Description: AssetManagementComplexQueryPage Node Description Type Name Asset Name String ParentAssetId Parent Asset ID String Quantity2 Quantity String RootAssetId Root Asset ID String UnitofMeasure Unit of Measure String DataType Asset Data Type String Description Asset Description String DisplayName Asset Display Name String Value Asset Value String AssetManagementComplex 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 56. Table 56. AssetManagementComplext Service Object Name Boundary Object Type Class Asset Management - Complex Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service, see Table 57. Table 57. AssetManagementComplext Data Objects Siebel Repository Name External Name SiebelMessage SiebelMessage SiebelMessageIn SiebelMessage SiebelMessageOut SiebelMessageOut Example Package for AssetManagementComplex To view an example of messages 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. Siebel CRM Web Services Reference Version 8.1/8.2 64
- 65. Siebel CRM Primary Web Services ■ CalculateShippingChargeSalesOrderSiebelReqABCSImpl Request See the following file to view the sample code: ...AssetManagementComplexAssetManagementComplex_request.xml Response See the following file to view the sample code: ...AssetManagementComplexAssetManagementComplex_response.xml Interface Description (WSDL) for AssetManagementComplex 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. ...AssetManagementComplexAssetManagementComplex.wsdl CalculateShippingChargeSalesOrderSieb elReqABCSImpl Use this Web service to get information about the shipping costs of a sales order. CalculateShippingChargeSalesOrderSiebelReqABCSImpl Operations For a list of operations associated with this Web service, see Table 58. Table 58. CalculateShippingChargeSalesOrderSiebelReqABCSImpl Operations Name Description CalculateShippingCharge Retrieves shipping charge information for sales orders. Request Message Description: CalculateShippingCharge For a description of this request message, see Table 59. Table 59. Request Message Description: CalculateShippingCharge Node Description Type CalculateShippingChargeSalesOrder ReqMsg:ListOfSWIOrderIOReq Optional Hierarchy CustomerHeaderContext Optional Hierarchy Siebel CRM Web Services Reference Version 8.1/8.2 65
- 66. Siebel CRM Primary Web Services ■ CalculateShippingChargeSalesOrderSiebelReqABCSImpl Response Message Description: CalculateShippingCharge For a description of this response message, see Table 60. Table 60. Response Message Description: CalculateShippingCharge Node Description Type CustomHeaderContext Optional Hierarchy CalculateShippingChargeSalesOrder RespMsg:ListOfSWIOrderIOResp CalculateShippingChargeSalesOrderSiebelReqABCSImpl 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 61. Data Object (Integration Object) For a description of data objects for this Web service, see Table 62. Siebel CRM Web Services Reference Version 8.1/8.2 66 Optional Hierarchy XMLHierarchyOutput Optional Hierarchy faultactor Optional String faultcode Optional String faultstring Optional String SiebelFaultMsg:Fault Optional Integration Object Table 61. CalculateShippingChargeSalesOrderSiebelReqABCSImpl Service Object Siebel Repository Name Boundary Object Type Class SWISendCalculateShippingCharge Workflow Not applicable Table 62. CalculateShippingChargeSalesOrderSiebelReqABCSImpl Data Object Siebel Repository Name External Name SWIOrderIO SWIOrderIO Fault Fault
- 67. Siebel CRM Primary Web Services ■ CatalogWebService Methods For a description of the methods for this Web service, see Table 63. Table 63. CalculateShippingChargeSalesOrderSiebelReqABCSImpl Methods Operation Method CalculateShippingCharge CalculateShippingCharge Interface Description WSDL for CalculateShippingChargeSalesOrderSiebelReqABCSImpl 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. ...CalculateShippingChargeSalesOrderSiebelReqABCSImplCalculateShippingChargeSalesOrd erSiebelReqABCSImpl.wsdl 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 64. Table 64. CatalogWebService operations Name Description 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. Siebel CRM Web Services Reference Version 8.1/8.2 67
- 68. Siebel CRM Primary Web Services ■ CatalogWebService Request Message Description: GetRelatedPromotions For a description of this request message, see Table 65. Table 65. Request Message: GetRelatedPromotions Name Description Type PDS Related Promotions Interface Response Message Description: GetRelatedPromotions For a description of this response message, see Table 66. Request Message Description: GetRelatedProducts For a description of this request message, see Table 67. Siebel CRM Web Services Reference Version 8.1/8.2 68 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 Table 66. Response Message: GetRelatedPromotions Name Description Type 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 Table 67. Request Message: GetRelatedProducts Name Description Type PDS Related An instance of the integration object PDS Related Products Interface Products Interface. Integration Object PricingMode Y or N (calculates price or not). Optional. The default value is Y. String
- 69. Siebel CRM Primary Web Services ■ CatalogWebService Table 67. Request Message: GetRelatedProducts Name Description Type 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. ContextMode SiebelContext or ExternalContext. Optional. However, provide ContextMode to run pricing and eligibility. 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. Response Message Description: GetRelatedProducts For a description of this response message, see Table 68. Table 68. Response Message: GetRelatedProducts Name Description Type 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. Request Message Description: GetCategory For a description of this request message, see Table 69. Table 69. Request Message: GetCategory Name Description Type PDS Category Interface An instance of the integration object PDS Integration Object Category Interface. Response Message Description: GetCategory For a description of this response message, see Table 70. String String Integration Object Integration Object Integration Object Table 70. Response Message: GetCategory Name Description Type PDS Category Interface An instance of the integration object PDS Integration Object Category Interface. Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 69
- 70. Siebel CRM Primary Web Services ■ CatalogWebService Request Message Description: UDSPublishCatalog For a description of this request message, see Table 71. Table 71. Request Message: UDSPublishCatalog Name Description Type SiebelMessageIn An instance of the integration object PDS UDS Response Message Description: UDSPublishCatalog For a description of this response message, see Table 72. 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. Siebel CRM Web Services Reference Version 8.1/8.2 70 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 Table 72. Response Message: UDSPublishCatalog Name Description Type SiebelMessageOut An instance of the integration object PDS UDS Publish Catalog Interface. Integration Object
- 71. Siebel CRM Primary Web Services ■ CheckATPSalesOrderSiebelReqABCS Impl Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 73. Table 73. CatalogWebService Application Interface Name Boundary Object Type Class PDS Product Data Service BusService CSSProdDataSvc Data Object (Integration Object) For a description of data objects for this Web service, see Table 74. Table 74. CatalogWebService Data Objects Siebel Repository Name External Name 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. ...CatalogWebServiceCatalogWebService.wsdl CheckATPSalesOrderSiebelReqABCS Impl Use this Web service to check the availability and location of a requested product. CheckATPSalesOrderSiebelReqABCSImpl Operations For a list of operations associated with this Web service, see Table 75. Table 75. CheckATPSalesOrderSiebelReqABCSImpl Operations Name Description CheckATP Synchronizes the account. Siebel CRM Web Services Reference Version 8.1/8.2 71
- 72. Siebel CRM Primary Web Services ■ CheckATPSalesOrderSiebelReqABCS Impl Request Message Description: CheckATP For a description of this request message, see Table 76. Table 76. Request Message Description: CheckATP Node Description Type CheckATPSalesOrderReqMsg:ATPCh eckInterfaceRequestOrders Response Message Description: CheckATP For a description of this response message, see Table 77. CheckATPSalesOrderSiebelReqABCSImpl 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 78. Siebel CRM Web Services Reference Version 8.1/8.2 72 Optional Hierarchy CustomHeaderContext Optional Hierarchy Table 77. Response Message Description: CheckATP Node Description Type CustomHeaderContext Optional Hierarchy CheckATPSalesOrderRespMsg:ATPC Optional Hierarchy heckInterfaceResponseOrders XMLHierarchyOutput Optional Hierarchy faultactor Optional String faultcode Optional String faultstring Optional String SiebelFaultMsg:Fault Optional Integration Object Table 78. CheckATPSalesOrderSiebelReqABCSImpl Service Object Siebel Repository Name Boundary Object Type Class SWISendATPCheck Workflow Not applicable SWISendATPCheckLine Workflow Not applicable
- 73. Siebel CRM Primary Web Services ■ ClinicalSubject Data Object (Integration Object) For a description of data objects for this Web service, see Table 79. Table 79. CheckATPSalesOrderSiebelReqABCSImpl Data Object Siebel Repository Name External Name SWIOrderIO SWIOrderIO Fault Fault Methods For a description of the methods for this Web service, see Table 80. Table 80. CheckATPSalesOrderSiebelReqABCSImpl Methods Operation Method CheckATP CheckATP Example Package for CheckATPSalesOrderSiebelReqABCSImpl To view an example of messages 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. Interface Description (WSDL) for CheckATPSalesOrderSiebelReqABCSImpl 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. ...CheckATPSalesOrderSiebelReqABCSImplCheckATPSalesOrderSiebelReqABCSImpl.wsdl ClinicalSubject Use this Web service to perform the following: ■ Create a subject record in the Siebel database from details provided by an external application. The Screen and Enrollment template is applied to each new record with a default informed consent date, if a date is not provided by the external application. If a valid informed consent date is provided by the external application, then the Web service updates the default value with the valid informed consent date. ■ Create additional Siebel Life Science statuses for a subject apart from the statuses Screened and Siebel CRM Web Services Reference Version 8.1/8.2 73 Enrolled. ■ Designate any record at Primary.
- 74. Siebel CRM Primary Web Services ■ ClinicalSubject ■ Mark Visits/Activities as completed with the Completed Date details, and other information Table 81. ClinicalSubject Operations Name Description Upsert Creates a Subject record in the Siebel database with the minimum required details, along with performing relevant updates. Siebel CRM Web Services Reference Version 8.1/8.2 74 provided by the external application. NOTE: This Web service assumes that the Visits/Activities Clinical Item is unique for the given Subject Visit Template. This Web service returns the Integration ID when a subject creation is successful. The Integration ID is used for identifying the subject for any future operations. An error message is presented in the event of an error. ClinicalSubject Operations For a list of operations associated with this Web service, see Table 81. Request Message Description: Upsert For a description of this request message, see Table 82. Table 82. Request Message Description: Upsert Node Description Type IntegrationId Required. Process instance ID. Character data. VisitClinicalItem Required. Text used to map a visit from the external application. Character data. Done Required. Completion date. UTC Date Time. ActivityClinicalItem Required. Text used to map an activity from other application. Character data. EnrollmentDate Optional. Date. DateofBirth Required. Date. ScreenDate Optional. Date. SubjectInitials Required. Character data. PhoneNumber Optional. Character data. FaxNumber Optional. Character data. EmailAddress Optional. Character data. EnrollmentId Optional. Character data. Comments Optional. Character data.
- 75. Siebel CRM Primary Web Services ■ ClinicalSubject Table 82. Request Message Description: Upsert Node Description Type EligibleFlag Optional. Boolean (character). ProtocolDeviation Optional. Boolean (character). ProtocolViolation Optional. Boolean (character). ReasonExcluded Optional. Character data. WithdrawnReason Optional. Character data. RandomizationId Optional. Character data. ProtocolSiteId Required. Character data. InformedConsentSignedDate Optional. Date. Status Optional. Character data. StatusDate Optional. Date. Response Message Description: Upsert For a description of this response message, see Table 83. Table 83. Response Message Description: Upsert Node Description Type IntegrationId Required. Returns the process instance ID in case the subject creation is successful. Character data. ClinicalSubject 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 84. Table 84. ClinicalSubject Service Object Siebel Repository Name Boundary Object Type Class SWI LS Clinical Subject Inbound-Subject Workflow Not applicable Siebel CRM Web Services Reference Version 8.1/8.2 75
- 76. Siebel CRM Primary Web Services ■ CMU Account Query Data Object (Integration Object) For a description of data objects for this Web service, see Table 85. Table 85. ClinicalSubject Data Object Siebel Repository Name External Name Clinical Subject External Clinical Subject Example Package for ClinicalSubject To view an example of messages 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. Request See the following file to view the sample code: ...ClinicalSubjectClinicalSubject_request.xml Interface Description (WSDL) for ClinicalSubject 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. ...ClinicalSubjectClinicalSubject_asi_ClinicalSubject.wsdl CMU Account Query Use this Web service to find an account detail in the Siebel CRM application. A business service is made available in the Siebel CRM application so that the middle layer can query for the account detail in the Siebel CRM application and synchronize this detail with the billing application. The account detail that this Web service finds includes details about the contacts, addresses, and billing profiles that are associated with the account. This detail includes only those fields that the billing application needs to synchronize data. The response message returns only an acknowledgement message and not data. CMU Account Query Operations For a list of operations associated with this Web service, see Table 86. Table 86. CMU Account Query Operations Name Description CMU Account Query Page Finds the account detail based on the account ID and Siebel CRM Web Services Reference Version 8.1/8.2 76 the billing profile ID.
- 77. Siebel CRM Primary Web Services ■ CMU Account Query Request Message Description: CMU Account Query Page For a description of this request message, see Table 87. Table 87. Request Message Description: CMU Account Query Page Node Description AccountId The ID of the account for the billing profile. BillingProfileId The ID of the billing profile for the account. CMU Account Query 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 88. Table 88. CMU Account Query Service Object Name Boundary Object Type Class (If Business Service) CMU Account Query Service Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service, see Table 89. Table 89. CMU Account Query Data Object Siebel Repository Name External Name CMU Query Account Io CMU - Account Methods For a description of methods for this Web service, see Table 90. Table 90. CMU Account Query Methods Operation Method CMU Account QueryPage [BS: CMU Account Query Service].QueryPage Example Package for CMU Account Query To view an example of messages 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. Siebel CRM Web Services Reference Version 8.1/8.2 77
- 78. Siebel CRM Primary Web Services ■ CMU Account Update Request See the following file to view the sample code: ...CMUAccountQueryCMUAccountQuery.xml Response See the following file to view the sample code: ...CMUAccountQueryCMUAccountQuery.xml Interface Description (WSDL) for CMU Account Query 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. ...CMUAccountQueryCMUAccountQuery.wsdl CMU Account Update Use this Web service to update the status of an account in the Siebel CRM application when the status of the account changes in the external billing application. The external billing application makes this inbound Web service call to the Siebel CRM application to update the status of the account. A business service is made available in the Siebel CRM application to update the status field. The response message returns only an acknowledgement message and not data. CMU Account Update Operations For a list of operations associated with this Web service, see Table 91. Table 91. CMU Account Update Operations Name Description CMU Account Update Request Message Description: CMU Account Update For a description of this request message, see Table 92. Siebel CRM Web Services Reference Version 8.1/8.2 78 Updates the status of an account in the Siebel CRM application when the status of the account changes in the billing application. Table 92. Request Message Description: CMU Account Update Node Description AccountId The ID of the account for the billing profile. AccountStatus The status of the account that was updated in the billing application.
- 79. Siebel CRM Primary Web Services ■ CMU Account Update CMU Account Update 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 93. Table 93. CMU Account Update Service Object Name Boundary Object Type Class (If Business Service) CMU Account Update Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of data objects for this Web service, see Table 94. Table 94. CMU Account Update Data Object Siebel Repository Name External Name CMU Update Account Io Account Methods For a description of methods for this Web service, see Table 95. Table 95. CMU Account Update Methods Operation Method CMU Account Update [BS: CMU Account Update].Update Example Package for CMU Account Update To view an example of messages 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. Request See the following file to view the sample code: ...CMUAccountUpdateCMUAccountUpdate.xml Response See the following file to view the sample code: ...CMUAccountUpdateCMUAccountUpdate.xml Siebel CRM Web Services Reference Version 8.1/8.2 79
- 80. Siebel CRM Primary Web Services ■ ConfiguratorUserLangSiebelAdapter Interface Description (WSDL) for Account Update 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. ...CMUAccountUpdateCMUAccountUpdate.wsdl ConfiguratorUserLangSiebelAdapter This is an Oracle Application Integration Architecture Web service, which is made available by Oracle Application Integration Architecture. This Web service is called from Siebel CRM to get language and other details. Use this outbound Web service to launch Siebel Configurator. ConfiguratorUserLangSiebelAdapter Operations For a list of operations associated with this Web service, see Table 96. Table 96. ConfiguratorUserLangSiebelAdapter Operations Name Description process Returns the User, Responsibility ID, and Language values from Oracle Request Message Description: process For a description of this request message, see Table 97. Response Message Description: process For a description of this response message, see Table 98. Siebel CRM Web Services Reference Version 8.1/8.2 80 E-Business Suite. These values are needed to launch Siebel Configurator and customize a product. Table 97. Request Message Description: process Node Description Type ConfiguratorUserLangSiebelAdapter RequestMessage:payload Optional Hierarchy CustomHeaderContext Optional Hierarchy Table 98. Response Message Description: process Node Description Type CustomHeaderContext Optional Hierarchy MConfiguratorUserLangSiebelAdapt Optional Hierarchy erResponseMessage:payload XMLHierarchyOutput Optional Hierarchy
- 81. Siebel CRM Primary Web Services ■ ConfiguratorUserLangSiebelAdapter Table 98. Response Message Description: process Node Description Type faultactor Optional String faultcode Optional String faultstring Optional String MatchContactFaultMsg:payload Optional Integration Object ConfiguratorUserLangSiebelAdapter 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 99. Table 99. ConfiguratorUserLangSiebelAdapter Service Object Siebel Repository Name Boundary Object Type Class Oracle Configurator Load Workflow Not applicable Data Object (Integration Object) For a description of data objects for this Web service, see Table 100. Table 100. ConfiguratorUserLangSiebelAdapter Data Object Siebel Repository Name External Name ConfiguratorUserLangSiebelAdapterProcessRequest ConfiguratorUserLangSiebelAdapterProces sRequest ConfiguratorUserLangSiebelAdapterProcessResponse ConfiguratorUserLangSiebelAdapterProces sResponse Methods For a description of the methods for this Web service, see Table 101. Table 101. ConfiguratorUserLangSiebelAdapter Methods Operation Method process process Siebel CRM Web Services Reference Version 8.1/8.2 81
- 82. Siebel CRM Primary Web Services ■ Contact Contact Use this Web service for the basic operations of Siebel Marketing such as to create and update contacts. Contact Operations For a list of operations associated with this Web service, see Table 102. Table 102. Contact Operations Name Description ContactCreateContact Creates a contact. ContactUpdateContact Updates an existing contact. Request Message Description: ContactCreateContact For a description of this request message, see Table 103. Table 103. Request Message Description: ContactCreateContact Node Description Type Contact IO Required. An instance of the integration object Response Message Description: ContactCreateContact For a description of this response message, see Table 104. Siebel CRM Web Services Reference Version 8.1/8.2 82 Contact IO. Contact is the Parent header and Contact_BusinessAddress is the child. Integration Object Table 104. Response Message Description: ContactCreateContact Node Description Type Contact Id The new Contact ID generated as a result of the new contact creation. String Error Message Error Message if any. String Success Flag Flag to indicate success or failure of the operation. String
- 83. Siebel CRM Primary Web Services ■ Contact Request Message Description: ContactUpdateContact For a description of this request message, see Table 105. Table 105. Request Message Description: ContactUpdateContact Node Description Type Contact IO Required. An instance of the integration object Contact IO. Contact is the Parent header and Contact_BusinessAddress is the child. Response Message Description: ContactUpdateContact For a description of this response message, see Table 106. Integration Object Table 106. Response Message Description: ContactUpdateContact Node Description Type Error Message Error message if any. String Success Flag Flag to indicate success or failure of the operation. String Contact 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. Data Object (Integration Object) For a description of data objects for this Web service, see Table 107. Table 107. Contact Data Object Siebel Repository Name External Name Contact IO Contact IO Example Package for Contact To view an example of messages 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. Request (ContactCreate) See the following file to view the sample code: ...ContactContactCreate_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 83
- 84. Siebel CRM Primary Web Services ■ CreateLeads Web Service Response (ContactCreate) See the following file to view the sample code: ...ContactContactCreate_response.xml Request (ContactUpdate) See the following file to view the sample code: ...ContactContactUpdate_request.xml Response (ContactUpdate) See the following file to view the sample code: ...ContactContactUpdate_response.xml Interface Description (WSDL) for Contact 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. ...ContactContact.wsdl CreateLeads Web Service Use this Web service to create leads in the Siebel database. If the Web service returns a given contact’s details, and if those details match an existing contact in the Siebel database, then the Web service creates a lead based on the existing contact’s information. If the contact does not exist in the Siebel database, then the Web service creates a new contact record, and creates a new lead from the new contact. The new lead can be associated with any existing campaign using the Source Code parameter. The Source Code parameter must be retrieved from the ID or Source ID field of the GetCampaigns Web service response. For more information, see “GetCampaigns Web Service” on page 97. CreateLeads Web Service Operations For a list of operations associated with this Web service, see Table 108. Table 108. CreateLeads Web Service operations Name Description CreateLeads Creates a lead with provided details. It performs a deduplication Siebel CRM Web Services Reference Version 8.1/8.2 84 operation on lead details, and if the lead does not match an existing lead, creates a new lead.
- 85. Siebel CRM Primary Web Services ■ CreateLeads Web Service Request Message Description: CreateLeads For a description of this request message, see Table 109. Table 109. Request Message Description: CreateLeads Node Description Type Lead IO Used to describe leads. Performs a deduplication operation based on information returned from the node. If required a new contact is created. Integration Object Mktg Social Data IO Used to capture social posts data related to a lead. You can associate multiple social posts to the same lead.. Integration Object Mktg SM Personal Address IO Extracts a new lead address from social posts. Integration Object Response Message Description: CreateLeads Supplies the success status for Lead creation. It issues an error message (if any) or a lead ID if the lead creation was successful. For a description of this response message, see Table 110. Table 110. Response Message Description: CreateLeads Node Description Type Success Flag Indicates the status of the CreateLead operation. Status is: Yes if lead is created properly, then No if not. String Error Message A descriptive error message of the particular issue that occurred during lead creation. The Duplicate Lead message indicates the operation is attempting to create a leads that is already in the database. String Lead ID The unique ID of the new lead. String CreateLeads Web Service 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. Siebel CRM Web Services Reference Version 8.1/8.2 85
- 86. Siebel CRM Primary Web Services ■ CreateLeads Web Service Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 111. Table 111. CreateLeads Service Object Name Boundary Object Type Class (If Business Service) SocialMediaService Business Service CSSSocialService Data Object (Integration Object) For a description of data objects for this Web service, see Table 112. Table 112. CreateLeads Web Service Data Object Siebel Repository Name External Name LeadIO ListofLeadIO MktgSocialDataIO ListOfMktgSocialDataIO MktgSMPersonalAddressIO ListOfMktgSMPersonalAddressIo Methods For a description of the methods for this Web service, see Table 113. Table 113. CreateLeads Web Service Methods Operation Method CreateLeads CreateLeads Example Package for CreateLeads Web Service To view an example of messages 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. Request See the following file to view the sample code: ...CreateLeadsWebServiceCreateLeads_req.xml Response See the following file to view the sample code: ...CreateLeadsWebServiceCreateLeads_resp.xml Siebel CRM Web Services Reference Version 8.1/8.2 86
- 87. Siebel CRM Primary Web Services ■ CreditCheckSalesOrderSiebelReqABCSImpl Interface Description (WSDL) for CreateLeads Web Service 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. ...CreateLeadsWebServiceCreateLeads.wsdl CreditCheckSalesOrderSiebelReqABCSI mpl Use this Web service to verify that the method of payment used in a purchase order is a valid payment type. CreditCheckSalesOrderSiebelReqABCSImpl Operations For a list of operations associated with this Web service, see Table 114. Table 114. CreditCheckSalesOrderSiebelReqABCSImpl Operations Name Description CreditCheck Checks for the method of payment. Request Message Description: CreditCheck For a description of this request message, see Table 115. Table 115. Request Message Description: CreditCheck Node Description Type CreditCheckSalesOrderReqMsg:ListOfSWIOrderIOReq Optional Hierarchy CustomHeaderContext Optional Hierarchy Response Message Description: CreditCheck For a description of this response message, see Table 116. Table 116. Response Message Description: CreditCheck Node Description Type CustomHeaderContext Optional Hierarchy CreditCheckSalesOrderRespMsg:Lis tOfSWIOrderIOResp Optional Hierarchy XMLHierarchyOutput Optional Hierarchy faultactor Optional String faultcode Optional String Siebel CRM Web Services Reference Version 8.1/8.2 87
- 88. Siebel CRM Primary Web Services ■ CreditCheckSalesOrderSiebelReqABCSImpl Table 116. Response Message Description: CreditCheck Node Description Type faultstring Optional String SiebelFaultMsg:Fault Optional Integration Object CreditCheckSalesOrderSiebelReqABCSImpl 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 117. Table 117. CreditCheckSalesOrderSiebelReqABCSImpl Service Object Siebel Repository Name Boundary Object Type Class SWISendCreditCheck Workflow Not applicable Data Object (Integration Object) For a description of data objects for this Web service, see Table 118. Table 118. CreditCheckSalesOrderSiebelReqABCSImpl Data Object Siebel Repository Name External Name SWIOrderIO SWIOrderIO Fault Fault Methods For a description of the methods for this Web service, see Table 119. Table 119. CreditCheckSalesOrderSiebelReqABCSImpl Methods Operation Method CreditCheck CreditCheck Example Package for CreditCheckSalesOrderSiebelReqABCSImpl To view an example of messages 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. Siebel CRM Web Services Reference Version 8.1/8.2 88
- 89. Siebel CRM Primary Web Services ■ FetchAccountSiebelReqABCSImpl Interface Description (WSDL) for CreditCheckSalesOrderSiebelReqABCSImpl 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. ...CreditCheckSalesOrderSiebelReqABCSImplCreditCheckSalesOrderSiebelReqABCSImpl.wsdl FetchAccountSiebelReqABCSImpl Use this outbound Web service to synchronize account details with the participating application by fetching the account details from the Siebel database. This Web service is called when the fetch process is triggered in the Siebel application from the Account list, or form applets, and also from the Match Account pop-up applet. FetchAccountSiebelReqABCSImpl Operations The following operations are used for the FetchAccountSiebelReqABCSImpl Web service. For a list of operations associated with this Web service, see Table 120. Table 120. FetchAccountSiebelReqABCSImpl Operations Name Description FetchAccount This operation is used to import a new account from the participating application to Siebel database tables. It is called from the Match Account pop-up applet by clicking the Fetch button to fetch the queried account details from the participating application. CustomerPartyIOFetchAccount Synchronizes a preexisting account from the participating application and imports the record to the Siebel database. The operation is called from the Account list or form applet by clicking the Fetch menu item. AsyncFetchCustomerPartyResponse Not in use. Request Message Description: FetchAccount For a description of this request message, see Table 121. Table 121. Request Message Description: FetchAccount Node Description Type FetchAccountReqMsg:ListofSwimatchaccountvbcio Optional Hierarchy CustomHeaderContext Optional Hierarchy Siebel CRM Web Services Reference Version 8.1/8.2 89
- 90. Siebel CRM Primary Web Services ■ FetchAccountSiebelReqABCSImpl Response Message Description: FetchAccount For a description of this response message, see Table 122. Table 122. Response Message Description: FetchAccount Node Description Type CustomHeaderContext Optional Hierarchy FetchAccountRespMsg:ListofSwimatchaccountvbcio Optional Hierarchy XMLHierarchyOutput Optional Hierarchy faultactor Optional String faultcode Optional String faultstring Optional String FetchAccountFaultMsg:Fault Optional Integration Request Message Description: CustomerPartyIOFetchAccount For a description of this request message, see Table 123. Response Message Description: CustomerPartyIOFetchAccount For a description of this response message, see Table 124. Siebel CRM Web Services Reference Version 8.1/8.2 90 Object Table 123. Request Message Description: CustomerPartyIOFetchAccount Node Description Type FetchAccountReqMsg:ListOfSwimatchaccountvbcio Optional Hierarchy CustomHeaderContext Optional Hierarchy Table 124. Response Message Description: CustomerPartyIOFetchAccount Node Description Type CustomHeaderContext Optional Hierarchy CustomerPartyIOFetchAccountRespMsg:ListOfSwicustomerpartyio Optional Hierarchy XMLHierarchyOutput Optional Hierarchy faultactor Optional String faultcode Optional String faultstring Optional String FetchAccountFaultMsg:Fault Optional Integration Object
- 91. Siebel CRM Primary Web Services ■ FetchAccountSiebelReqABCSImpl FetchAccountSiebelReqABCSImpl 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 125. Table 125. FetchAccountSiebelReqABCSImpl Service Object Siebel Repository Name Boundary Object Type Class SWI External Account Request Sync Process Workflow Not applicable Data Object (Integration Object) For a description of data objects for this Web service, see Table 126. Table 126. FetchAccountSiebelReqABCSImpl Data Object Siebel Repository Name External Name SWIMatchAccountVBCIO Account SWICustomerPartyIO Account Fault Fault Methods For a description of the methods for this Web service, see Table 127. Table 127. FetchAccountSiebelReqABCSImpl Methods Operation Method FetchAccount FetchAccount CustomerPartyIOFetchAccount CustomerPartyIOFetchAccount AsyncFetchCustomerPartyResponse AsyncFetchCustomerPartyResponse Example Package for FetchAccountSiebelReqABCSImpl To view an example of messages 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. Siebel CRM Web Services Reference Version 8.1/8.2 91
- 92. Siebel CRM Primary Web Services ■ FetchContactSiebelReqABCSImpl Interface Description (WSDL) for FetchAccountSiebelReqABCSImpl 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. WSDL ...WSDLFetchAccountSiebelReqABCSImpl.wsdl FetchContactSiebelReqABCSImpl Use this outbound Web service to synchronize contact details with the participating application and the Siebel database. This Web service is called from the Siebel application when the fetch process is called from Contact list or form applets, and also from the Match Contact pop-up applet. FetchContactSiebelReqABCSImpl Operations For a list of operations associated with this Web service, see Table 128. Table 128. FetchContactSiebelReqABCSImpl Operations Name Description FetchContact Imports a new contact from the participating application to Request Message Description: FetchContact Sends queried contact details from the participating application through the Match Contact process to import and synchronize the contact record with Siebel data tables. For a description of this request message, see Table 129. Siebel CRM Web Services Reference Version 8.1/8.2 92 the Siebel database. This operation is called from the Match Contact pop-up applet when a user clicks the Fetch button to fetch the queried contact details from the participating application. ContactIOFetchContact Synchronizes a contact from the participating application and imports the record to the Siebel database. This operation is called from the Contact list or form applet by clicking on Fetch menu item to fetch contact details from the participating application. AsyncFetchCustomerPartyResponse Not in use. Table 129. Request Message Description: FetchContact Node Description Type BirthDate Contact’s birth date. String CellularPhone Contact’s mobile phone number. String
- 93. Siebel CRM Primary Web Services ■ FetchContactSiebelReqABCSImpl Table 129. Request Message Description: FetchContact Node Description Type ContactId Row ID of the contact record in Siebel data tables. String EmailAddress Contact’s email address. String ExternalContactId Oracle Application Integration Architecture (AIA) Cross Reference ID for the contact. String FirstName Contact’s first name. String HomePhone Contact’s home phone number. String LastName Contact’s last name. String MatchScore Match score. String MiddleName Contact’s middle name. String PrimaryAccountName Contact’s primary address. String PrimaryCity Contact’s primary city. String PrimaryCountry Contact’s primary country. String PrimaryPostalCode Contact’s primary postal code. String PrimaryState Contact’s primary state. String PrimaryStreetAddress Contact’s primary street address. String SocialSecurityNumber Contact’s social security number. String WorkPhone Contact’s work phone number. String Response Message Description: FetchContact Contains the Siebel ID value of the contact record that is imported into the Siebel data tables. This record is used to refresh and display the imported contact details in the Siebel application. For a description of this response message, see Table 130. Table 130. Response Message Description: FetchContact Node Description Type ContactId Siebel Row ID of the contact record. String Request Message Description: ContactIOFetchContact Sends contact details to the participating application to synchronize the contact with the Siebel database. Siebel CRM Web Services Reference Version 8.1/8.2 93
- 94. Siebel CRM Primary Web Services ■ FetchContactSiebelReqABCSImpl For a description of this request message, see Table 131. Table 131. Request Message Description: ContactIOFetchContact Node Description Type Id Contact ID. String RowId Siebel Row ID of the contact record. String Response Message Description: ContactIOFetchContact Contains the Siebel ID value of the contact record that is synchronized with the Siebel database. This record is used to refresh contact details in the Siebel application after synchronizing the contact with the participating application. For a description of this response message, see Table 132. Table 132. Response Message Description: ContactIOFetchContact Node Description Type Id Contact ID. String RowId Siebel Row ID of the contact record. String FetchContactSiebelReqABCSImpl 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 133. Table 133. FetchContactSiebelReqABCSImpl Service Object Siebel Repository Name Boundary Object Type Class FetchContactSiebelReqABCSImplService Business Service CSSWSOutboundDispatcher Data Object (Integration Object) For a description of data objects for this Web service, see Table 134. Table 134. FetchContactSiebelReqABCSImpl Data Object Siebel Repository Name External Name SWIMatchContactVBCIO Contact SWICustomerPartyIO SWI Contact Fault Fault Siebel CRM Web Services Reference Version 8.1/8.2 94
- 95. Siebel CRM Primary Web Services ■ FS Asset Warranty Service Interface Description (WSDL) for FetchContactSiebelReqABCSImpl 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. WSDL ...WSDLFetchContactSiebelReqABCSImpl.wsdl FS Asset Warranty Service Use this Web service to create asset warranties and to retrieve asset warranty information. FS Asset Warranty Service Operations For a list of operations associated with this Web service, see Table 135. Table 135. FS Asset Warranty Service Operations Name Description CreateAssetWarranty Adds the input warranty to the source asset. GetAssetWarranty Used to retrieve all the warranties for a specified asset's product and then add them to the asset if not already done so. Request Message Description: CreateAssetWarranty Adds a specific warranty to an asset. If that warranty has already been added to the asset record, then the service will update the service date. For a description of this request message, see Table 136. Table 136. Request Message Description: CreateAssetWarranty Node Description Type Asset Id Row ID of asset. String Warranty Id Row ID of the warranty. String Serviced Date Date from which warranty will start displayed in the following format: (mm/dd/yyyy). Date Siebel CRM Web Services Reference Version 8.1/8.2 95
- 96. Siebel CRM Primary Web Services ■ FS Asset Warranty Service Response Message Description: CreateAssetWarranty For a description of this response message, see Table 137. Table 137. Response Message Description: CreateAssetWarranty Node Description Type StatusMsg (Optional). Will give error message in the case of Request Message Description: GetAssetWarranty This operation will add all the warranty information associated with an asset. The date depends on the start data type of each warranty. If some of the warranties are already attached to the asset, then the operation adds the other potential warranties, but leaves the existing warranties untouched. CAUTION: This operation does not return an error message if the user provides the wrong value for Asset ID. For a description of this request message, see Table 138. Response Message Description: GetAssetWarranty This Web service has no response message. FS Asset Warranty 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 139. Siebel CRM Web Services Reference Version 8.1/8.2 96 incompatibility of inputs. If there is no incompatibility, then there will be no message. String Table 138. Request Message Description: GetAssetWarranty Node Description Type Asset Id Row ID of asset. String Table 139. FS Asset Warranty Service Object Name Boundary Object Type Class BS: FS Asset Warranty Service Operation: CreateAssetWarranty Business Service CSSFSAssetWrntyService BS: FS Asset Warranty Service Operation: GetAssetWarranties Business Service CSSFSAssetWrntyService
- 97. Siebel CRM Primary Web Services ■ GetCampaigns Web Service Example Package for FS Asset Warranty Service To view an example of messages 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. Request, Response (CreateAssetWarranty) See the following file to view the sample code: ...FSAssetWarrantyCreateAssetWarranty_Sample_IO.doc Request, Response (GetAssetWarranties) See the following file to view the sample code: ...FSAssetWarrantyGetAssetWarranty_Sample_IO.doc Interface Description (WSDL) for FS Asset Warranty Service 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. ...FSAssetWarrantyFSAssetWarranty.wsdl GetCampaigns Web Service Use this Web service to retrieve campaigns and associated details from Siebel CRM with input parameters. Campaigns are sorted by the following criteria: Type, Subtype, and the Last Name field. The Source ID parameter in the response message for this Web service is used in conjunction with the Create Leads Web service to associate a newly created lead with an existing campaign. For more information, see “CreateLeads Web Service” on page 84. GetCampaigns Web Service Operations For a list of operations associated with this Web service, see Table 140. Table 140. GetCampaigns Web Service Operations Name Description GetCampaigns Returns a list of campaigns based on provide input parameters. Siebel CRM Web Services Reference Version 8.1/8.2 97
- 98. Siebel CRM Primary Web Services ■ GetCampaigns Web Service Request Message Description: GetCampaigns For a description of this request message, see Table 141. Table 141. Request Message Description: GetCampaigns Node Description Type Campaign Name Optional. The campaign name. Restricts results by Response Message Description: GetCampaigns For a description of this response message, see Table 142. GetCampaigns Web Service 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 143. Siebel CRM Web Services Reference Version 8.1/8.2 98 campaign name. For example, passing a value of 2002 will return all campaigns that have 2002 in the name. String Start Date Optional. Returns a list of campaigns having a start date greater or equal to a given value. String End Date Optional. Returns a list of campaigns having a start date less than or equal to a given value. String Page Number Required. Determines the number of records retrieved by a response. It must be a value greater than zero. String Row Number Optional. Retrieves the Page Number value of campaigns. It must be a value greater than zero. String Source Code The row ID of the campaign you want to retrieve. String Table 142. Response Message Description: GetCampaigns Node Description Type MKTG campaign IO Determines what fields of campaign records are retrieved and added to a response. Integration Object Table 143. GetCampaigns Service Object Name Boundary Object Type Class (If Business Service) SocialMedia Service Business Service CSSSocialService
- 99. Siebel CRM Primary Web Services ■ GetMktgWebSurvey Data Object (Integration Object) For a description of data objects for this Web service, see Table 144. Table 144. GetCampaigns Web Service Data Object Siebel Repository Name External Name MKTG Campaign IO LeadofLeadIO Methods For a description of the methods for this Web service, see Table 145. Table 145. Get Campaigns List Web Service Methods Operation Method GetCampaigns GetCampaigns Example Package for GetCampaigns Web Service To view an example of messages 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. Request See the following file to view the sample code: ...GetCampaignsGetCampaigns_req.xml Response See the following file to view the sample code: ...GetCampaignsGetCampaigns_resp.xml Interface Description (WSDL) for GetCampaigns Web Service 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. ...GetCampaignsGetCampaigns.wsdl GetMktgWebSurvey Use this Web service to get Siebel Marketing Web surveys. Siebel CRM Web Services Reference Version 8.1/8.2 99
- 100. Siebel CRM Primary Web Services ■ GetMktgWebSurvey GetMktgWebSurvey Operations For a list of operations associated with this Web service, see Table 146. Table 146. GetMktgWebSurvey Operations Name Description GetMktgWebSurveyQueryPage This operation is used to query up a Survey Page. Request Message Description: GetMktgWebSurveyQueryPage For a description of this request message, see Table 147. Table 147. Request Message Description: GetMktgWebSurveyQueryPage Node Description Type ExecutionMode The mode in which the query is to be performed. String LOVLanguageMode The language mode from the seeded list. String NamedSearchSpec Search Specification of the query. String PickListName Name of the picklist (if any). String SiebelMessageIn An instance of the GetMktgWebSurvey Response Message Description: GetMktgWebSurveyQueryPage For a description of this response message, see Table 148. GetMktgWebSurvey 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. Siebel CRM Web Services Reference Version 8.1/8.2 100 Integration Object. Integration Object ViewMode The View Mode set for the Object (Admin, Preserve, and so on). String Table 148. Response Message Description: GetMktgWebSurveyQueryPage Node Description Type SiebelMessageOut An instance of the GetMktgWebSurvey Integration Object. Integration Object
- 101. Siebel CRM Primary Web Services ■ InvoiceSiebelCommsReqABCS Data Object (Integration Object) For a description of data objects for this Web service, see Table 149. Table 149. GetMktgWebSurvey Data Object Siebel Repository Name External Name Import Job Integration Object Import Job Integration Object. Example Package for GetMktgWebSurvey To view an example of messages 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. Interface Description (WSDL) for GetMktgWebSurvey 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. ...GetMktgWebSurveyGetMktgWebSurvey.wsdl InvoiceSiebelCommsReqABCS Use this Web service to retrieve bill, usage, event, and resource balance information for bills in a billing profile. This Web service retrieves the information from the billing application. InvoiceSiebelCommsReqABCS Operations For a list of operations associated with this Web service, see Table 150. Table 150. InvoiceSiebelCommsReqABCS Operations Name Description QueryInvoiceList Queries the invoice list for the billing profile in the Billing view. QueryInvoice Queries the invoice details for the billing profile in the Billing view. QueryResourceBalance Queries the resource balance details for the billing profile in the Billing view. SearchEventDetails Searches the event details for the billing profile view in the Billing view. QueryEventDetails Queries the event details for the billing profile view in the Billing view. Siebel CRM Web Services Reference Version 8.1/8.2 101
- 102. Siebel CRM Primary Web Services ■ InvoiceSiebelCommsReqABCS Request Message Description: QueryInvoiceList For a description of this request message, see Table 151. Table 151. Request Message Description: QueryInvoiceList Node Description Type CustomHeaderContext Optional Hierarchy QueryInvoiceReqMsg:ListOfCmuRequestBilledUsageIo Optional Integration Response Message Description: QueryInvoiceList For a description of this response message, see Table 152. Request Message Description: QueryInvoice For a description of this request message, see Table 153. Response Message Description: QueryInvoice For a description of this response message, see Table 154. Siebel CRM Web Services Reference Version 8.1/8.2 102 Object Table 152. Response Message Description: QueryInvoiceList Node Description Type QueryInvoiceRespMsg:ListOfCmuResponseBilledUsageDetailsIo Optional Integration Object FaultMsg:Fault Optional Integration Object Table 153. Request Message Description: QueryInvoice Node Description Type CustomHeaderContext Optional Hierarchy QueryInvoiceReqMsg:ListOfCmuRequestBilledUsageIo Optional Integration Object Table 154. Response Message Description: QueryInvoice Node Description Type QueryInvoiceRespMsg:ListOfCmuResponseBilledUsageDetailsIo Optional Integration Object FaultMsg:Fault Optional Integration Object
- 103. Siebel CRM Primary Web Services ■ InvoiceSiebelCommsReqABCS Request Message Description: QueryResourceBalance For a description of this request message, see Table 155. Table 155. Request Message Description: QueryResourceBalance Node Description Type CustomHeaderContext Optional Hierarchy QueryResourceBalanceReqMsg:ListOfCmuRequestCdrBalanceDetailsIo Optional Integration Response Message Description: QueryResourceBalance For a description of this response message, see Table 156. Table 156. Response Message Description: QueryResourceBalance Node Description Type QueryResourceBalanceRespMsg:ListOfCmuResponseCdrBalance DetailsIo FaultMsg:Fault Optional Integration Request Message Description: SearchEventDetails For a description of this request message, see Table 157. Table 157. Request Message Description: SearchEventDetails Node Description Type CustomHeaderContext Optional Hierarchy SearchEventDetailsReqMsg:ListOfCmuRequestCdrDetailsSearchIo Optional Integration Response Message Description: SearchEventDetails For a description of this response message, see Table 158. Object Optional Integration Object Object Object Table 158. Response Message Description: SearchEventDetails Node Description Type SearchEventDetailsRespMsg:ListOfCmuResponseCdrDetailsIo Optional Integration Object FaultMsg:Fault Optional Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 103
- 104. Siebel CRM Primary Web Services ■ InvoiceSiebelCommsReqABCS Request Message Description: QueryEventDetails For a description of this request message, see Table 159. Table 159. Request Message Description: QueryEventDetails Node Description Type CustomHeaderContext Optional Hierarchy QueryEventDetailsReqMsg:ListOfCmuRequestCdrDetailsIo Optional Integration Response Message Description: QueryEventDetails For a description of this response message, see Table 160. InvoiceSiebelCommsReqABCS 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 161. Data Object (Integration Object) For a description of data objects for this Web service, see Table 162. Siebel CRM Web Services Reference Version 8.1/8.2 104 Object Table 160. Response Message Description: QueryEventDetails Node Description Type QueryEventDetailsRespMsg:ListOfCmuResponseCdrDetailsIo Optional Integration Object FaultMsg:Fault Optional Integration Object Table 161. InvoiceSiebelCommsReqABCS Service Object Name Boundary Object Type Class (If Business Service) InvoiceSiebelCommsReqABCS Business Service CSSWSOutboundDispatcher Table 162. InvoiceSiebelCommsReqABCS Data Object Siebel Repository Name External Name CMU Response CDR Details IO Account CMU Request CDR Details IO Account CMU Request Billed Usage IO Account
- 105. Siebel CRM Primary Web Services ■ InvoiceSiebelCommsReqABCS Table 162. InvoiceSiebelCommsReqABCS Data Object Siebel Repository Name External Name CMU Response Billed Usage Details IO Account CMU Request Billing Profile IO Account CMU Response Billing Invoice IO Account CMU Response CDR Balance Details IO Account CMU Request CDR Balance Details IO Account CMU Request CDR Details Search IO Account Fault Fault Methods For a description of the methods for this Web service, see Table 163. Table 163. InvoiceSiebelCommsReqABCS Methods Operation Method QueryInvoiceList QueryInvoiceList QueryInvoice QueryInvoice QueryResourceBalance QueryResouceBalance SearchEventDetails SearchEventDetails QueryEventDetails QueryEventDetails Example Package for InvoiceSiebelCommsReqABCS To view an example of messages 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. Request See the following file to view the sample code: ...InvoiceSiebelCommsReqABCSQueryInvoice_request.xml Response See the following file to view the sample code: ...InvoiceSiebelCommsReqABCSQueryInvoice_response.xml Siebel CRM Web Services Reference Version 8.1/8.2 105
- 106. Siebel CRM Primary Web Services ■ ISS Price List Item WS Interface Description (WSDL) for InvoiceSiebelCommsReqABCS 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. ...InvoiceSiebelCommsReqABCSInvoiceSiebelReqABCSService.wsdl ISS Price List Item WS Use this Web service to add, update, and delete items in a price list in the Siebel application. The response message returns only an acknowledgement message and not data. ISS Price List Item WS Operations For a list of operations associated with this Web service, see Table 164. Table 164. ISS Price List Item WS Operations Name Description Price List Item InsertorUpdate Request Message Description: Price List Item InsertOrUpdate For a description of this request message, see Table 165. Siebel CRM Web Services Reference Version 8.1/8.2 106 Adds an item to a price list that does not already contain that item, and updates an item in a price list that already contains that item. Price List Item Insert Adds an item to a price list. Price List Item Update Updates an item in a price list. Price List Item Delete Deletes an item from a price list. Table 165. Request Message Description: Price List Item InsertOrUpdate Node Description Price List Id The ID of the price list. This node is used only to insert. Product Id The ID of the product to add to the price list. This node is used only to insert. Price List Item Id The ID of the price list item to update to the price list. This node is used only to update.
- 107. Siebel CRM Primary Web Services ■ ISS Price List Item WS Request Message Description: Price List Item Insert For a description of this request message, see Table 166. Table 166. Request Message Description: Price List Item Insert Node Description Price List Id The ID of the price list. Product Id The ID of the product to add to the price list. Request Message Description: Price List Item Update For a description of this request message, see Table 167. Table 167. Request Message Description: Price List Item Update Node Description Price List Item Id The ID of the price list item to update in the price list. Request Message Description: Price List Item Delete For a description of this request message, see Table 168. Table 168. Request Message Description: Price List Item Delete Node Description Price List Item Id The ID of the price list item to delete from the price list. ISS Price List Item WS 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 169. Table 169. ISS Price List Item WS Service Object Name Boundary Object Type Class (If Business Service) ISS Price List Item WS Business Service CSSEAIDataSyncService Siebel CRM Web Services Reference Version 8.1/8.2 107
- 108. Siebel CRM Primary Web Services ■ ISS Price List Item WS Data Object (Integration Object) For a description of data objects for this Web service, see Table 170. Table 170. ISS Price List Item WS Data Object Siebel Repository Name External Name ISS Price List Item Integration Object Admin Price List Methods For a description of methods for this Web service, see Table 171. Table 171. ISS Price List Item WS Methods Operation Method Price List Item InsertOrUpdate [BS: ISS Price List Item WS].InsertOrUpdate Price List Item Insert [BS: ISS Price List Item WS].Insert Price List Item Update [BS: ISS Price List Item WS].Update Price List Item Delete [BS: ISS Price List Item WS].Delete Example Package for ISS Price List Item WS To view an example of messages 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. Request See the following file to view the sample code: ...ISSPriceListItemISS Price List Item WS.xml Response See the following file to view the sample code: ...ISSPriceListItemWSISS Price List Item WS.xml Interface Description (WSDL) for ISS Price List Item WS 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. ...ISSPriceListItemISS Price List Item WS.wsdl Siebel CRM Web Services Reference Version 8.1/8.2 108
- 109. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Attributes ISS Web Commerce Export Attributes Use this Inbound Web service to query for attribute definitions and values that were created in Siebel Customer Order Management. ISS Web Commerce Export Attributes Operations For a list of operations associated with this Web service, see Table 172. Table 172. ISS Web Commerce Export Attributes Operations Name Description ISSWebCommerceAttributeQueryPage Queries for an attribute definition. Request Message Description: ISSWebCommerceAttributeQueryPage For a description of this request message, see Table 173. Table 173. Request Message Description: ISSWebCommerceAttributeQueryPage Node Description Type LOVLanguageMode Required. Indicates whether the value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC. String NamedSearchSpec The name of a predefined query. The predefined query is performed on the business object instance. String NewQuery The default value is False. This Boolean option indicates whether a new query is executed. If set to True, then a new query is executed clearing the cache of the integration object. String SiebelMessageIn An instance of the integration object for attribute definitions and values. Integration Object ViewMode Used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All. String Siebel CRM Web Services Reference Version 8.1/8.2 109
- 110. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Attributes Response Message Description: ISSWebCommerceAttributeQueryPage For a description of this response message, see Table 174. Table 174. Response Message Description: ISSWebCommerceAttributeQueryPage Node Description Type SiebelMessageOut An instance of the integration ISS Web Commerce Export Attributes 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 175. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 176. Methods For a description of the methods for this Web service, see Table 177. Siebel CRM Web Services Reference Version 8.1/8.2 110 object ISS Web Commerce Export Attribute used for attribute definitions and values. Integration Object Table 175. ISS Web Commerce Export Attributes Service Object Name Boundary Object Type Class ISS Web Commerce Export Attributes Business Service CSSEAIUIDataService Table 176. ISS Web Commerce Export Attribute Data Object Siebel Repository Name External Name ISS Web Commerce Export Attribute Integration Object ISS Web Commerce Export Attribute Integration Object Table 177. ISS Web Commerce Export Attribute Methods Operation Method ISSWebCommerceAttributeQueryPage QueryPage
- 111. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Class Example Package for ISS Web Commerce Export Attributes To view an example of messages 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. Request See the following file to view the sample code: ...ISSWebCommerceExportAttributesAttributeQueryRequest.xml Response See the following file to view the sample code: ...ISSWebCommerceExportAttributesAttributeQueryResponse.xml Interface Description (WSDL) for ISS Web Commerce Export Attributes 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. ...ISSWebCommerceExportAttributesISS_Web_Commerce_Export_Attributes.WSDL ISS Web Commerce Export Class Use this Inbound Web service to query for class definitions that were created in Siebel Customer Order Management. ISS Web Commerce Export Class Operations For a list of operations associated with this Web service, see Table 178. Table 178. ISS Web Commerce Export Class Operations Name Description ISSWebCommerceClassQueryPage Queries for a class. Siebel CRM Web Services Reference Version 8.1/8.2 111
- 112. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Class Request Message Description: ISSWebCommerceClassQueryPage For a description of this request message, see Table 179. Table 179. Request Message Description: ISSWebCommerceClassQueryPage Node Description Type LOVLanguageMode Required. Indicates whether the Response Message Description: ISSWebCommerceClassQueryPage For a description of this response message, see Table 180. ISS Web Commerce Export Class 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. Siebel CRM Web Services Reference Version 8.1/8.2 112 value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC. String NamedSearchSpec The name of a predefined query. The predefined query is performed on the business object instance. String NewQuery The default value is False. This Boolean option indicates whether a new query needs to be executed. If set to True, then a new query is executed clearing the cache of that particular integration object. String SiebelMessageIn An instance of the integration object for class definitions. Integration Object ViewMode Used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All. String Table 180. Response Message Description: ISSWebCommerceClassQueryPage Node Description Type SiebelMessageOut An instance of the integration object for class definitions and values. Integration Object
- 113. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Class Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 181. Table 181. ISS Web Commerce Export Class Service Object Name Boundary Object Type Class ISS Web Commerce Export Class Business service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 182 Table 182. ISS Web Commerce Export Class Data Object Siebel Repository Name External Name ISS Web Commerce Export Class Integration Object ISS Web Commerce Export Class Integration Object Methods For a description of the methods for this Web service, see Table 183 Table 183. ISS Web Commerce Export Class Methods Operation Method ISSWebCommerceClassQueryPage QueryPage Example Package for ISS Web Commerce Export Class To view an example of messages 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. Request See the following file to view the sample code: ...ISSWebCommerceExportClassClassQueryRequest.xml Response See the following file to view the sample code: ...ISSWebCommerceExportClassClassQueryResponse.xml Siebel CRM Web Services Reference Version 8.1/8.2 113
- 114. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Content Interface Description (WSDL) for ISS Web Commerce Export Class 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. ...ISSWebCommerceExportClassISS_Web_Commerce_Export_Class.WSDL ISS Web Commerce Export Content Use this Inbound Web service to query or update export content job header or line items that were created within Siebel Customer Order Management. ISS Web Commerce Export Contents Operations For a list of operations associated with this Web service, see Table 184. Table 184. ISS Web Commerce Export Contents Operations Name Description ISSWebCommerceContentQueryPage Queries for a content header or line item. ISSWebCommerceContentUpdate Updates a content header or line item. Request Message Description: ISSWebCommerceContentQueryPage For a description of this request message, see Table 185. Table 185. Request Message Description: ISSWebCommerceContentQueryPage Node Description Type LOVLanguageMode Required. Indicates whether the Siebel CRM Web Services Reference Version 8.1/8.2 114 value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC. String NamedSearchSpec The name of a predefined query. The predefined query is performed on the business object instance. String NewQuery Default is False. This Boolean option indicates whether a new query needs to be executed. If set to True, then a new query is executed flushing the cache for that particular integration object. String
- 115. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Content Table 185. Request Message Description: ISSWebCommerceContentQueryPage Node Description Type SiebelMessageIn An instance of the integration object for Content Header and Line Items. Integration Object ViewMode The ViewMode method argument is used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All. String Response Message Description: ISSWebCommerceContentQueryPage For a description of this response message, see Table 186. Table 186. Response Message Description: ISSWebCommerceContentQueryPage Node Description Type SiebelMessageOut An instance of the integration object for content header and line items. Request Message Description: ISSWebCommerceContentUpdate For a description of this request message, see Table 187. Integration Object Table 187. Request Message Description: ISSWebCommerceContentUpdate Node Description Type SiebelMessageIn An instance of the integration object for content header and line items. Integration Object Response Message Description: ISSWebCommerceContentUpdate For a description of this response message, see Table 188. Table 188. Response Message Description: ISSWebCommerceContentUpdate Node Description Type SiebelMessageOut An instance of the integration object for content header and line items. Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 115
- 116. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Content ISS Web Commerce Export Contents 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 189. Table 189. ISS Web Commerce Export Contents Service Object Name Boundary Object Type Class ISS Web Commerce Export Contents Data Object (Integration Object) For a description of the data objects for this Web service, see Table 190. Methods For a description of the methods for this Web service, see Table 191. Example Package for ISS Web Commerce Export Contents To view an example of messages 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. Request See the following file to view the sample code: ...ISSWebCommerceExportContentsContentQueryRequest.xml ...ISSWebCommerceExportContentsContentUpdateRequest.xml Siebel CRM Web Services Reference Version 8.1/8.2 116 Business Service CSSEAIUIDataService Table 190. ISS Web Commerce Export Contents Data Object Siebel Repository Name External Name ISS Web Commerce Export Contents Integration Object ISS Web Commerce Export Contents Integration Object Table 191. ISS Web Commerce Export Contents Methods Operation Method ISSWebCommerceContentQueryPage QueryPage ISSWebCommerceContentUpdate Update
- 117. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Error Response See the following file to view the sample code: ...ISSWebCommerceExportContentsContentQueryResponse.xml ...ISSWebCommerceExportContentsContentUpdateResponse.xml Interface Description (WSDL) for ISS Web Commerce Export Contents 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. ...ISSWebCommerceExportContentsISS_Web_Commerce_Export_Contents.WSDL ISS Web Commerce Export Error Use this Inbound Web service to query, update, or insert export content error messages for export job header or line items that were created within Siebel Customer Order Management. ISS Web Commerce Export Error Operations For a list of operations associated with this Web service, see Table 192. Table 192. ISS Web Commerce Export Error Operations Name Description ISSWebCommerceErrorQueryPage Queries for an export content error message. ISSWebCommerceErrorUpdate Updates an export content error message. ISSWebCommerceErrorInsert Inserts an export content error message. Request Message Description: ISSWebCommerceErrorQueryPage For a description of this request message, see Table 193. Table 193. Request Message Description: ISSWebCommerceErrorQueryPage Node Description Type LOVLanguageMode Required. Indicates whether the value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC. String NamedSearchSpec The name of a predefined query. The predefined query is performed on the business object instance. String Siebel CRM Web Services Reference Version 8.1/8.2 117
- 118. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Error Table 193. Request Message Description: ISSWebCommerceErrorQueryPage Node Description Type NewQuery Default is False. Boolean indicating Response Message Description: ISSWebCommerceErrorQueryPage For a description of this response message, see Table 194. Request Message Description: ISSWebCommerceErrorUpdate For a description of this request message, see Table 195. Siebel CRM Web Services Reference Version 8.1/8.2 118 whether a new query needs to be executed. If set to True, then a new query is executed flushing the cache for that particular integration object. String SiebelMessageIn An instance of the integration object for content error messages. Integration Object ViewMode The ViewMode method argument is used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All. String Table 194. Response Message Description: ISSWebCommerceErrorQueryPage Node Description Type SiebelMessageOut An instance of the integration object for content error messages. Integration Object Table 195. Request Message Description: ISSWebCommerceErrorUpdate Node Description Type SiebelMessageIn An instance of the integration object for content error messages. Integration Object
- 119. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Error Response Message Description: ISSWebCommerceErrorUpdate For a description of this response message, see Table 196. Table 196. Response Message Description: ISSWebCommerceErrorUpdate Node Description Type SiebelMessageOut An instance of the integration object for content error messages. Request Message Description: ISSWebCommerceErrorInsert For a description of this request message, see Table 197. Table 197. Request Message Description: ISSWebCommerceErrorInsert Node Description Type SiebelMessageIn An instance of the integration object for content error messages. Response Message Description: ISSWebCommerceErrorInsert For a description of this response message, see Table 198. Integration Object Integration Object Table 198. Response Message Description: ISSWebCommerceErrorInsert Node Description Type SiebelMessageOut An instance of the integration object for content error messages. Integration Object ISS Web Commerce Export Error 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 199. Table 199. ISS Web Commerce Export Error Service Object Name Boundary Object Type Class ISS Web Commerce Export Error Messages Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 119
- 120. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Error Data Object (Integration Object) For a description of the data objects for this Web service, see Table 200. Table 200. ISS Web Commerce Export Error Data Object Siebel Repository Name External Name ISS Web Commerce Export Error Message Integration Object Methods For a description of the methods for this Web service, see Table 201. Example Package for ISS Web Commerce Export Error To view an example of messages 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. Request See the following file to view the sample code: ...ISSWebCommerceExportErrorErrorInsertRequest.xml ...ISSWebCommerceExportErrorErrorQueryRequest.xml ...ISSWebCommerceExportErrorErrorUpdateRequest.xml Response See the following file to view the sample code: ...ISSWebCommerceExportErrorErrorInsertResponse.xml ...ISSWebCommerceExportErrorErrorQueryResponse.xml ...ISSWebCommerceExportErrorErrorUpdateResponse.xml Siebel CRM Web Services Reference Version 8.1/8.2 120 ISS Web Commerce Export Error Message Integration Object Table 201. ISS Web Commerce Export Error Methods Operation Method ISSWebCommerceErrorQueryPage QueryPage ISSWebCommerceErrorUpdate Update ISSWebCommerceErrorInsert Insert
- 121. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Price Lists Interface Description (WSDL) for ISS Web Commerce Export Error 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. ...ISSWebCommerceExportErrorISS_Web_Commerce_Export_Errors.WSDL ISS Web Commerce Export Price Lists Use this Inbound Web service to query for price lists that were created within Siebel Customer Order Management. ISS Web Commerce Export Price Lists Operations For a list of operations associated with this Web service, see Table 202. Table 202. ISS Web Commerce Export Price Lists Operations Name Description ISSWebCommercePriceListQueryPage Queries for a price list and price list item. Request Message Description: ISSWebCommercePriceListQueryPage For a description of this request message, see Table 203. Table 203. Request Message Description: ISSWebCommercePriceListQueryPage Node Description Type LOVLanguageMode Required. Indicates whether the value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC. String NamedSearchSpec The name of a predefined query. The predefined query is performed on the business object instance. String NewQuery Default is False. Boolean indicating whether a new query needs to be executed. If set to True, then a new query is executed flushing the cache for that particular integration object. String Siebel CRM Web Services Reference Version 8.1/8.2 121
- 122. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Price Lists Table 203. Request Message Description: ISSWebCommercePriceListQueryPage Node Description Type SiebelMessageIn An instance of the integration Response Message Description: ISSWebCommercePriceListQueryPage For a description of this response message, see Table 204. ISS Web Commerce Export Price Lists 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 205. Siebel CRM Web Services Reference Version 8.1/8.2 122 object for Price List and Price List Items. Integration Object ViewMode The ViewMode method argument is used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All. String Table 204. Response Message Description: ISSWebCommercePriceListQueryPage Node Description Type SiebelMessageOut An instance of the integration object for price list and price list items. Integration Object Table 205. ISS Web Commerce Export Price Lists Service Object Name Boundary Object Type Class ISS Web Commerce Export Price Lists Business Service CSSEAIUIDataService
- 123. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Price Lists Data Object (Integration Object) For a description of the data objects for this Web service, see Table 206. Table 206. ISS Web Commerce Export Price Lists Data Object Siebel Repository Name External Name ISS Web Commerce Export Price List Integration Object ISS Web Commerce Export Price List Integration Object Methods For a description of the methods for this Web service, see Table 207. Table 207. ISS Web Commerce Export Price Lists Methods Operation Method ISSWebCommercePriceListQueryPage QueryPage Example Package for ISS Web Commerce Export Price Lists To view an example of messages 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. Request See the following file to view the sample code: ...ISSWebCommerceExportPriceListsPriceListQueryRequest.xml Response See the following file to view the sample code: ...ISSWebCommerceExportPriceListsPriceListQueryResponse.xml Interface Description (WSDL) for ISS Web Commerce Export Price Lists 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. ...ISSWebCommerceExportPriceListsISS_Web_Commerce_Export_Price_Lists.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 123
- 124. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Recommended Products ISS Web Commerce Export Recommended Products Use this Inbound Web service to query for recommended products that were created in Siebel Customer Order Management. ISS Web Commerce Export Recommended Products Operations For a list of operations associated with this Web service, see Table 208. Table 208. ISS Web Commerce Export Recommended Products Operations Name Description ISSWebCommerceRecommendedProductQueryPage Queries for a recommended product. Request Message Description: ISSWebCommerceRecommendedProductQueryPage For a description of this request message, see Table 209. Table 209. Request Message Description: ISSWebCommerceRecommendedProductQueryPage Node Description Type LOVLanguageMode Required. Indicates whether the Siebel CRM Web Services Reference Version 8.1/8.2 124 value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC. String NamedSearchSpec The name of a predefined query. The predefined query is performed on the business object instance. String NewQuery Default is False. Boolean indicating whether a new query needs to be executed. If set to True, then a new query is executed flushing the cache for that particular integration object. String
- 125. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Recommended Products Table 209. Request Message Description: ISSWebCommerceRecommendedProductQueryPage Node Description Type SiebelMessageIn An instance of the integration object for Price List and Price List Items. Integration Object ViewMode The ViewMode method argument is used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All. String Response Message Description: ISSWebCommerceRecommendedProductQueryPage For a description of this response message, see Table 210. Table 210. Response Message Description: ISSWebCommerceRecommendedProductQueryPage Node Description Type SiebelMessageOut An instance of the integration object for Recommended Product. Integration Object ISS Web Commerce Export Recommended Products 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 211. Table 211. ISS Web Commerce Export Recommended Products Service Object Name Boundary Object Type Class ISS Web Commerce Export Recommended Products Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 125
- 126. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Recommended Products Data Object (Integration Object) For a description of the data objects for this Web service, see Table 212. Table 212. ISS Web Commerce Export Recommended Products Data Object Siebel Repository Name External Name ISS Web Commerce Export Recommended Product Integration Object Methods For a description of the methods for this Web service, see Table 213. Example Package for ISS Web Commerce Export Recommended Products To view an example of messages 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. Request See the following file to view the sample code: ...ISSWebCommerceExportRecommendedProductsRecommendedProductsQueryRequest.xml Response See the following file to view the sample code: ...ISSWebCommerceExportRecommendedProductsRecommendedProductsQueryResponse.xml Interface Description (WSDL) for ISS Web Commerce Export Recommended Products 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. ...ISSWebCommerceExportRecommendedProductsISS_Web_Commerce_Export_Recommended_Produc ts.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 126 ISS Web Commerce Export Recommended Product Integration Object Table 213. ISS Web Commerce Export Recommended Products Methods Operation Method ISSWebCommerceRecommendedProductQueryPage QueryPage
- 127. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Volume Discounts ISS Web Commerce Export Volume Discounts Use this Inbound Web service to query for volume discounts and volume discount items that were created within Siebel Customer Order Management. ISS Web Commerce Export Volume Discounts Operations For a list of operations associated with this Web service, see Table 214. Table 214. ISS Web Commerce Export Volume Discounts Operations Name Description ISSWebCommerceVolumeDiscountQueryPage Query for a volume discount or volume discount item Request Message Description: ISSWebCommerceVolumeDiscountQueryPage For a description of this request message, see Table 215. Table 215. Request Message Description: ISSWebCommerceVolumeDiscountQueryPage Node Description Type LOVLanguageMode Required. Indicates whether the value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC. String NamedSearchSpec The name of a predefined query. The predefined query is performed on the business object instance. String NewQuery Default is False. Boolean indicating whether a new query needs to be executed. If set to True, then a new query is executed flushing the cache for that particular integration object. String Siebel CRM Web Services Reference Version 8.1/8.2 127
- 128. Siebel CRM Primary Web Services ■ ISS Web Commerce Export Volume Discounts Table 215. Request Message Description: ISSWebCommerceVolumeDiscountQueryPage Node Description Type SiebelMessageIn An instance of the integration Response Message Description: ISSWebCommerceVolumeDiscountQueryPage For a description of this response message, see Table 216. ISS Web Commerce Export Volume Discounts 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 217. Siebel CRM Web Services Reference Version 8.1/8.2 128 object for Price List and Price List Items. Integration Object ViewMode The ViewMode method argument is used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All. String Table 216. Response Message Description: ISSWebCommerceVolumeDiscountQueryPage Node Description Type SiebelMessageOut An instance of the integration object for Volume Discount and Volume Discount Item. Integration Object Table 217. ISS Web Commerce Export Volume Discounts Service Object Name Boundary Object Type Class ISS Web Commerce Export Volume Discounts Business Service CSSEAIUIDataService
- 129. Siebel CRM Primary Web Services ■ LeadProcessingService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 218. Table 218. ISS Web Commerce Export Volume Discounts Data Object Siebel Repository Name External Name ISS Web Commerce Export Volume Discount Integration Object ISS Web Commerce Export Volume Discount Integration Object Methods For a description of the methods for this Web service, see Table 219. Table 219. ISS Web Commerce Export Volume Discounts Methods Operation Method ISSWebCommerceVolumeDiscountQueryPage QueryPage Example Package for ISS Web Commerce Export Volume Discounts To view an example of messages 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. Request See the following file to view the sample code: ...ISSWebCommerceExportVolumneDiscountsVolumeDiscountQueryRequest.xml Response See the following file to view the sample code: ...ISSWebCommerceExportVolumneDiscountsVolumeDiscountQueryResponse.xml Interface Description (WSDL) for ISS Web Commerce Export Volume Discounts 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. ...ISSWebCommerceExportVolumneDiscountsISS_Web_Commerce_Export_Volume_Discounts.WSDL LeadProcessingService This service contains the basic operations for processing leads, including assigning, querying, scoring and data cleansing. Siebel CRM Web Services Reference Version 8.1/8.2 129
- 130. Siebel CRM Primary Web Services ■ LeadProcessingService Lead Processing Service Operations For a list of operations associated with this Web service, see Table 220. Table 220. Lead Processing Service Operations Name Description LeadProcessingServiceAssignLeads Used to assign leads to sales representatives. LeadProcessingServiceDataCleansing Used for data cleansing of marketing data. LeadProcessingServiceGetLeads Queries for leads. LeadProcessingServiceScoreLeads Scores leads based on defined characteristics. Request Message Description: LeadProcessingServiceAssignLeads This method is used to assign leads. It accepts the input parameters in a property set. For a description of this request message, see Table 221. Table 221. Request Message Description: LeadProcessingServiceAssignLeads Node Description Type Execution Order Required. Parameter to be passed to the Business Rules Response Message Description: LeadProcessingServiceAssignLeads For a description of this response message, see Table 222. Siebel CRM Web Services Reference Version 8.1/8.2 130 Workflow. String Search Specification Required. The input search criteria to search on the Lead business component. String Table 222. Response Message Description: LeadProcessingServiceAssignLeads Node Description Type Error Message Error code values are OK or NOTOK. String Process Instance Id This is the Business Rules Workflow process ID. String Success Flag Values are Yes or No based on whether the lead assignment was successfully created. String
- 131. Siebel CRM Primary Web Services ■ LeadProcessingService Request Message Description: LeadProcessingServiceDataCleansing This method calls the Data Cleansing business service to cleanup a property set. For a description of this request message, see Table 223. Table 223. Request Message Description: LeadProcessingServiceDataCleansing Node Description Type Business Component Required. Business component to be passed to data cleansing service. Business Object Required. Business object from which the business component instance is obtained. Search Specification Required. Search specification to query the business component and get the values in activated fields. Response Message Description: LeadProcessingServiceDataCleansing For a description of this request message, see Table 224. String String String Table 224. Response Message Description: LeadProcessingServiceDataCleansing Node Description Type Error Message Error code values are OK or NOTOK. String Success Flag Values are Yes or No based on whether the lead assignment was successfully created. String Request Message Description: LeadProcessingServiceGetLeads This method is used to get leads based on the input criteria. For a description of this request message, see Table 225. Table 225. Request Message Description: LeadProcessingServiceGetLeads Node Description Type Search Specification Required. The input search criteria to search on Lead business component. Response Message Description: LeadProcessingServiceGetLeads For a description of this response message, see Table 226. String Table 226. Response Message Description: LeadProcessingServiceGetLeads Node Description Type SiebelMessage Required. Has Lead ID and description of the leads. Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 131
- 132. Siebel CRM Primary Web Services ■ LeadProcessingService Request Message Description: LeadProcessingServiceScoreLeads This method is used to score leads. It accepts the input parameters in a property set. For a description of this request message, see Table 227. Table 227. Request Message Description: LeadProcessingServiceScoreLeads Node Description Type Execution Order Required. Parameter to be passed to Business Response Message Description: LeadProcessingServiceScoreLeads For a description of this response message, see Table 228. LeadProcessingService 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 229. Data Object (Integration Object) For a description of data objects for this Web service, see Table 230. Siebel CRM Web Services Reference Version 8.1/8.2 132 Rules workflow. String Table 228. Response Message Description: LeadProcessingServiceScoreLeads Node Description Type Error Message Error code values are OK or NOTOK. String Process Instance Id This is the Business Rules workflow process ID. String Success Flag Values are Yes or No based on whether the lead assignment was successfully created. String Table 229. LeadProcessingService Service Object Name Boundary Object Type Business Rules Workflow WorkFlow Data Cleansing Business Service Table 230. LeadProcessingService Data Object Siebel Repository Name External Name Lead Integration Object Lead
- 133. Siebel CRM Primary Web Services ■ LeadProcessingService Example Package for Lead Processing Service To view an example of messages 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. Request (LeadProcessingServiceAssignLeads) See the following file to view the sample code: ...LeadProcessingServiceLeadProcessingService_AssignLeads_request.xml Response (LeadProcessingServiceAssignLeads) See the following file to view the sample code: ...LeadProcessingServiceLeadProcessingService_AssignLeads_request.xml Request (LeadProcessingServiceDataCleansing) See the following file to view the sample code: ...LeadProcessingServiceLeadProcessingService_ScoreLeads_request.xml Response(LeadProcessingServiceDataCleansing) See the following file to view the sample code: ...LeadProcessingServiceLeadProcessingService_ScoreLeads_request.xml Request (LeadProcessingServiceGetLeads) See the following file to view the sample code: ...LeadProcessingServiceLeadProcessingService_ScoreLeads_request.xml Response (LeadProcessingServiceGetLeads) See the following file to view the sample code: ...LeadProcessingServiceLeadProcessingService_ScoreLeads_request.xml Request (LeadProcessingServiceScoreLeads) See the following file to view the sample code: ...LeadProcessingServiceLeadProcessingService_ScoreLeads_request.xml Response (LeadProcessingServiceScoreLeads) See the following file to view the sample code: ...LeadProcessingServiceLeadProcessingService_ScoreLeads_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 133
- 134. Siebel CRM Primary Web Services ■ LeadService Interface Description (WSDL) for Lead Processing Service 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. ...LeadProcessingServiceLeadProcessing.wsdl LeadService Use this Web service to perform basic operations on the Lead entity, such create, update, convert, retire and reject leads. LeadService Operations For a list of operations associated with this Web service, see Table 231. Table 231. LeadService Operations Name Description LeadServiceRetireLead Retires a lead. LeadServiceCreateLead Creates a lead. LeadServiceRejectLead Rejects a lead. LeadServiceResponseToLead Converts response to leads. LeadServiceConvertLeadToOpty Converts lead to an opportunity. LeadServiceUpdateLead Updates a lead. Request Message Description: LeadServiceRetireLead This method is used to assign leads. It accepts the input parameters in a property set. For a description of this request message, see Table 232. Table 232. Request Message Description: LeadServiceRetireLead Node Description Type LeadId Required. The ID of the lead to be retired. String ReasonCode Required The reason code for retiring the lead. String Comments Comments for retiring (if any). String Siebel CRM Web Services Reference Version 8.1/8.2 134
- 135. Siebel CRM Primary Web Services ■ LeadService Response Message Description: LeadServiceRetireLead For a description of this response message, see Table 233. Table 233. Response Message Description: LeadServiceRetireLead Node Description Type ReturnVal Error code values are OK or NOTOK. String Request Message Description: LeadServiceCreateLead For a description of this request message, see Table 234. Table 234. Request Message Description: LeadServiceCreateLead Node Description Type Lead IO Required. An instance of the integration object Lead IO. Integration Object Response Message Description: LeadServiceCreateLead For a description of this response message, see Table 235. Table 235. Response Message Description: LeadServiceCreateLead Node Description Type Error Message Error message (if any). String Success Flag Y or N. String Lead Id ID of the lead generated as a result of the lead creation. String Request Message Description: LeadServiceRejectLead This method is used to reject a lead. The lead ID is retained, along with a reject comments code, a reject reason code. Optionally an owner ID can be passed to whom the lead will be assigned. For a description of this request message, see Table 236. Table 236. Request Message Description: LeadServiceRejectLead Node Description Type LeadId Required. The ID of the lead to be rejected. String OwnerId Optional. String ReasonCode Reason code for rejecting the lead. String Comments Comments (if any). String Siebel CRM Web Services Reference Version 8.1/8.2 135
- 136. Siebel CRM Primary Web Services ■ LeadService Response Message Description: LeadServiceRejectLead For a description of this response message, see Table 237. Table 237. Response Message Description: LeadServiceRejectLead Node Description Type ReturnVal Error code values are OK or NOTOK. String Request Message Description: LeadServiceResponseToLead For a description of this request message, see Table 238. Table 238. Request Message Description: LeadServiceResponseToLead Node Description Type Response Id Required. The ID of the response to be converted to lead. String Response Message Description: LeadServiceResponseToLead For a description of this response message, see Table 239. Table 239. Response Message Description: LeadServiceResponseToLead Node Description Type Error Message Error message (if any). String Success Flag Y or N. String Lead Id The ID of the lead created from the response. String Request Message Description: LeadServiceConvertLeadToOpty For a description of this request message, see Table 240. Table 240. Request Message Description: LeadServiceConvertLeadToOpty Node Description Type LeadId Required. The ID of the lead to be converted. String Contact Id The contact ID of the lead. String Account Id The account ID of the lead. String Siebel CRM Web Services Reference Version 8.1/8.2 136
- 137. Siebel CRM Primary Web Services ■ LeadService Response Message Description: LeadServiceConvertLeadToOpty For a description of this response message, see Table 241. Table 241. Response Message Description: LeadServiceConvertLeadToOpty Node Description Type Error Message Error message (if any). String Success Flag Y or N. String Opty Id The ID of the opportunity created. String Request Message Description: LeadServiceUpdateLead This method is used to update leads. It accepts input parameters in a property set. For a description of this request message, see Table 242. Table 242. Request Message Description: LeadServiceUpdateLead Node Description Type Lead IO Required. An instance of the integration object Lead IO. Integration Object Response Message Description: LeadServiceUpdateLead For a description of this response message, see Table 243. Table 243. Response Message Description: LeadServiceUpdateLead Node Description Type Error Message Error message (if any). String Success Flag Y or N. String LeadService 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 244. Table 244. LeadService Service Object Name Boundary Object Type Response To Lead Conversion Workflow Lead To Opty Conversion Workflow Siebel CRM Web Services Reference Version 8.1/8.2 137
- 138. Siebel CRM Primary Web Services ■ LeadService Data Object (Integration Object) For a description of data objects for this Web service, see Table 245. Table 245. LeadService Data object Siebel Repository Name External Name Lead IO Lead Example Package for LeadService To view an example of messages 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. Request (LeadServiceRetireLead) See the following file to view the sample code: ...LeadServiceLeadService_RetireLead_request.xml Response (LeadServiceRetireLead) See the following file to view the sample code: ...LeadServiceLeadService_RetireLead_response.xml Request (LeadServiceCreateLead) See the following file to view the sample code: ...LeadServiceLeadService_CreateLead_request.xml Response (LeadServiceCreateLead) See the following file to view the sample code: ...LeadServiceLeadService_CreateLead_response.xml Request (LeadServiceRejectLead) See the following file to view the sample code: ...LeadServiceLeadService_RejectLead_request.xml Response(LeadServiceRejectLead) See the following file to view the sample code: ...LeadServiceLeadService_RejectLead_response.xml Siebel CRM Web Services Reference Version 8.1/8.2 138
- 139. Siebel CRM Primary Web Services ■ List Request (LeadServiceResponseToLead) See the following file to view the sample code: ...LeadServiceLeadService_ResponseToLead_request.xml Response (LeadServiceResponseToLead) See the following file to view the sample code: ...LeadServiceLeadService_ResponseToLead_response.xml Request (LeadServiceConvertLeadToOpty) See the following file to view the sample code: ...LeadServiceLeadService_ConvertToOpty_request.xml Response (LeadServiceConvertLeadToOpty) See the following file to view the sample code: ...LeadServiceLeadService_ConvertToOpty_response.xml Request (LeadServiceUpdateLead) See the following file to view the sample code: ...LeadServiceLeadService_UpdateLead_request.xml Response (LeadServiceUpdateLead) See the following file to view the sample code: ...LeadServiceLeadService_UpdateLead_response.xml Interface Description (WSDL) for LeadService 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. ...LeadServiceLead.wsdl List Use this Web service for the basic operations for processing lists. Siebel CRM Web Services Reference Version 8.1/8.2 139
- 140. Siebel CRM Primary Web Services ■ List List Operations For a list of operations associated with this Web service, see Table 246. Table 246. List Operations Name Description ListCreateList Creates a list. ListExportList Exports a list. Request Message Description: ListCreateList This method is used to create a list. It accepts the input parameters as a property set. For a description of this request message, see Table 247. Table 247. Request Message Description: ListCreateList Node Description Type List IO Required. An instance of the integration object List IO. Integration Object Response Message Description: ListCreateList For a description of this response message, see Table 248. Table 248. Response Message Description: ListCreateList Node Description Type List Id List ID of the list created. String Error Message Error message if any. String Success Flag Y or N. String Request Message Description: ListExportList This method is used to export lists. It accepts the input parameters as a property set. For a description of this request message, see Table 249. Table 249. Request Message Description: ListExportList Node Description Type Business Component The Business component whose records need to be exported. String Business Object The business object containing the business component. String Export Format The format (xml, or CSV) based on which the filename or Siebel CRM Web Services Reference Version 8.1/8.2 140 filenames are to be created. String Search Specification The search specification for the records on the business component (if the records satisfying a condition are only to be picked). String
- 141. Siebel CRM Primary Web Services ■ List List 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 250. Table 250. List Service Object Name Boundary Object Type EAI XML Write to File Business Service Data Object (Integration Object) For a description of data objects for this Web service, see Table 251. Table 251. List Data Object Siebel Repository Name External Name List IO List IO Example Package for List To view an example of messages 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. Request (ListCreateList) See the following file to view the sample code: ...ListListCreate_request.xml Response (ListCreateList) See the following file to view the sample code: ...ListListCreate_response.xml Request (ListExportList) See the following file to view the sample code: ...ListListExport_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 141
- 142. Siebel CRM Primary Web Services ■ ListMgmtProspect Interface Description (WSDL) for List 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. ...ListList.wsdl ListMgmtProspect Use this Web service for the basic operations in Siebel Marketing such as to create and update prospect. ListMgmtProspect Operations For a list of operations associated with this Web service, see Table 252. Table 252. ListMgmtProspect Operations Name Description ListMgmtProspectCreateProspect Creates a Prospect. ListMgmtProspectUpdateProspect Updates a Prospect. Request Message Description: ListMgmtProspectCreateProspect This method takes in an integration object called Prospect IO and returns the Prospect ID and Success Flag. For a description of this request message, see Table 253. Table 253. Request Message Description: ListMgmtProspectCreateProspect Node Description Type Prospect IO Required input parameter. Integration Object Response Message Description: ListMgmtProspectCreateProspect For a description of this response message, see Table 254. Table 254. Response Message Description: ListMgmtProspectCreateProspect Node Description Type Prospect Id Unique ID of the prospect created. String Error Message Error message, if any. String Success Flag Y or N. String Siebel CRM Web Services Reference Version 8.1/8.2 142
- 143. Siebel CRM Primary Web Services ■ ListMgmtProspect Request Message Description: ListMgmtProspectUpdateProspect This method updates a prospect. For a description of this request message, see Table 255. Table 255. Request Message Description: ListMgmtProspectUpdateProspect Node Description Type Prospect IO Required input parameter. Integration Object Response Message Description: ListMgmtProspectUpdateProspect For a description of this response message, see Table 256. Table 256. Response Message Description: ListMgmtProspectUpdateProspect Node Description Type Error Message Error message, if any. String Success Flag Y or N. String Example Package for ListMgmtProspect To view an example of messages 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. Request (ListMgmtProspectCreate) See the following file to view the sample code: ...ListMgmtProspectListMgmtProspectCreate_request.xml Response (ListMgmtProspectCreate) See the following file to view the sample code: ...ListMgmtProspectListMgmtProspectCreate_request.xml Request (ListMgmtProspectUpdate) See the following file to view the sample code: ...ListMgmtProspectListMgmtProspectUpdate_request.xml Response (ListMgmtProspectUpdate) See the following file to view the sample code: ...ListMgmtProspectListMgmtProspectUpdate_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 143
- 144. Siebel CRM Primary Web Services ■ LoyaltyAccrualService Interface Description (WSDL) for ListMgmtProspect 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. ...ListMgmtProspectListMgmtProspect.wsdl LoyaltyAccrualService Use this Web service with Siebel Loyalty to perform operations on orders, including processing, importing from an external file, importing transactions, and exporting promotions. LoyaltyAccrualService Operations For a list of operations associated with this Web service, see Table 257. Table 257. LoyaltyAccrualService Operations Name Description ProcessExternalOrder Process all the transactions with the given order number. ImportExternalOrderTxn Imports the transactions from an external file, assigns the given Request Message Description: ProcessExternalOrder For a description of this request message, see Table 258. Siebel CRM Web Services Reference Version 8.1/8.2 144 order number to the files, and processes all the transactions. ProcessExternalOrderTxn Imports the transactions from given input, stamps the transaction with an order number, and processes all the transactions. The request mode can be either Process, or Simulate. ProcessSocialActionTxn Captures customers' social actions (such as checkins, Tweets, shares and so on) and processes their rewards in Siebel Loyalty. This operation automatically creates a new transaction for a referral reward based on the referee's purchase transaction. Rewards are on a one-time and recurring basis. ExportPromotions Exports the promotion of given program. CancelOrder Cancels all the transactions in a given order. Table 258. Request Message Description: ProcessExternalOrder Node Description Type Order Number – Number The number of transactions this order number will be processed. Number
- 145. Siebel CRM Primary Web Services ■ LoyaltyAccrualService Response Message Description: ProcessExternalOrder For a description of this response message, see Table 259. Table 259. Response Message Description: ProcessExternalOrder Node Description Type Total Points Total number of points for a given order. Number Request Message Description: ImportExternalOrderTxn For a description of this request message, see Table 260. Table 260. Request Message Description: ImportExternalOrderTxn Node Description Type File Name File name that contains the transactions. String. Response Message Description: ImportExternalOrderTxn For a description of this response message, see Table 261. Table 261. Response Message Description: ImportExternalOrderTxn Node Description Type Total Points Total number of points for a given order. Number Siebel Message Siebel Message of transactions. Hierarchy Request Message Description: ProcessExternalOrderTxn Imports the transactions from an external file, assigns the given order number to the files, and processes all the transactions. The Request Mode can be either Process or Simulate. For a description of this request message, see Table 262. Table 262. Request Message Description: ProcessExternalOrderTxn Node Description Type Order Number Order Number to be stamped to the saved transactions. Number Total Lines Total number of transactions in the Input. Number Request Mode Possible modes are Process or Simulate. String LOY EAI Transactions Transactions in integration object format. Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 145
- 146. Siebel CRM Primary Web Services ■ LoyaltyAccrualService Response Message Description: ProcessExternalOrderTxn For a description of this response message, see Table 263. Table 263. Response Message Description: ProcessExternalOrderTxn Node Description Type Total Points – Number Total number of points for the given order. Number Return Value – String Possible values are Failure, or Success. String Siebel Message – Hierarchy Siebel message of transactions. Hierarchy Request Message Description: ProcessSocialActionTxn For a description of this request message, see Table 264. Table 264. Request Message Description: ProcessSocialActionTxn Node Description Type SiebelMessage One or more transactions in integration object Response Message Description: ProcessSocialActionTxn For a description of this response message, see Table 265. Request Message Description: ExportPromotions Exports the promotion of given program. For a description of this request message, see Table 266. Siebel CRM Web Services Reference Version 8.1/8.2 146 format. Integration Object Table 265. Response Message Description: ProcessSocialActionTxn Node Description Type ErrorArgs Error message of each transaction. Hierarchy Siebel Message – Hierarchy Processing information of transactions in the LOY EAI Transaction integration object format. Hierarchy Table 266. Request Message Description: ExportPromotions Node Description Type Activity Date Date needs to be between the start and end date of the promotion. String Export Flag Export flag can be Y or N. String Program Name Program name to which the user must export the promotions. String
- 147. Siebel CRM Primary Web Services ■ LoyaltyAccrualService Response Message Description: ExportPromotions For a description of this response message, see Table 267. Table 267. Response Message Description: ExportPromotions Node Description Type Siebel Message All the promotions in LOY EAI Promotion integration object format. Request Message Description: CancelOrder For a description of this request message, see Table 268. Table 268. Request Message Description: ExportPromotions Node Description Type LOY Cancel Order An instance of the integration object LOY Cancel Order Transaction Transaction. Order Number The order number of the order to be cancelled. Number. Response Message Description: CancelOrder For a description of this response message, see Table 269. Integration Object. Integration Object Table 269. Response Message Description: ExportPromtions Node Description Type LOY Cancel Order An instance of the integration object LOY Cancel Transaction Order Transaction. Integration Object Order Number The order number of the order to be cancelled. Number. Example of Package for LoyaltyAccrualService To view an example of messages for this Web service, navigate to the documentation library for Siebel Business Applications on the Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Then extract the files in the zip file. Request See the following file to view the sample code: ...LoyaltyAccrualServiceProcessExternalOrder_request.xml ...LoyaltyAccrualServiceProcessExternalOrderTxn_request.xml ...LoyaltyAccrualServiceRequestMode_Simulate_request.xml ...LoyaltyAccrualServiceProcessExternalOrderTxn_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 147
- 148. Siebel CRM Primary Web Services ■ LoyaltyBatchEnrollment ...LoyaltyAccrualServiceExportPromotions_request.xml Response See the following file to view the sample code: ...LoyaltyAccrualServiceProcessExternalOrder_response.xml ...LoyaltyAccrualServiceProcessExternalOrderTxn_response.xml ...LoyaltyAccrualServiceRequestMode_Simulate_response.xml ...LoyaltyAccrualServiceProcessExternalOrderTxn_response.xml ...LoyaltyAccrualServiceExportPromotions_response.xml Interface Description (WSDL) for LoyaltyAccrualService 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. WSDL (ProcessExternalOrder) ...LoyaltyAccrualServiceProcessExternalOrder.wsdl WSDL (ImportExternalOrderTxn) ...LoyaltyAccrualServiceImportExternalOrderTxn.wsdl WSDL (ProcessExternalOrderTxn) ...LoyaltyAccrualServiceProcessExternalOrderTxn.wsdl WSDL (ExportPromotions) ...LoyaltyAccrualServiceExportPromotions.wsdl LoyaltyBatchEnrollment Use this Web service with the Siebel Loyalty Application to perform the following operations for a member: ■ Enrolling a member into the selected Loyalty Program ■ Updating member data ■ Enrollment Payment processing for the selected member ■ Generating specified number of pre-allotted memberships into the selected Loyalty Program. Siebel CRM Web Services Reference Version 8.1/8.2 148
- 149. Siebel CRM Primary Web Services ■ LoyaltyBatchEnrollment LoyaltyBatchEnrollment Operations For a list of operations associated with this Web service, see Table 270. Table 270. LoyaltyBatchEnrollment Operations Name Description MemberEnrollment Enrolls a member into the specified loyalty program and returns the generated Member number, along with the Simulated prices for enrollment, if any. In case of any error, it sends the member data along with the error message or messages. If the Enrollment entails a payment, then this Web service method enrolls the member into Payment Pending status. If there is no Payment required, then the member directly goes into the Active status. MemberUpdate Used to update member details. If there is payment involved with the membership scheme, and if the membership is designated as Pre-Allotted, then this Web service updates the member details and returns the list of simulated prices along with the list of error messages occurred during the member update. EnrollmentPaymentProcessing Used to process the enrollment payment for the selected member, who is in the Payment Pending status. If the payment processing is successful, then the member status becomes Active, otherwise the status will remain in Payment Pending. This Web service returns the list of error messages occurred during the payment processing. GeneratePreallottedMemberships Used to generate the specified number of membership numbers for the given Loyalty program. The status of all these memberships. EnrolContactAsMember Creates a Loyalty membership from an existing Siebel contact from social networks. You can also view membership details and contact details that were captured from the attributes of the social profile. Siebel CRM Web Services Reference Version 8.1/8.2 149
- 150. Siebel CRM Primary Web Services ■ LoyaltyBatchEnrollment Request Message Description: MemberEnrollment For a description of this request message, see Table 271. Table 271. Request Message Description: MemberEnrollment Node Description Type Siebel Message Response Message Description: MemberEnrollment For a description of this response message, see Table 272. Siebel CRM Web Services Reference Version 8.1/8.2 150 Hierarchy of the Member details. Uses the integration object LOY Member. Required Input: ■ Action Type must be Enrollment. ■ Program Id. ■ Membership Scheme Id. ■ Member Type. ■ Contact Details. ■ Account, Household details based on the member type. Hierarchy (Integration Object : LOY Member). Table 272. Response Message Description: MemberEnrollment Node Description Type Siebel Message Hierarchy of the Member details. If there is any error in the processing of the member details, then the property set returns the entire member details along with the error messages. If the member is created successfully and payment is involved for the membership scheme, then the property set contains the enrolment simulated price lists. Hierarchy (Integration Object : LOY Member).
- 151. Siebel CRM Primary Web Services ■ LoyaltyBatchEnrollment Request Message Description: MemberUpdate For a description of this request message, see Table 273. Table 273. Request Message Description: MemberUpdate Node Description Type Siebel Message Hierarchy of the Member details. Uses the integration object LOY Member. Required Input: ■ Action type must be ‘Update’. ■ Member Number. Response Message Description: MemberUpdate For a description of this response message, see Table 274. Table 274. Response Message Description: MemberUpdate Node Description Type Siebel Message Hierarchy of the Member details. If there is any error in the processing of the member details, then the property set returns the entire member details along with the error messages. If the member has a status of Prealloted and the supplied membership scheme has payment, then the property set contains the enrolment simulated price lists. Request Message Description: EnrolmentPaymentProcessing For a description of this request message, see Table 275. Hierarchy (Integration Object : LOY Member) Hierarchy Table 275. Request Message Description: EnrolmentPaymentProcessing Node Description Type Member Number Member number. String Credit Card Number Credit card number. String Card Holder Name Name of the credit card holder. String Credit Card Type Credit Card Type such as Visa, MasterCard, and so on. String Expiration Month Expiration Month of the credit card. String Expiration Year Expiration year of the credit card. String CVV Number CVV number of the credit card. String Billing Address Primary billing address of the member. String Billing Address2 Secondary billing address of the member. String Siebel CRM Web Services Reference Version 8.1/8.2 151
- 152. Siebel CRM Primary Web Services ■ LoyaltyBatchEnrollment Table 275. Request Message Description: EnrolmentPaymentProcessing Node Description Type Billing City Billing address city. String Billing State Billing address state. String Billing Country Billing address country. String Billing ZIP Code Billing address ZIP code. String Amount Simulated Amount. Number Base Pay Base price of the membership plan. Number Currency Code Currency Code. String Response Message Description: EnrolmentPaymentProcessing For a description of this response message, see Table 276. Table 276. Response Message Description: EnrolmentPaymentProcessing Node Description Type MemberNumber Member Number. String Status Status of the Member. String Payment Errors The list of error messages occurred during the Request Message Description: GeneratePreAllottedMemberships For a description of this request message, see Table 277. Response Message Description: GeneratePreAllottedMemberships For a description of this response message, see Table 278. Siebel CRM Web Services Reference Version 8.1/8.2 152 enrolment payment processing. Hierarchy (Integration Object: LOY ENR Payment Errors) Table 277. Request Message Description: GeneratePreAllottedMemberships Node Description Type Program Id Program ID. String Number of Members The total number of pre-allotted memberships to be generated. Number Table 278. Response Message Description: GeneratePreAllottedMemberships Node Description Type MemberNumbers The hierarchy of the list of membership numbers generated in Pre-allotted status. Hierarchy (Integration Object: LOY Preallotted Member)
- 153. Siebel CRM Primary Web Services ■ LoyaltyBatchEnrollment Request Message Description: EnrolContactAsMember For a description of this request message, see Table 279. Table 279. Request Message Description: EnrolContactAsMember Node Description Type Account Id Optional. The ID of the account being enrolled. String Accrual Type Optional. The accrual type. String Contact Id Required. The primary contact ID of the member being enrolled. Enrollment Channel Optional. The enrollment channel. Valid values are drawn from the LOV LOY_TXN_CHNNL_CD table. Household Id Optional. The existing household ID. String Member Type Optional. The member type. String Membership Scheme Id Optional. Membership plan corresponding to the member type. Name Optional. The member name. String Program Id Optional. The existing program to which the member should be enrolled. Referred By Id Optional. The existing Referred by Member ID. String Response Message Description: EnrolContactAsMember For a description of this response message, see Table 280. String String String String Table 280. Response Message Description: EnrolContactAsMember Node Description Type Siebel Message Hierarchy of the Contact Member details. Uses the integration object LOY Member. Integration Object Example Package for LoyaltyBatchEnrollment To view an example of messages 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. Request See the following file to view the sample code: ...LoyaltyBatchEnrollmentRequest.xml Siebel CRM Web Services Reference Version 8.1/8.2 153
- 154. Siebel CRM Primary Web Services ■ LoyaltyImportBusinessService Response See the following file to view the sample code: ...LoyaltyBatchEnrollmentResponse.xml Interface Description (WSDL) for LoyaltyBatchEnrollment 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. ...LoyaltyBatchEnrollmentWSDL LoyaltyImportBusinessService Use this Web Service with the Siebel Loyalty Application to perform all voucher related service operations, such as Voucher Validity Check and Status Change. LoyaltyImportBusinessService Operations For a list of operations associated with this Web service, see Table 281. Table 281. LoyaltyImportBusinessService Operations Name Description VoucherImport Takes in the File Name, Service Name, Method Name, File Format and Request Message Description: VoucherImport This operation takes in the File Name, Service Name, Method Name, File Format and Integration Object Name as input and processes the redemption transactions for those records sent in the File mentioned in the input. It generates the log file with the same file name appended with a current timestamp. For a description of this request message, see Table 282. Siebel CRM Web Services Reference Version 8.1/8.2 154 Integration Object Name as input, and processes the redemption transactions for those records sent in the File mentioned in the input. Generates the log file with the same file name append with the current timestamp. Table 282. Request Message Description: VoucherImport Node Description Type File Format String Required File Name String Required IO Name String Required Method Name String Required Service Name String Required
- 155. Siebel CRM Primary Web Services ■ LoyaltyMemberService Response Message Description: VoucherImport For a description of this response message, see Table 283. Table 283. Response Message Description: VoucherImport Node Description Type ValidFlag Required String Example Package for LoyaltyImportBusinessService To view an example of messages 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. Interface Description (WSDL) for LoyaltyImportBusinessService 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. ...LoyaltyImportBusServiceLoyaltyImportBusService.wsdl LoyaltyMemberService Use this Web service to do the following member service actions: ■ Inquire membership details ■ Process membership information for Renewal or Cancellation ■ Retrieve member service price details ■ Purchase or Transfer points Siebel CRM Web Services Reference Version 8.1/8.2 155
- 156. Siebel CRM Primary Web Services ■ LoyaltyMemberService LoyaltyMemberService Operations For a list of operations associated with this Web service, see Table 284. Table 284. LoyaltyMemberService Operations Name Description PurchasePointsService Used for purchasing points. Siebel CRM Web Services Reference Version 8.1/8.2 156 The member provides a membership number, the point type he or she wants to purchase, and the number of points as input. Credit card details must also be given as the service might involve monetary payment. Once the service is complete, output is given as an XML file that shows the transaction number and the order number. Member point balances are updated accordingly and reflected in the Siebel Loyalty application. TransferPointsService Used for transferring points to another member. The member provides a membership number, the point type which he or she wants to purchase, and the number of points as input. The transferee member number must also be included as input. Credit card details must also be given as the service might involve monetary payment. Once the service is performed, output is given as an XML file that shows the transaction number and the order number. Members’ (transferor and transferee) point balances are updated accordingly and reflected in the Siebel Loyalty application. LoungePurchaseService Used to buy or renew Lounge. The member provides a membership number, lounge period type, and lounge period duration along with credit card details. The member must also provide payment mode (Pay, Points, or Points+Pay) along with currency, and point type details as the service might involve payment. After the service is performed, the Member’s Lounge details are updated and a transaction detail record is created. MembershipCancellationService Used to cancel a loyalty membership. The member provides a membership number and credit card information (using the same credit card used during membership enrollment, or renewal). The loyalty program fee is refunded to the member’s credit card, and membership is cancelled.
- 157. Siebel CRM Primary Web Services ■ LoyaltyMemberService Table 284. LoyaltyMemberService Operations Name Description RenewMembershipService Renews the loyalty membership for members who are not enrolled in lifetime membership plans. The member provides a membership number, and membership scheme along with payment details (payment mode, credit card details and point type details) as the input. Membership dates are updated along with the membership scheme after the service is performed successfully. GetMemberServicePrice The member provides a membership number, and member service name to obtain price lists in different payment modes. Output is an integration object that can be seen as an XML file. MemberInquiry Used to query for a member or members given the member names, member number, and so on. The output details include member loyalty information, contact addresses, phone numbers, and email addresses, and so on. PromotionEnrolmentForSMS Rewards members a referral bonus when their social networking friends enroll into promotions. Request Message Description: PurchasePointsService For a description of this request message, see Table 285. Table 285. Request Message Description: PurchasePointsService Node Description Type Member Number Required. The requesting member must provide the Siebel Loyalty membership number. String Point Type Required. The purchasing member must specify the type of point that he or she wants to purchase. String Points Required. The purchasing member must specify the number of points that he or she wants to purchase. String Billing Address Member billing address. Required if monetary or credit card details are a part of the transaction. String Billing Address2 Members secondary billing address. Required if monetary or credit card details are a part of the transaction. String Billing City Member billing city. Required if monetary or credit card details are a part of the transaction. String Billing Country Member billing country. Required if monetary or credit card details are a part of the transaction. String Siebel CRM Web Services Reference Version 8.1/8.2 157
- 158. Siebel CRM Primary Web Services ■ LoyaltyMemberService Table 285. Request Message Description: PurchasePointsService Node Description Type Billing State Member billing state. Required if monetary or credit card details Response Message Description: PurchasePointsService For a description of this response message, see Table 286. Siebel CRM Web Services Reference Version 8.1/8.2 158 are a part of the transaction. String Billing ZIP Code Member billing ZIP code. Required if monetary or credit card details are a part of the transaction. String CVV Number CVV number from member credit card. Required if monetary or credit card details are a part of the transaction. String Card Holder Name Credit card holder’s name. Required if monetary or credit card details are a part of the transaction. String Credit Card Number Credit card number. Required if monetary or credit card details are a part of the transaction. String Credit Card Type Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction. String Currency Currency type used by member. Required if monetary currency is part of the transaction. String Expiration Month Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction. String Expiration Year Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction. String Override Flag Override flag. String Override Pay Required. If the member wants to override the price details, then the input is Y, if not, then the input is N. String Override Reason The member must specify Override Pay when the Override flag is marked Y. It is the monetary amount overridden by the member. String Override Reason Code A reason for the price list override is stated if this flag is set to Y. String Table 286. Response Message Description: PurchasePointsService Node Description Type Error Message Error message given if the transaction fails. String Order Id Order ID of the point purchase service. String Quote Id Quote ID of the point purchase service. String Siebel Response Code Siebel Order Management response code following authorization of a credit card. String
- 159. Siebel CRM Primary Web Services ■ LoyaltyMemberService Table 286. Response Message Description: PurchasePointsService Node Description Type Request Message Description: TransferPointService For a description of this request message, see Table 287. Siebel CRM Web Services Reference Version 8.1/8.2 159 Siebel Response Message Siebel Order Management response message following authorization of a credit card. String Transaction Number The transaction number of the point purchase service. String Table 287. Request Message Description: TransferPointService Node Description Type Member Number Required. The requesting member must provide the Siebel Loyalty membership number. String Point Type Required. The purchasing member must specify the type of point that he or she wants to purchase. String Points Required. The purchasing member must specify the number of points that he or she wants to purchase. String Transferee Member Number Required. Transferee membership number to whom the points are to be transferred. String Billing Address Member billing address. Required if monetary or credit card details are a part of the transaction. String Billing Address2 Members secondary billing address. Required if monetary or credit card details are a part of the transaction. String Billing City Member billing city. Required if monetary or credit card details are a part of the transaction. String Billing Country Member billing country. Required if monetary or credit card details are a part of the transaction. String Billing State Member billing state. Required if monetary or credit card details are a part of the transaction. String Billing ZIP Code Member billing ZIP code. Required if monetary or credit card details are a part of the transaction. String CVV Number CVV number from member credit card. Required if monetary or credit card details are a part of the transaction. String Card Holder Name Credit card holder’s name. Required if monetary or credit card details are a part of the transaction. String Credit Card Number Credit card number. Required if monetary or credit card details are a part of the transaction. String Credit Card Type Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction. String
- 160. Siebel CRM Primary Web Services ■ LoyaltyMemberService Table 287. Request Message Description: TransferPointService Node Description Type Currency Currency type used by member. Required if monetary currency Response Message Description: TransferPointService For a description of this response message, see Table 288. Siebel CRM Web Services Reference Version 8.1/8.2 160 is part of the transaction. String Expiration Month Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction. String Expiration Year Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction. String Override Flag Override flag. String Override Pay Required. If the member wants to override the price details, then the input is Y, if not, then the input is N. String Override Reason The member must specify Override Pay when the Override flag is marked Y. It is the monetary amount overridden by the member. String Override Reason Code A reason for the price list override is stated if this flag is set to Y. String Table 288. Response Message Description: TransferPointService Node Description Type Error Message Error message given if the transaction fails. String Order Id Order ID of the point purchase service. String Quote Id Quote ID of the point purchase service. String Siebel Response Code Siebel Order Management response code following authorization of a credit card. String Siebel Response Message Siebel Order Management response message following authorization of a credit card. String Transaction Number The transaction number of the point purchase service. String
- 161. Siebel CRM Primary Web Services ■ LoyaltyMemberService Request Message Description: LoungePurchaseService For a description of this request message, see Table 289. Table 289. Request Message Description: LoungePurchaseService Node Description Type Member Number Required. The requesting member must provide the Siebel Loyalty Membership Number. String Lounge Period Type Required. Lounge period type as months or years. String Lounge Period Duration Lounge period duration for renewal stated in months or years. String Billing Address Member billing address. Required if monetary or credit card details are a part of the transaction. String Billing Address2 Members secondary billing address. Required if monetary or credit card details are a part of the transaction. String Billing City Member billing city. Required if monetary or credit card details are a part of the transaction. String Billing Country Member billing country. Required if monetary or credit card details are a part of the transaction. String Billing State Member billing state. Required if monetary or credit card details are a part of the transaction. String Billing ZIP Code Member billing ZIP code. Required if monetary or credit card details are a part of the transaction. String CVV Number CVV number from member credit card. Required if monetary or credit card details are a part of the transaction. String Card Holder Name Credit card holder’s name. Required if monetary or credit card details are a part of the transaction. String Credit Card Number Credit card number. Required if monetary or credit card details are a part of the transaction. String Credit Card Type Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction. String Currency Currency type used by member. Required if monetary currency is part of the transaction. String Expiration Month Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction. String Expiration Year Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction. String Override Flag Override flag. String Override Pay Required. If the member wants to override the price details, then the input is Y, if not, then the input is N. String Siebel CRM Web Services Reference Version 8.1/8.2 161
- 162. Siebel CRM Primary Web Services ■ LoyaltyMemberService Table 289. Request Message Description: LoungePurchaseService Node Description Type Override Points The member must specify Override Pay when the Override Response Message Description: LoungePurchaseService For a description of this response message, see Table 290. Request Message Description: RenewMembershipService For a description of this request message, see Table 291. Siebel CRM Web Services Reference Version 8.1/8.2 162 flag is marked Y. It is the monetary amount overridden by the member. String Override Reason A reason for the price list override is stated if this flag is set to Y. String Override Reason Code, A reason for the price list override is stated if this flag is set to Y. String Payment Mode Required. Payment mode stated as Points or Points+Pay, or Pay. String Point Type Point type. String Table 290. Response Message Description: LoungePurchaseService Node Description Type Error Message Error message given if the transaction fails. String Order Id Order ID of the point purchase service. String Quote Id Quote ID of the point purchase service. String Siebel Response Code Siebel Order Management response code following authorization of a credit card. String Siebel Response Message Siebel Order Management response message following authorization of a credit card. String Transaction Number The transaction number of the point purchase service. String Table 291. Request Message Description: RenewMembershipService Node Description Type Member Number Required. The requesting member must provide the Siebel Loyalty Membership Number. String Membership Scheme Required. The membership scheme to be renewed. String Billing Address Member billing address. Required if monetary or credit card details are a part of the transaction. String
- 163. Siebel CRM Primary Web Services ■ LoyaltyMemberService Table 291. Request Message Description: RenewMembershipService Node Description Type Billing Address2 Members’ secondary billing address. Required if monetary or credit card details are a part of the transaction. String Billing City Member billing city. Required if monetary or credit card details are a part of the transaction. String Billing Country Member billing country. Required if monetary or credit card details are a part of the transaction. String Billing State Member billing state. Required if monetary or credit card details are a part of the transaction. String Billing ZIP Code Member billing ZIP code. Required if monetary or credit card details are a part of the transaction. String CVV Number CVV number from member credit card. Required if monetary or credit card details are a part of the transaction. String Card Holder Name Credit card holder’s name. Required if monetary or credit card details are a part of the transaction. String Credit Card Number Credit card number. Required if monetary or credit card details are a part of the transaction. String Credit Card Type Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction. String Currency Currency type used by member. Required if monetary currency is part of the transaction. String Expiration Month Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction. String Expiration Year Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction. String Override Flag Override flag. String Override Pay Required. If the member wants to override the price details, then the input is Y, if not, then the input is N. String Override Points The member must specify Override Pay when the Override flag is marked Y. It is the monetary amount overridden by the member. String Override Reason A reason for the price list override is stated if this flag is set to Siebel CRM Web Services Reference Version 8.1/8.2 163 Y. String Override Reason Code A reason for the price list override is stated if this flag is set to Y. String Payment Mode Required. Payment mode stated as Points or Points+Pay, or Pay. String Point Type Point type. String
- 164. Siebel CRM Primary Web Services ■ LoyaltyMemberService Response Message Description: RenewMembershipService For a description of this response message, see Table 292. Table 292. Response Message Description: RenewMembershipService Node Description Type Error Message Error message given if the transaction fails. String Order Id Order ID of the point purchase service. String Quote Id Quote ID of the point purchase service. String Siebel Response Code Siebel Order Management response code following Request Message Description: MembershipCancellationService For a description of this request message, see Table 293. Siebel CRM Web Services Reference Version 8.1/8.2 164 authorization of a credit card. String Siebel Response Message Siebel Order Management response message following authorization of a credit card. String Transaction Number The transaction number of the point purchase service. String Table 293. Request Message Description: MembershipCancellationService Node Description Type Member Number Required. The requesting member must provide the Loyalty Membership Number. String Fee Refund Basis Required. Fee refund basis. Values include Prorata or Percentage, or No Refund. String Refund Percentage Refund percentage is to be given if the selected fee refund basis is calculated as a percentage. String Cancellation Reason Reason for the membership cancellation. String Cancellation Reason Code Required. Membership cancellation reason code. String Credit Card Number Credit card number. Required when the refund basis is Percentage or Prorata. The fee is refunded to the credit card number provided that it matches the number previously retained. String Credit Card Type Credit card type, such as Visa, MasterCard, and so on. Required when the refund basis is Percentage or Prorata. The fee is refunded to the credit card number provided that it matches the number previously on file. String Expiration Month Expiration month must match the expiration month of the credit card on file. Required when the refund basis is Percentage or Prorata. String
- 165. Siebel CRM Primary Web Services ■ LoyaltyMemberService Table 293. Request Message Description: MembershipCancellationService Node Description Type Expiration Year Expiration year must match the expiration year of the credit card on file. Required when the refund basis is Percentage or Prorata. Override Flag Required. If the member wants to override the refund price details, then the input is Y, if not, then the input is N. Override Pay Required. If the member wants to override the price details then the input is Y, if not, then the input is N. Override Reason Reason for overriding price. String Override Reason Code Override reason code provided if the Override Flag is Y. String Response Message Description: MembershipCancellationService For a description of this response message, see Table 294. Table 294. Response Message Description: MembershipCancellationService Node Description Type Currency Currency in which the fee is refunded. String Error Message Error message if the transaction fails. String Order Id Refund Order ID of the membership cancellation service. String Quote Id Quote ID of the membership cancellation service. String Refund Amount Refund amount. String Siebel Response Code Response code provided by Siebel Order Management after the credit card authorization is sent. Siebel Response Message Response message given by Siebel Order Management after credit card authorization. Transaction Number The transaction number of the membership cancellation. String Request Message Description: GetMemberServicePrice For a description of this request message, see Table 295. String String String String String Table 295. Request Message Description: GetMemberServicePrice Node Description Type Member Number The requesting member must provide the Siebel Loyalty Membership Number. String Currency Code Currency code to return price lists in a given currency. String Lounge Period Duration The Lounge period duration must be provided if the Transaction Sub Type is set to Lounge Purchase. String Siebel CRM Web Services Reference Version 8.1/8.2 165
- 166. Siebel CRM Primary Web Services ■ LoyaltyMemberService Table 295. Request Message Description: GetMemberServicePrice Node Description Type Lounge Period Type Lounge Period type (Months or Years, and so on) must be Response Message Description: GetMemberServicePrice For a description of this response message, see Table 296. Request Message Description: MemberInquiry For a description of this request message, see Table 297. Siebel CRM Web Services Reference Version 8.1/8.2 166 provided if the Transaction Sub Type is set to Lounge Purchase. String Point Type Point type must be provided if the member wants to see price lists of Points, or Points + Pay mode in the given point type. String Points Qty Number of points to be given if the transaction sub type is set to Purchase Points or Transfer Points. String Selected Membership Scheme Membership scheme included in the input if the Transaction Sub Type is Membership Renewal. String Transaction Sub Type Required. Member Service type. Possible values are: Points Purchase, Transfer Points, Membership Renewal, or Lounge Purchase. String Table 296. Response Message Description: GetMemberServicePrice Node Description Type LOY EAI Transaction List of price lines, after applying the promotions on the base prices, are given in the output as XML file. Integration Object Table 297. Request Message Description: MemberInquiry Node Description Type Member Number The requesting member must provide the Siebel Loyalty Membership Number. String Email Address Email address of inquiring member. String First Name Member’s first name. String Last Name Member’s last name. String Middle Name Member’s middle name. String Telephone Number Member’s telephone number. String Transaction Type Transaction type must be provided for queries. String ZIP Code ZIP code of the member whose details are to be inquired is given. String
- 167. Siebel CRM Primary Web Services ■ LoyaltyMemberService Response Message Description: GetMemberServicePrice For a description of this response message, see Table 298. Table 298. Response Message Description: GetMemberServicePrice Node Description Type Siebel Message (An instance of the Member details are given in the integration object LOY Member integration object and can be Inquiry) extracted as XML file. Request Message Description: PromotionEnrolmentForSMS For a description of this request message, see Table 299. Table 299. Request Message Description: PromotionEnrolmentForSMS Node Description Type Member Number Required. The member number of the enrollee. String Enrolled Promotion Id Required. The enrolled promotion ID. String Incentive Choice Optional. Incentive choice type. String Referred By Member Optional. Member number of referee. String Number Response Message Description: PromotionEnrolmentForSMS For a description of this response message, see Table 300. Integration Object Table 300. Response Message Description: PromotionEnrolmentForSMS Node Description Type Error Message Error message. String Siebel Message Transactions in integration object format. Integration Object Example Package for LoyaltyMemberServices To view an example of messages 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. Request See the following file to view the sample code: ...LoyaltyMemberServicesRequest.xml Siebel CRM Web Services Reference Version 8.1/8.2 167
- 168. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Response See the following file to view the sample code: ...LoyaltyMemberServicesResponse.xml Interface Description (WSDL) for LoyaltyMemberServices 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. ...LoyaltyMemberServiceWSDL LoyaltyRedemptionService Use this Web service with the Siebel Loyalty application to perform all redemption related operations, including redemption processing, redemption cancellation, voucher reissue, and Siebel Order Management integration. LoyaltyRedemptionService Operations For a list of operations associated with this Web service, see Table 301. Table 301. LoyaltyRedemptionService Operations Name Description GetPriceOptions Returns available price options for a set of redemption activities. Siebel CRM Web Services Reference Version 8.1/8.2 168 Also returns the point balance of the member in all point types. GetPriceOptions Returns available price options with payment mode set as Points or Points+Pay for a set of redemption activities. Also returns the point balance of the member in all point types. CheckPriceOptions Returns available price options for a set of redemption activities. Also performs the credit check and returns how much of a loan is required for each point type. If a loan is not possible, then the Web service performs the point-to-pay conversion and returns the prorated pay and points for each transaction. CheckCredit Performs the credit check for a given member and point type. Checks whether a loan is required and returns how much of a loan is required to fulfill the redemption transaction.
- 169. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Table 301. LoyaltyRedemptionService Operations Name Description GetQuote Returns available price options for a set of redemption activities. Also performs the credit check and returns how much of a loan is required for each point type. If a loan is not possible, then the Web service does the point-to-pay conversion and returns the prorated pay and points for each transaction. This operation also creates a quote using the given redemption activities (transactions), credit card details (optional) and shipping details (optional). ProcessQuote Takes Quote ID as input and converts the quote to order and order to redemption transactions, then processes those transactions. GetTransactionDetails Takes as input an Order Number and returns the Transaction details (including activities and Transaction Items if any) for the same. GetRedemptionRefund Returns the refund in Points or Points plus Pay for a given redemption transaction, which need to be cancelled. CancelRedemptionTxn Takes the redemption transaction ID which need to be cancelled and the refund amount (either unmodified, or overridden refund amount got from the GetRedemptionRefund method) and creates the cancellation transaction and processes it. GetReissueFeeOptions Returns the different fee options for reissuing the given voucher. CheckReissueFeeOption Checks whether a given fee option for a voucher is valid, and whether the member has enough points to pay in this fee option if the payment mode involves Points. GetReissueQuote Takes the chosen fee option details for a voucher, credit card details (optional), shipping details (optional), checks whether the fee option is valid, does credit check if the payment mode involves points, and creates a quote with the given data. ProcessReissueQuote Takes as input Quote ID, creates Order for Quote, and creates a Loyalty Voucher Reissue transaction and processes it to reissue the voucher. UpdateQuoteShippingAddress Takes Quote ID and shipping details and updates the quote with the given shipping address. Siebel CRM Web Services Reference Version 8.1/8.2 169
- 170. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService AddCreditCardToQuote Takes Quote ID, credit card details, billing address and updates Request Message Description: GetPriceOptions For a description of this request message, see Table 302. Response Message Description: GetPriceOptions For a description of this response message, see Table 303. Request Message Description: CheckPriceOptions For a description of this request message, see Table 304. Siebel CRM Web Services Reference Version 8.1/8.2 170 the quote with the credit card details. ProcessRealTimeRedemption Takes as input the transaction data. It checks all pending redemption transactions and verifies the point balance to determine whether the request can be processed. The service also performs a credit check to determine whether a loan is needed for processing the transaction. If a loan is needed, the service creates and processes the loan transaction, and then creates the redemption transaction. It returns the transaction number as output. Table 302. Request Message Description: GetPriceOptions Node Description Type LOY Redemption Txn Contains the redemption activity details. Integration Object (Required) Table 303. Response Message Description: GetPriceOptions Node Description Type LOY Redemption Txn Contains the redemption activity details and the price options for each activity. Integration Object (Required) LOY Redemp Points Summary Contains point balances of the member in all point types. Integration Object (Required) Table 304. Request Message Description: CheckPriceOptions Node Description Type LOY Redemption Txn Contains the redemption activity details. Integration Object (Required) Table 301. LoyaltyRedemptionService Operations Name Description
- 171. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Response Message Description: CheckPriceOptions For a description of this response message, see Table 305. Table 305. Response Message Description: CheckPriceOptions Node Description Type LOY Redemption Txn Contains the redemption activity details and one price option for each activity. Integration Object Request Message Description: CheckCredit This operation performs a credit check for a given member and point type. Checks whether loan is required and returns how much of a loan is required to fulfill the redemption transaction. For a description of this request message, see Table 306. Response Message Description: CheckCredit For a description of this response message, see Table 307. Siebel CRM Web Services Reference Version 8.1/8.2 171 LOY Redemp Points Summary Point summary for each point type including points to be paid, point balance, loan (if any) and Points to Pay Conversion flag. Integration Object Pay Total amount to be paid if monetary payment is involved. Number Pay Currency Code Currency if monetary payment is involved. String Table 306. Request Message Description: CheckCredit Node Description Type MemberNumber Membership number. String PointTypeId ID number for point type. String PointsReq The required number of points. Number LoanFlag Indicates whether loan limit must be considered. String Table 307. Response Message Description: CheckCredit Node Description Type CCResult Required String Available Balance Required String EligLoan Optional Number Error Message Optional String LoanAllowed Required String LoanFlag Optional String PointsShortage Optional String
- 172. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Request Message Description: GetQuote This operation creates a quote using the given redemption activities (transactions), credit card details (optional) and shipping details (optional). For a description of this request message, see Table 308. Table 308. Request Message Description: GetQuote Node Description Type LOY Redemption Txn Contains the redemption activity details. Integration Siebel CRM Web Services Reference Version 8.1/8.2 172 Object Billing Address Address of customer being billed. String Billing Address2 Second address, if necessary of customer being billed. String Shipping Method Shipping method, such as Ground, Air or carrier name. String Ship To Street Address Shipping street address. String Ship To Street Address 2 Second shipping street address if needed. String Ship To State Shipping state. String Ship To Postal Code Shipping postal code. String Ship To Country Shipping country. String Billing City Billing city, if different from shipping address. String Billing Country Billing country, if different from shipping address. String Billing State Billing state, if different from shipping address. String Billing ZIP Code Billing ZIP code, if different from shipping address. String CVV Number CVV number of the credit card. String Card Holder Name Name of credit card holder. String Credit Card Expiration Expiration date of credit card. String Month Credit Card Expiration Year Expiration year of credit card. String Credit Card Line Number Credit card line number. String Credit Card Number Credit card number. String Credit Card Type Credit cards type, such as Visa, American Express, and so on. String Recipient Name Name of person who will receive shipped goods. String Save Shipping Address Check to save shipping address for future use. String Flag Select Primary Shipping Address Flag Flag to indicate primary address for account. String
- 173. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Table 308. Request Message Description: GetQuote Node Description Type Ship To Address Id ID for shipping address. String Ship To City City that product is being shipped to. String Response Message Description:GetQuote For a description of this response message, see Table 309. Table 309. Response Message Description:GetQuote Node Description Type LOY Redemption Txn Contains the redemption activity details and one price option for each activity. Integration Object Request Message Description: ProcessQuote This operation converts a quote to an order and an order to redemption transactions. It then processes these transactions. For a description of this request message, see Table 310. Response Message Description: Process Quote For a description of this response message, see Table 311. Siebel CRM Web Services Reference Version 8.1/8.2 173 LOY Redmp Points Summary Point Summary for each point type including points to be paid, point balance, loan (if any) and Points to Pay Conversion flag. Integration Object Currency Code Code to indicate which currency being used for translation. String Shipping Charge Shipping charge for transaction. String Quote Id ID of quote that is created. String Pay Total amount of transaction. Number Tax Total taxed charged on transaction. Number Table 310. Request Message Description: ProcessQuote Node Description Type Quote Id String Required Table 311. Response Message Description: Process Quote Node Description Type Status Optional String Order Id Required String
- 174. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Request Message Description: GetTransactionDetails For a description of this request message, see Table 312. Table 312. Request Message Description: GetTransactionDetails Node Description Type Order Number Required String Response Message Description: GetTransactionDetails For a description of this response message, see Table 313. Table 313. Response Message Description: GetTransactionDetails Node Description Type LOY Redemption Txn Contains details of the redemption transactions Request Message Description: GetRedemptionRefund This operation returns the refund amount for given redemption transaction, which is then cancelled. For a description of this request message, see Table 314. Response Message Description: GetRedemptionRefund For a description of this response message, see Table 315. Siebel CRM Web Services Reference Version 8.1/8.2 174 that have been created for this order along with transaction items for each transaction in case of package transaction. Integration Object. Table 314. Request Message Description: GetRedemptionRefund Node Description Type Transaction Id Required String Table 315. Response Message Description: GetRedemptionRefund Node Description Type Pay Optional String Point Type Required String Points Required String Currency Optional String Payment Type Required String
- 175. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Request Message Description: CancelRedemptionTxn This operation takes the redemption transaction ID which requires cancellation as well as the refund amount (either the unmodified or overridden refund amount gotten from the GetRedemptionRefund operation) and creates the cancellation transaction and processes it. For a description of this request message, see Table 316. Table 316. Request Message Description: CancelRedemptionTxn Node Description Type Override Expiry Date Optional String Override Expiry Date Flag Optional String Override Pay Optional String Override Points Optional String Override Price Flag Optional String Transaction Id Required String Override Reason Code Optional String Payment Mode Required String Simulate Pay Optional String Override Reason Optional String Response Message Description:CancelRedemptionTxn For a description of this response message, see Table 317. Table 317. Response Message Description:CancelRedemptionTxn Node Description Type New Txn Id ID of the cancelled transaction. String Request Message Description: GetReissueFeeOptions This operation returns available fee options for reissue of a voucher with given ID. For a description of this request message, see Table 318. Table 318. Request Message Description: GetReissueFeeOptions Node Description Type Currency Code Optional String Voucher Id Required String Point Type Id Optional String Payment Type Code Required String Siebel CRM Web Services Reference Version 8.1/8.2 175
- 176. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Response Message Description:GetReissueFeeOptions For a description of this response message, see Table 319. Table 319. Response Message Description:GetReissueFeeOptions Node Description Type Product Point Id Required String Fee Points Optional Number Fee Amount Optional Number Error Message Optional String Request Message Description: GetReissueQuote This operation takes the chosen fee option details for a voucher, credit card details (optional), shipping details (optional), checks whether the fee option is valid, does credit check if the payment mode involves points, and creates a quote with the given data. For a description of this request message, see Table 320. Table 320. Request Message Description: GetReissueQuote Node Description Type Voucher Id Required String Currency Code Optional String Payment Type Code Required String Point Type Id Optional String Override Amount Optional Number Override Flag Optional String Override Points Optional Number Override Reason Optional String Override Reason Code Optional String Billing Address Optional String Billing Address2 Optional String Shipping Method Optional String Ship To Street Address 2 Optional String Ship To Street Address Optional String Ship To State Optional String Ship To Postal Code Optional String Ship To Country Optional String Billing City Optional String Siebel CRM Web Services Reference Version 8.1/8.2 176
- 177. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Table 320. Request Message Description: GetReissueQuote Node Description Type Billing Country Optional String Billing State Optional String Billing ZIP Code Optional String CVV Number Optional String Card Holder Name Optional String Credit Card Expiration Optional String Month Response Message Description: GetReissueQuote For a description of this response message, see Table 321. Siebel CRM Web Services Reference Version 8.1/8.2 177 Credit Card Expiration Year Optional String Credit Card Number Optional String Credit Card Type Optional String Recipient Name Optional String Save Shipping Address Optional String Flag Select Primary Shipping Address Flag Optional String Ship To Address Id Optional String Ship To City Optional String Table 321. Response Message Description: GetReissueQuote Node Description Type Currency Code Optional String Quote Id Required String Error Message Optional String Fee Amount Optional Number Fee Points Optional Number Shipping Charge Optional String Tax Amount Optional String Currency Code Optional String
- 178. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Request Message Description: ProcessReissueQuote This operation takes as input Quote ID, creates and Order for Quote, and creates a Loyalty Voucher Reissue transaction and processes it to reissue the voucher. For a description of this request message, see Table 322. Table 322. Request Message Description: ProcessReissueQuote Node Description Type Quote Id Required String Response Message Description: ProcessReissueQuote For a description of this response message, see Table 323. Table 323. Response Message Description: ProcessReissueQuote Node Description Type Transaction Number Required String Order Number Required String New Voucher Expiry Date Required Date New Voucher Number Required String New Voucher Status Required String Request Message Description: UpdateQuoteShippingAddress This operation takes the Quote ID and shipping details and updates the quote with the given shipping address. For a description of this request message, see Table 324. Table 324. Request Message Description: UpdateQuoteShippingAddress Node Description Type Quote Id Required String Response Message Description: UpdateQuoteShippingAddress For a description of this response message, see Table 325. Table 325. Response Message Description: UpdateQuoteShippingAddress Node Description Type Shipping Charge Required String Siebel CRM Web Services Reference Version 8.1/8.2 178
- 179. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Request Message Description: AddCreditCardToQuote This operation takes the Quote ID, credit card details, billing address and updates the quote with the credit card details. For a description of this request message, see Table 326. Table 326. Request Message Description: AddCreditCardToQuote Node Description Type Billing Address Required String Billing Address 2 Optional String Billing City Optional String Billing Country Required String Billing ZIP Code Optional String CVV Number Optional Number Card Holder Name Optional String Credit Card Number Optional Number Credit Card Type Optional String Expiration Month Optional String Expiration Year Optional String Response Message Description: GetReissueQuote There are no response messages for this operation. Request Message Description: ProcessRealTimeRedemption For a description of this request message, see Table 327. Table 327. Request Message Description: ProcessRealTimeRedemption Node Description Type LOY Redemption Txn Contains the redemption activity details. Integration Object Response Message Description: ProcessRealTimeRedemption For a description of this response message, see Table 328. Table 328. Response Message Description: ProcessRealTimeRedemption Node Description Type LOY Redemption Txn Contains the redemption activity details. Integration Object Transaction Number Required. String Siebel CRM Web Services Reference Version 8.1/8.2 179
- 180. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Example Packages for LoyaltyRedemptionService To view an example of messages 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. Request (GetPriceOptions) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetPriceOptions_request.xml Response (GetPriceOptions) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetPriceOptions_response.xml Request (CheckPriceOptions) See the following file to view the sample code: ...LoyaltyRedemptionServiceCheckPriceOptions_request.xml Response (CheckPriceOptions) See the following file to view the sample code: ...LoyaltyRedemptionServiceCheckPriceOptions_response.xml Request (CheckCredit) See the following file to view the sample code: ...LoyaltyRedemptionServiceCheckCredit_request.xm Response (CheckCredit) See the following file to view the sample code: ...LoyaltyRedemptionServiceCheckCredit_response.xml Request (GetQuote) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetQuote_request.xml Response (GetQuote) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetQuote_response.xml Siebel CRM Web Services Reference Version 8.1/8.2 180
- 181. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Request (ProcessQuote) See the following file to view the sample code: ...LoyaltyRedemptionServiceProcessQuote_request.xml Response (ProcessQuote) See the following file to view the sample code: ...LoyaltyRedemptionServiceProcessQuote_response.xml Request (GetTransactionDetails) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetTransactionDetails_request.xml Response(GetTransactionDetails) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetTransactionDetails_response.xml Request (GetRedemptionRefund) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetRedemptionRefund_request.xml Response (GetRedemptionRefund) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetRedemptionRefund_response.xml Request (CancelRedemptionTxn) See the following file to view the sample code: ...LoyaltyRedemptionServiceCancelRedemptionTxn_request.xml Response (CancelRedemptionTxn) See the following file to view the sample code: ...LoyaltyRedemptionServiceCancelRedemptionTxn_response.xml Request (GetReissueFeeOptions) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetReissueFeeOptions_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 181
- 182. Siebel CRM Primary Web Services ■ LoyaltyRedemptionService Response(GetReissueFeeOptions) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetReissueFeeOptions_response.xml Request (GetReissueQuote) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetReissueQuote_request.xml Response (GetReissueQuote) See the following file to view the sample code: ...LoyaltyRedemptionServiceGetReissueQuote_response.xml Request (ProcessReissueQuote) See the following file to view the sample code: ...LoyaltyRedemptionServiceProcessReissueQuote_request.xml Response(ProcessReissueQuote) See the following file to view the sample code: ...LoyaltyRedemptionServiceProcessReissueQuote_response.xml Request (UpdateQuoteShippingAddress) See the following file to view the sample code: ...LoyaltyRedemptionServiceUpdateQuoteShippingAddress_request.xml Response (UpdateQuoteShippingAddress) See the following file to view the sample code: ...LoyaltyRedemptionServiceUpdateQuoteShippingAddress_response.xml Request (AddCreditCardToQuote) See the following file to view the sample code: ...LoyaltyRedemptionServiceAddCreditCardToQuote_request.xml Response (AddCreditCardToQuote) See the following file to view the sample code: ...LoyaltyRedemptionServiceAddCreditCardToQuote_response.xml Siebel CRM Web Services Reference Version 8.1/8.2 182
- 183. Siebel CRM Primary Web Services ■ LoyaltyVoucherService Request (ProcessRealTimeRedemption) See the following file to view the sample code: ...LoyaltyRedemptionServiceProcessRealTimeRedemption_request.xml Response (ProcessRealTimeRedemption) See the following file to view the sample code: ...LoyaltyRedemptionServiceProcessRealTimeRedemption_response.xml Interface Description (WSDL) for LoyaltyRedemptionService 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. ...LoyaltyRedemptionServiceLoyaltyRedemptionService.wsdl LoyaltyVoucherService Use this Web service with the Siebel Loyalty Application to perform all Voucher related Web service operations, including Voucher Validity Check and Status Change. LoyaltyVoucherService Operations For a list of operations associated with this Web service, see Table 329. Table 329. LoyaltyVoucherService Operations Name Description VoucherStatusChange Takes in the membership number, partner name, voucher number, activity date and change the status of the voucher to Used in real time. Request Message Description: VoucherValidityCheck This operation takes in the membership number, Partner ID voucher number and activity date, to validate the voucher and return Success, Failure. For a description of this request message, see Table 330. Table 330. Request Message Description: VoucherValidityCheck Node Description Type Voucher Number Required String Activity Date Required String Member Number Required String Partner Id Required String Siebel CRM Web Services Reference Version 8.1/8.2 183
- 184. Siebel CRM Primary Web Services ■ LoyaltyVoucherService Response Message Description: VoucherValidityCheck For a description of this response message, see Table 331. Table 331. Response Message Description: VoucherValidityCheck Node Description Type Valid Flag Required String Request Message Description: VoucherStatusChange This operation takes in the membership number, partner name, voucher number, activity date and change the status of the voucher to Used in real time. This involves creation of Availment transaction and processing it in real time. For a description of this request message, see Table 332. Table 332. Request Message Description: VoucherStatusChange Node Description Type Voucher Number Optional String Member Number Required String Partner Name Required String Activity Date Required String Order Number Optional Number Response Message Description: VoucherStatusChange For a description of this response message, see Table 333. Table 333. Response Message Description: VoucherStatusChange Node Description Type Voucher Number Optional String Order Number Optional Number Voucher Type Required String Return Value Required String Example Package for LoyaltyVoucherService To view an example of messages 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. Request See the following file to view the sample code: ...LoyaltyVoucherServiceRequest.xml Siebel CRM Web Services Reference Version 8.1/8.2 184
- 185. Siebel CRM Primary Web Services ■ LSSGOP_Account Response See the following file to view the sample code: ...LoyaltyVoucherServiceRequest.xml Interface Description (WSDL) for LoyaltyVoucherService 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. ...LoyaltyVoucherServiceWSDL LSSGOP_Account Use this Web service to perform create, update, delete, and query records in the Account object. LSSGOP_Account Operations For a list of operations associated with this Web service, see Table 334. Table 334. LSSGOP_Account Operations Name Description AccountInsert Creates an account. AccountUpdate Updates an existing account. AccountDelete Deletes an account. AccountQueryPage Queries for an account. Request Message Description: AccountInsert For a description of this request message, see Table 335. Table 335. Request Message Description: AccountInsert Name Description Type AccountInsert Creates an account. String Response Message Description: AccountInsert For a description of this request message, see Table 336. Table 336. Response Message Description: AccountInsert Name Description Type Id ID of the newly created account. String Siebel CRM Web Services Reference Version 8.1/8.2 185
- 186. Siebel CRM Primary Web Services ■ LSSGOP_Account Request Message Description: AccountUpdate For a description of this request message, see Table 337. Table 337. Request Message Description: AccountUpdate Name Description Type Id Account ID. String Name Account name. String Type Account type. String Response Message Description: AccountUpdate For a description of this request message, see Table 338. Table 338. Response Message Description: AccountUpdate Name Description Type Id ID of the updated account. String Request Message Description: AccountDelete For a description of this request message, see Table 339. Table 339. Request Message Description: AccountDelete Name Description Type Id ID of the account to be deleted. String Response Message Description: AccountDelete For a description of this request message, see Table 340. Table 340. Response Message Description: AccountDelete Name Description Type Id ID of the deleted account. String Request Message Description: AccountQueryPage For a description of this request message, see Table 341. Table 341. Request Message Description: AccountQueryPage Name Description Type Id ID of the account to be queried upon. String Siebel CRM Web Services Reference Version 8.1/8.2 186
- 187. Siebel CRM Primary Web Services ■ LSSGOP_AccountAddress Response Message Description: AccountQueryPage For a description of this request message, see Table 342. Table 342. Response Message Description: AccountQueryPage Name Description Type Id ID of the account. String LSSGOP_Account 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 343. Table 343. LSSGOP_Account Service Object Name Boundary Object Type Class LSSGOP_Account Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 344. Table 344. LSSGOP_Account Data Object Siebel Repository Name External Name LS SGOP_Account LS SGOP_Account Interface Description (WSDL) for LSSGOP_Account 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. ...LSSGOP_Accounthttp_siebel.com_asi_LSSGOP_Account.WSDL LSSGOP_AccountAddress Use this Web service to create, update, delete, and query records in the AccountAddresses object. Siebel CRM Web Services Reference Version 8.1/8.2 187
- 188. Siebel CRM Primary Web Services ■ LSSGOP_AccountAddress LSSGOP_AccountAddress Operations This Web service allows you to create, update, delete and query records in the AccountAddress object. For a list of operations, see Table 345. Table 345. LSSGOP_AccountAddress Operations Name Description AccountAddressInsert Creates an accountaddress record. AccountAddressUpdate Updates an existing accountaddress record. AccountAddressDelete Deletes an accountaddress record. AccountAddressPage Queries for an accountaddress record. Request Message Description: AccountAddressInsert For a description of this request message, see Table 346. Table 346. Request Message Description: AccountAddressInsert Node Description Type AddressId ID of the address to be associated to an Response Message Description: AccountAddressInsert For a description of this response message, see Table 347. Request Message Description: AccountAddressUpdate For a description of this request message, see Table 348. Siebel CRM Web Services Reference Version 8.1/8.2 188 account. String AccountId Account ID to which an address is associated. String Table 347. Response Message Description: AccountAddressInsert Node Description Type Id ID of the newly created accountaddress record. String Table 348. Request Message Description: AccountAddressUpdate Node Description Type Id ID of the accountaddress record. String AddressId Name of the corresponding record. String AccountId Type of the corresponding record. String
- 189. Siebel CRM Primary Web Services ■ LSSGOP_AccountAddress Response Message Description: AccountAddressUpdate For a description of this response message, see Table 349. Table 349. Response Message Description: AccountAddressUpdate Node Description Type Id ID of the updated accountaddress record. String Request Message Description: AccountAddressDelete For a description of this request message, see Table 350. Table 350. Request Message Description: AccountAddressDelete Node Description Type Id ID of the accountaddress to be deleted. String Response Message Description: AccountAddressDelete For a description of this response message, see Table 351. Table 351. Response Message Description: AccountAddressDelete Node Description Type Id ID of the deleted accountaddress record. .String Request Message Description: AccountAddressQueryPage For a description of this request message, see Table 352. Table 352. Request Message Description: AccountAddressQueryPage Node Description Type Id ID of the accountaddress record to be queried. Response Message Description: AccountAddressQueryPage For a description of this response message, see Table 353. String Table 353. Response Message Description: AccountAddressQueryPage Node Description Type Id ID of the accountaddress record. String Siebel CRM Web Services Reference Version 8.1/8.2 189
- 190. Siebel CRM Primary Web Services ■ LSSGOP_Activity LSSGOP_AccountAddress 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 354. Table 354. LSSGOP_AccountAddress Service Object Name Boundary Object Type Class LSSGOP_AccountAddress Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 355. Table 355. LSSGOP_AccountAddress Data Object Siebel Repository Name External Name LS SGOP_AccountAddress LS SGOP_AccountAddress Interface Description (WSDL) for LSSGOP_AccountAddress 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. ...LSSGOP_AccountAddresshttp_siebel.com_asi_LSSGOP_AccountAddress.WSDL LSSGOP_Activity Use this Web service to create, update, delete and query the Activity object. LSSGOP_Activity Operations This Web service allows you to create, update, delete, and query the Activity object. For a list of operations, Table 356. Table 356. LSSGOP_Activity Operations Name Description ActivityInsert Creates an activity. ActivityUpdate Updates an existing activity. Siebel CRM Web Services Reference Version 8.1/8.2 190
- 191. Siebel CRM Primary Web Services ■ LSSGOP_Activity Table 356. LSSGOP_Activity Operations Name Description ActivityDelete Deletes an activity. ActivityQueryPage Queries for an activity. Request Message Description: ActivityInsert For Contact Call, pass only the Contact ID and for Account Call, pass only the Account ID. For a description of this request message, see Table 357. Table 357. Request Message Description: ActivityInsert Node Description Type ContactId ID of the contact. String AccountId ID of the account. String Response Message Description: ActivityInsert For a description of this response message, see Table 358. Table 358. Response Message Description: ActivityInsert Node Description Type Id ID of the newly created activity. String Request Message Description: ActivityUpdate For a description of this request message, see Table 359. Table 359. Request Message Description: ActivityUpdate Node Description Type Id ID of the activity. String ContactId Contact ID of the activity. String AccountId Account ID of the activity. String Response Message Description: ActivityUpdate For a description of this response message, see Table 360. Table 360. Response Message Description: ActivityUpdate Node Description Type Id ID of the updated activity. String Siebel CRM Web Services Reference Version 8.1/8.2 191
- 192. Siebel CRM Primary Web Services ■ LSSGOP_Activity Request Message Description: ActivityDelete For a description of this request message, see Table 361. Table 361. Request Message Description: ActivityDelete Node Description Type Id ID of the activity to be deleted. String Response Message Description: ActivityDelete For a description of this response message, see Table 362. Table 362. Response Message Description: ActivityDelete Node Description Type Id ID of the deleted activity. String Request Message Description: ActivityQueryPage For a description of this request message, see Table 363. Table 363. Request Message Description: ActivityQueryPage Node Description Type Id ID of the activity to be queried. String Response Message Description: ActivityQueryPage For a description of this response message, see Table 364. Table 364. Response Message Description: ActivityQueryPage Node Description Type Id ID of the activity. String LSSGOP_Activity 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 365. Table 365. LSSGOP_Activity Service Object Name Boundary Object Type Class LSSGOP_Activity Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 192
- 193. Siebel CRM Primary Web Services ■ LSSGOP_ActivityContact Data Object (Integration Object) For a description of the data objects for this Web service, see Table 366. Table 366. LSSGOP_Activity Data Object Siebel Repository Name External Name LS SGOP_Activity LS SGOP_Activity Interface Description (WSDL) for LSSGOP_Activity 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. ...LSSGOP_Activityhttp_siebel.com_asi_LSSGOP_Activity.WSDL LSSGOP_ActivityContact Use this Web service to create, update, delete, and query records in the ActivityContacts object. LSSGOP_ActivityContact Operations This Web service allows you to create, update, delete, and query records in the ActivityContact object. For a list of operations, see Table 367. Table 367. LSSGOP_ActivityContact Operations Name Description ActivityContactInsert Creates an activitycontact record. ActivityContactUpdate Updates an existing activitycontact record. ActivityContactDelete Deletes an activitycontact record. ActivityContactQueryPage Queries for an activitycontact record. Request Message Description: ActivityContactInsert For a description of this request message, see Table 368. Table 368. Request Message Description: ActivityContactInsert Node Description Type ActivityId Activity ID. String ContactId Contact ID. String Siebel CRM Web Services Reference Version 8.1/8.2 193
- 194. Siebel CRM Primary Web Services ■ LSSGOP_ActivityContact Response Message Description: ActivityContactInsert For a description of this response message, see Table 369. Table 369. Response Message Description: ActivityContactInsert Node Description Type Id ID of the newly created Request Message Description: ActivityContactUpdate For a description of this request message, see Table 370. Response Message Description: ActivityContactUpdate For a description of this response message, see Table 371. Request Message Description: ActivityContactDelete For a description of this request message, see Table 372. Siebel CRM Web Services Reference Version 8.1/8.2 194 activitycontact record. String Table 370. Request Message Description: ActivityContactUpdate Node Description Type Id ID of the activitycontact record. String ActivityId ActivityId of the activitycontact record. String ContactId ContactId of the activitycontact record. String Table 371. Response Message Description: ActivityContactUpdate Node Description Type Id ID of the updated activitycontact record. String Table 372. Request Message Description: ActivityContactDelete Node Description Type Id ID of the activitycontact record to be deleted. String
- 195. Siebel CRM Primary Web Services ■ LSSGOP_ActivityContact Response Message Description: ActivityContactDelete For a description of this response message, see Table 373. Table 373. Request Message Description: ActivityContactDelete Node Description Type Id ID of the activitycontact record to be deleted. Request Message Description: ActivityContactQueryPage For a description of this request message, see Table 374. Table 374. Request Message Description: ActivityContactQueryPage Node Description Type Id ID of the activitycontact record to be queried. Response Message Description: AccountQueryPage For a description of this response message, see Table 375. String String Table 375. Response Message Description: AccountQueryPage Node Description Type Id ID of the activitycontact record. String LSSGOP_ActivityContact 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 376. Table 376. LSSGOP_ActivityContact Service Object Name Boundary Object Type Class LSSGOP_ActivityContact Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 195
- 196. Siebel CRM Primary Web Services ■ LSSGOP_CatalogCategory Data Object (Integration Object) For a description of the data objects for this Web service, see Table 377. Table 377. LSSGOP_ActivityContact Data Object Siebel Repository Name External Name LS SGOP_ActivityContact LS SGOP_ActivityContact Interface Description (WSDL) for LSSGOP_ActivityContact 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. ...LSSGOP_ActivityContacthttp_siebel.com_asi_LSSGOP_ActivityContact.WSDL LSSGOP_CatalogCategory Use this Web service to create, update, delete, and query records in the CatalogCategory object. LSSGOP_CatalogCategory Operations This Web service allows you to create, update, delete, and query records in the CatalogCategory object. For a list of operations, see Table 378. Table 378. LSSGOP_CatalogCategory Operations Name Description CatalogCategoryInsert Creates a catalogcategory record. CatalogCategoryUpdate Updates an existing catalogcategory record. CatalogCategoryDelete Deletes a catalogcategory record. CatalogCategoryQueryPage Queries for a catalogcategory record. Request Message Description: CatalogCategoryInsert For a description of this request message, see Table 379. Table 379. Request Message Description: CatalogCategoryInsert Node Description Type Name Name of the catalog to be Siebel CRM Web Services Reference Version 8.1/8.2 196 inserted. String
- 197. Siebel CRM Primary Web Services ■ LSSGOP_CatalogCategory Response Message Description: CatalogCategoryInsert For a description of this response message, see Table 380. Table 380. Response Message Description: CatalogCategoryInsert Node Description Type Id ID of the newly created catalogcategory record. Request Message Description: CatalogCategoryUpdate For a description of this request message, see Table 381. Table 381. Request Message Description: CatalogCategoryUpdate Node Description Type Id ID of the catalogcategory record. String Name Name of the catalogcategory record. Response Message Description: CatalogCategoryUpdate For a description of this response message, see Table 382. Table 382. Response Message Description: CatalogCategoryUpdate Node Description Type Id ID of the updated catalogcategory record. Request Message Description: CatalogCategoryDelete For a description of this request message, see Table 383. Table 383. Request Message Description: CatalogCategoryDelete Node Description Type Id ID of the catalogcategory record to be deleted. Response Message Description: CatalogCategoryDelete For a description of this response message, see Table 384. String String String String Table 384. Response Message Description: CatalogCategoryDelete Node Description Type Id ID of the deleted catalogcategory record. String Siebel CRM Web Services Reference Version 8.1/8.2 197
- 198. Siebel CRM Primary Web Services ■ LSSGOP_CatalogCategory Request Message Description: CatalogCategoryQueryPage For a description of this request message, see Table 385. Table 385. Request Message Description: CatalogCategoryQueryPage Node Description Type Id ID of the catalogcategory record to Response Message Description: CatalogCategoryQueryPage For a description of this response message, see Table 386. LSSGOP_CatalogCategory 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 387. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 388. Interface Description (WSDL) for LSSGOP_CatalogCategory 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. ...LSSGOP_CatalogCategoryhttp_siebel.com_asi_LSSGOP_CatalogCategory.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 198 be queried. String Table 386. Response Message Description: CatalogCategoryQueryPage Node Description Type Id ID of the catalogcategory record. String Table 387. LSSGOP_CatalogCategory Service Object Name Boundary Object Type Class LSSGOP_CatalogCategory Business Service CSSEAIUIDataService Table 388. LSSGOP_CatalogCategory Data Object Siebel Repository Name External Name LS SGOP_CatalogCategory LS SGOP_CatalogCategory
- 199. Siebel CRM Primary Web Services ■ LSSGOP_Contact LSSGOP_Contact Use this Web service to create, update, delete, and query records in the Contact object. LSSGOP_Contact Operations This Web service allows you to create, update, delete, and query records in the Contact object. For a list of operations, see Table 389. Table 389. LSSGOP_Contact Operations Name Description ContactInsert Creates a contact. ContactUpdate Updates an existing contact. ContactDelete Deletes a contact. ContactQueryPage Queries for a contact. Request Message Description: ContactInsert For a description of this request message, see Table 390. Table 390. Request Message Description: ContactInsert Node Description Type FirstName First name of the new contact to be inserted. LastName Last name of the new contact to be inserted. PersonUId A unique person ID. String Response Message Description: ContactInsert For a description of this response message, see Table 391. String String Table 391. Response Message Description: ContactInsert Node Description Type Id ID of the newly created contact. String Siebel CRM Web Services Reference Version 8.1/8.2 199
- 200. Siebel CRM Primary Web Services ■ LSSGOP_Contact Request Message Description: ContactUpdate For a description of this request message, see Table 392. Table 392. Request Message Description: ContactUpdate Node Description Type Id ID of the contact. String FirstName First name of the contact. String LastName Last name of the contact. String PersonUId Person UId of the contact. String Response Message Description: ContactUpdate For a description of this response message, see Table 393. Table 393. Response Message Description: ContactUpdate Node Description Type Id ID of the updated contact. String Request Message Description: ContactDelete For a description of this request message, see Table 394. Table 394. Request Message Description: ContactDelete Node Description Type Id ID of the contact to be deleted. String Response Message Description: ContactDelete For a description of this response message, see Table 395. Table 395. Response Message Description: ContactDelete Node Description Type Id ID of the deleted contact. String Request Message Description: ContactQueryPage For a description of this request message, see Table 396. Table 396. Request Message Description: ContactQueryPage Node Description Type Id ID of the contact to be queried. String Siebel CRM Web Services Reference Version 8.1/8.2 200
- 201. Siebel CRM Primary Web Services ■ LSSGOP_ContactAccount Response Message Description: ContactQueryPage For a description of this response message, see Table 397. Table 397. Response Message Description: ContactQueryPage Node Description Type Id ID of the contact. String LSSGOP_Contact 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 398. Table 398. LSSGOP_Contact Service Object Name Boundary Object Type Class LSSGOP_Contact Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 399. Table 399. LSSGOP_Contact Data Object Siebel Repository Name External Name LS SGOP_Contact LS SGOP_Contact Interface Description (WSDL) for LSSGOP_Contact 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. ...LSSGOP_Contacthttp_siebel.com_asi_LSSGOP_Contact.WSDL LSSGOP_ContactAccount Use this Web service to create, update, delete, and query records in the Contact Account object. Siebel CRM Web Services Reference Version 8.1/8.2 201
- 202. Siebel CRM Primary Web Services ■ LSSGOP_ContactAccount LSSGOP_ContactAccount Operations This Web service allows you to create, update, delete and query the ContactAccount object. For a list of operations, see Table 400. Table 400. LSSGOP_ContactAccount Operations Name Description ContactAccountInsert Creates a contactaccount record. ContactAccountUpdate Updates an existing contactaccount record. ContactAccountDelete Deletes a contactaccount record. ContactAccountQueryPage Queries for a contactaccount record. Request Message Description: ContactAccountInsert For a description of this request message, see Table 401. Table 401. Request Message Description: ContactAccountInsert Node Description Type ContactId ID of a contact. String AccountId ID of an account. String Response Message Description: ContactAccountInsert For a description of this response message, see Table 402. Table 402. Response Message Description: ContactAccountInsert Node Description Type Id ID of the newly created Request Message Description: ContactAccountUpdate For a description of this request message, see Table 403. Siebel CRM Web Services Reference Version 8.1/8.2 202 contactaccount record. String Table 403. Request Message Description: ContactAccountUpdate Node Description Type Id ID of the contactaccount record. String ContactId ContactId of the corresponding record. String AccountId AccountId of the corresponding record. String
- 203. Siebel CRM Primary Web Services ■ LSSGOP_ContactAccount Response Message Description: ContactAccountUpdate For a description of this response message, see Table 404. Table 404. Response Message Description: ContactAccountUpdate Node Description Type Id ID of the updated contactaccount. String Request Message Description: ContactAccountDelete For a description of this request message, see Table 405. Table 405. Request Message Description: ContactAccountDelete Node Description Type Id ID of the contactaccount record to be deleted. Response Message Description: ContactAccountDelete For a description of this response message, see Table 406. Table 406. Response Message Description: ContactAccountDelete Node Description Type Id ID of the deleted contactaccount record. Request Message Description: ContactAccountQueryPage For a description of this request message, see Table 407. Table 407. Request Message Description: ContactAccountQueryPage Node Description Type Id ID of the contactaccount to be queried record. Response Message Description: ContactAccountQueryPage For a description of this response message, see Table 408. String String String Table 408. Response Message Description: ContactAccountQueryPage Node Description Type Id ID of the contactaccount record. String Siebel CRM Web Services Reference Version 8.1/8.2 203
- 204. Siebel CRM Primary Web Services ■ LSSGOP_ContactAddress LSSGOP_ContactAccount 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 409. Table 409. LSSGOP_ContactAccount Service Object Name Boundary Object Type Class LSSGOP_ContactAccount Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 410. Table 410. LSSGOP_ContactAccount Data Object Siebel Repository Name External Name LS SGOP_ContactAccount LS SGOP_ContactAccount Interface Description (WSDL) for LSSGOP_ContactAccount 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. ...LSSGOP_ContactAccounthttp_siebel.com_asi_LSSGOP_ContactAccount.WSDL LSSGOP_ContactAddress Use this Web service to create, update, delete, and query records in the ContactAddress object. LSSGOP_ContactAddress Operations This Web service allows you to create, update, delete, and query records in the ContactAddress object. For a list of operations, see Table 411. Table 411. LSSGOP_ContactAddress Operations Name Description ContactAddressInsert Creates a new contactaddress record. ContactAddressUpdate Updates an existing contactaddress record. Siebel CRM Web Services Reference Version 8.1/8.2 204
- 205. Siebel CRM Primary Web Services ■ LSSGOP_ContactAddress Table 411. LSSGOP_ContactAddress Operations Name Description ContactAddressDelete Deletes a contactaddress record. ContactAddressQueryPage Queries for a contactaddress record. Request Message Description: ContactAddressInsert For a description of this request message, see Table 412. Table 412. Request Message Description: ContactAddressInsert Node Description Type ContactId ID of the contact to be inserted. String AddressId ID of the address to associate to the contact. Response Message Description: ContactAddressInsert For a description of this response message, see Table 413. Table 413. Response Message Description: ContactAddressInsert Node Description Type Id ID of the newly created contactaddress record. Request Message Description: ContactAddressUpdate For a description of this request message, see Table 414. String String Table 414. Request Message Description: ContactAddressUpdate Node Description Type Id ID of the contactaddress record. String ContactId Contact ID of the corresponding record. String AddressId Address ID of the corresponding record. String Siebel CRM Web Services Reference Version 8.1/8.2 205
- 206. Siebel CRM Primary Web Services ■ LSSGOP_ContactAddress Response Message Description: ContactAddressUpdate For a description of this response message, see Table 415. Table 415. Response Message Description: ContactAddressUpdate Node Description Type Id ID of the updated contactaddress Request Message Description: ContactAddressDelete For a description of this request message, see Table 416. Response Message Description: ContactAddressDelete For a description of this response message, see Table 417. Request Message Description: ContactAddressQueryPage For a description of this request message, see Table 418. Response Message Description: ContactAddressQueryPage For a description of this response message, see Table 419. Siebel CRM Web Services Reference Version 8.1/8.2 206 record. String Table 416. Request Message Description: ContactAddressDelete Node Description Type Id ID of the contactaddress record to be deleted. String Table 417. Response Message Description: ContactAddressDelete Node Description Type Id ID of the deleted contactaddress record. String Table 418. Request Message Description: ContactAddressQueryPage Node Description Type Id ID of the contactaddress record to be queried. String Table 419. Response Message Description: ContactAddressQueryPage Node Description Type Id ID of the contactaddress record. String
- 207. Siebel CRM Primary Web Services ■ LSSGOP_ContactBestTime LSSGOP_ContactAddress 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 420. Table 420. LSSGOP_ContactAddress Service Object Name Boundary Object Type Class LSSGOP_ContactAddress Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 421. Table 421. LSSGOP_ContactAddress Data Object Siebel Repository Name External Name LS SGOP_ContactAddress LS SGOP_ContactAddress Interface Description (WSDL) for LSSGOP_ContactAddress 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. ...LSSGOP_ContactAddresshttp_siebel.com_asi_LSSGOP_ContactAddress.WSDL LSSGOP_ContactBestTime Use this Web service to create, update, delete, and query records in the ContactBestTime object. LSSGOP_ContactBestTime Operations This Web service allows you to create, update, delete, and query records in the ContactBestTime object. For a list of operations, see Table 422. Table 422. LSSGOP_ContactBestTime Operations Name Description ContactBestTimeInsert Creates a contactbesttime record. ContactBestTimeUpdate Updates an existing contactbesttime record. Siebel CRM Web Services Reference Version 8.1/8.2 207
- 208. Siebel CRM Primary Web Services ■ LSSGOP_ContactBestTime ContactBestTimeDelete Deletes a contactbesttime record. ContactBestTimeQueryPage Queries for a contactbesttime record. Request Message Description: ContactBestTimeInsert For a description of this request message, see Table 423. Table 423. Request Message Description: ContactBestTimeInsert Node Description Type ContactId ID of the contact to be inserted. String ContactAddressId ID of the contactaddress to be Response Message Description: ContactBestTimeInsert For a description of this response message, see Table 424. Request Message Description: ContactBestTimeUpdate For a description of this request message, see Table 425. Siebel CRM Web Services Reference Version 8.1/8.2 208 inserted. String StartDay Start day. String StartTime Start time. String Table 424. Response Message Description: ContactBestTimeInsert Node Description Type Id ID of the newly created contactbesttime record. String Table 425. Request Message Description: ContactBestTimeUpdate Node Description Type Id ID of the contactbesttime record. String ContactId Contact ID of the corresponding record. String ContactAddressId Contact address ID of the corresponding record. String StartDay Start day of the corresponding record. String Table 422. LSSGOP_ContactBestTime Operations Name Description
- 209. Siebel CRM Primary Web Services ■ LSSGOP_ContactBestTime Response Message Description: ContactBestTimeUpdate For a description of this response message, see Table 426. Table 426. Response Message Description: ContactBestTimeUpdate Node Description Type Id ID of the updated contactbesttime record. Request Message Description: ContactBestTimeDelete For a description of this request message, see Table 427. Table 427. Request Message Description: ContactBestTimeDelete Node Description Type Id ID of the contactbesttime record to be deleted. Response Message Description: ContactBestTimeDelete For a description of this response message, see Table 428. Table 428. Response Message Description: ContactBestTimeDelete Node Description Type Id ID of the deleted contactbesttime record. Request Message Description: ContactBestTimeQueryPage For a description of this request message, see Table 429. Table 429. Request Message Description: ContactBestTimeQueryPage Node Description Type Id ID of the contactbesttime record to be queried. Response Message Description: ContactBestTimeQueryPage For a description of this response message, see Table 430. String String String String Table 430. Response Message Description: ContactBestTimeQueryPage Node Description Type Id ID of the contactbesttime record. String Siebel CRM Web Services Reference Version 8.1/8.2 209
- 210. Siebel CRM Primary Web Services ■ LSSGOP_ContactLicense LSSGOP_ContactBestTime 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 431. Table 431. LSSGOP_ContactBestTime Service Object Name Boundary Object Type Class LSSGOP_ContactBestTime Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 432. Table 432. LSSGOP_ContactBestTime Data Object Siebel Repository Name External Name LS SGOP_ContactBestTime LS SGOP_ContactBestTime Interface Description (WSDL) for LSSGOP_ContactBestTime 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. ...LSSGOP_ContactBestTimehttp_siebel.com_asi_LSSGOP_ContactBestTime.WSDL LSSGOP_ContactLicense Use this Web service to create, update, delete, and query records in the ContactLicence object. LSSGOP_ContactLicense Operations This Web service allows you to create, update, delete, and query records in the ContactLicense object. For a list of operations, see Table 433. Table 433. LSSGOP_ContactLicense Operations Name Description ContactLicenseInsert Creates a contactlicense record. ContactLicenseUpdate Updates an existing contactlicense record. Siebel CRM Web Services Reference Version 8.1/8.2 210
- 211. Siebel CRM Primary Web Services ■ LSSGOP_ContactLicense Table 433. LSSGOP_ContactLicense Operations Name Description ContactLicenseDelete Deletes a contactlicense record. ContactLicenseQueryPage Queries for a contactlicense record. Request Message Description: ContactLicenseInsert For a description of this request message, see Table 434. Table 434. Request Message Description: ContactLicenseInsert Node Description Type ProfessionalId ID of the contact. String State State of the contact. String LicenseExpiryDate Expiration date of the license. String LicenseNumber License number. String Response Message Description: ContactLicenseInsert For a description of this response message, see Table 435. Table 435. Response Message Description: ContactLicenseInsert Node Description Type Id ID of the newly created account record. Request Message Description: ContactLicenseUpdate For a description of this request message, see Table 436. String Table 436. Request Message Description: ContactLicenseUpdate Node Description Type Id ID of the contactlicense record. String ProfessionalId Professional ID of the corresponding record. String State State of the corresponding record. String Siebel CRM Web Services Reference Version 8.1/8.2 211
- 212. Siebel CRM Primary Web Services ■ LSSGOP_ContactLicense Response Message Description: ContactLicenseUpdate For a description of this response message, see Table 437. Table 437. Response Message Description: ContactLicenseUpdate Node Description Type Id ID of the updated contactlicense String Request Message Description: ContactLicenseDelete For a description of this request message, see Table 438. Table 438. Request Message Description: ContactLicenseDelete Node Description Type Id ID of the contactlicense record to Response Message Description: ContactLicenseDelete For a description of this response message, see Table 439. Request Message Description: ContactLicenseQueryPage For a description of this request message, see Table 440. Response Message Description: ContactLicenseQueryPage For a description of this response message, see Table 441. Siebel CRM Web Services Reference Version 8.1/8.2 212 be deleted. String Table 439. Response Message Description: ContactLicenseDelete Node Description Type Id ID of the deleted contactlicense record. String Table 440. Request Message Description: ContactLicenseQueryPage Node Description Type Id ID of the contactlicense record to be queried. String Table 441. Response Message Description: ContactLicenseQueryPage Node Description Type Id ID of the contactlicense record. String
- 213. Siebel CRM Primary Web Services ■ LSSGOP_CurrentUser LSSGOP_ContactLicense 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 442. Table 442. LSSGOP_ContactLicense Service Object Name Boundary Object Type Class LSSGOP_ContactLicense Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 443. Table 443. LSSGOP_ContactLicense Data Object Siebel Repository Name External Name LS SGOP_ContactLicense LS SGOP_ContactLicense Interface Description (WSDL) for LSSGOP_ContactLicense 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. ...LSSGOP_ContactLicensehttp_siebel.com_asi_LSSGOP_ContactLicense.WSDL LSSGOP_CurrentUser Use this Web service to query records in the Current user object. LSSGOP_CurrentUser Operations This Web service allows you to query the CurrentUser object. For a list of operations, see Table 444. Table 444. LSSGOP_CurrentUser Operations Name Description CurrentUserQueryPage Queries for the currentuser record. Siebel CRM Web Services Reference Version 8.1/8.2 213
- 214. Siebel CRM Primary Web Services ■ LSSGOP_CurrentUser Request Message Description: CurrentUserQueryPage For a description of this request message, see Table 445. Table 445. Request Message Description: CurrentUserQueryPage Node Description Type Id ID of the current user to be Response Message Description: CurrentUserQueryPage For a description of this response message, see Table 446. LSSGOP_CurrentUser 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 447. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 448. Interface Description (WSDL) for LSSGOP_CurrentUser 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. ...LSSGOP_CurrentUserhttp_siebel.com_asi_LSSGOP_CurrentUser.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 214 queried. String Table 446. Response Message Description: CurrentUserQueryPage Node Description Type Id ID the current user. String Table 447. LSSGOP_CurrentUser Service Object Name Boundary Object Type Class LSSGOP_CurrentUser Business Service CSSEAIUIDataService Table 448. LSSGOP_CurrentUser Data Object Siebel Repository Name External Name LS SGOP_CurrentUser LS SGOP_CurrentUser
- 215. Siebel CRM Primary Web Services ■ LSSGOP_LanguageLOV LSSGOP_LanguageLOV Use this Web service to query for records in the LanguageLOV object. LSSGOP_LanguageLOV Operations Use this Web service to query for records in the LanguageLOV object. For a list of operations, see Table 449. Table 449. LSSGOP_LanguageLOV Operations Name Description LanguageLOVQueryPage Queries for the list of values. Request Message Description: LanguageLOVQueryPage For a description of this request message, see Table 450. Table 450. Request Message Description: LanguageLOVQueryPage Node Description Type Id ID of the LOV queried. String Response Message Description: LanguageLOVQueryPage For a description of this response message, see Table 451. Table 451. Response Message Description: LanguageLOVQueryPage Node Description Type Id ID of the LOV. String LSSGOP_LanguageLOV 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 452. Table 452. LSSGOP_LanguageLOV Service Object Name Boundary Object Type Class LSSGOP_LanguageLOV Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 215
- 216. Siebel CRM Primary Web Services ■ LSSGOP_Literature Data Object (Integration Object) For a description of the data objects for this Web service, see Table 453. Table 453. LSSGOP_LanguageLOV Data Object Siebel Repository Name External Name LS SGOP_LanguageLOV LS SGOP_LanguageLOV Interface Description (WSDL) for LSSGOP_LanguageLOV 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. ...LSSGOP_LanguageLOVhttp_siebel.com_asi_LSSGOP_LanguageLOV.WSDL LSSGOP_Literature Use this Web service to create, update, delete, and query records in the Literature object. LSSGOP_Literature Operations This Web service allows you to create, update, delete and query records in the Literature object using Sales Rep visibility. For a list of operations, see Table 454. Table 454. LSSGOP_Literature Operations Name Description LiteratureInsert Creates a literature. LiteratureUpdate Update an existing literature. LiteratureDelete Delete a literature. LiteratureQueryPage Query for a literature. Request Message Description: LiteratureInsert For a description of this request message, see Table 455. Table 455. Request Message Description: LiteratureInsert Node Description Type Name Name of the literature record. String FileName The file name of the literature Siebel CRM Web Services Reference Version 8.1/8.2 216 record. String RelationshipType Relationship type for the literature record. String
- 217. Siebel CRM Primary Web Services ■ LSSGOP_Literature Response Message Description: LiteratureInsert For a description of this response message, see Table 456. Table 456. Response Message Description: LiteratureInsert Node Description Type Id ID of the newly created literature record. Request Message Description: LiteratureUpdate For a description of this request message, see Table 457. Table 457. Request Message Description: LiteratureUpdate Node Description Type Id ID of the literature record. String Name Name of the corresponding record. String FileName File name of the corresponding record. RelationshipType Relationship type of the corresponding record. Response Message Description: LiteratureUpdate For a description of this response message, see Table 458. Table 458. Response Message Description: LiteratureUpdate Node Description Type Id ID of the updated literature record. Request Message Description: LiteratureDelete For a description of this request message, see Table 459. String String String String Table 459. Request Message Description: LiteratureDelete Node Description Type Id ID of the literature record to be deleted. String Siebel CRM Web Services Reference Version 8.1/8.2 217
- 218. Siebel CRM Primary Web Services ■ LSSGOP_Literature Response Message Description: LiteratureDelete For a description of this response message, see Table 460. Table 460. Response Message Description: LiteratureDelete Node Description Type Id ID of the deleted literature record. String Request Message Description: LiteratureQueryPage For a description of this request message, see Table 461. Table 461. Request Message Description: LiteratureQueryPage Node Description Type Id ID of the literature record to be Response Message Description: LiteratureQueryPage For a description of this response message, see Table 462. LSSGOP_Literature 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 463. Siebel CRM Web Services Reference Version 8.1/8.2 218 queried. String Table 462. Response Message Description: LiteratureQueryPage Node Description Type Id ID of the literature record. String Table 463. LSSGOP_Literature Service Object Name Boundary Object Type Class LSSGOP_Literature Business Service CSSEAIUIDataService
- 219. Siebel CRM Primary Web Services ■ LSSGOP_Literature_ALL Data Object (Integration Object) For a description of the data objects for this Web service, see Table 464. Table 464. LSSGOP_Literature Data Object Siebel Repository Name External Name LS SGOP_Literature LS SGOP_Literature Interface Description (WSDL) for LSSGOP_Literature 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. ...LSSGOP_Literaturehttp_siebel.com_asi_LSSGOP_Literature.WSDL LSSGOP_Literature_ALL Use this Web service to create, update, delete, and query records in the Literature_ALL object. LSSGOP_Literature_ALL Operations This Web service allows you to create, update, delete, and query records in the Literature_ALL object using Administrator visibility. For a list of operations, see Table 465. Table 465. LSSGOP_Literature_ALL Operations Name Description Literature_ALLInsert Creates a literature. Literature_ALLUpdate Update an existing literature. Literature_ALLDelete Delete a literature. Literature_ALLQueryPage Query for a literature. Request Message Description: Literature_ALLInsert For a description of this request message, see Table 466. Table 466. Request Message Description: Literature_ALLInsert Node Description Type Name Name of the literature record to be inserted. String FileName File name of the literature record. String RelationshipType Relationship type. String Siebel CRM Web Services Reference Version 8.1/8.2 219
- 220. Siebel CRM Primary Web Services ■ LSSGOP_Literature_ALL Response Message Description: Literature_ALLInsert For a description of this response message, see Table 467. Table 467. Response Message Description: Literature_ALLInsert Node Description Type Id ID of the newly created Literature Request Message Description: Literature_ALLUpdate For a description of this request message, see Table 468. Response Message Description: Literature_ALLUpdate For a description of this response message, see Table 469. Request Message Description: Literature_ALLDelete For a description of this request message, see Table 470. Siebel CRM Web Services Reference Version 8.1/8.2 220 All record. String Table 468. Request Message Description: Literature_ALLUpdate Node Description Type Id ID of the literature record. String Name Name of the corresponding record. String FileName File name of the corresponding record. String RelationshipType Relationship type of the corresponding record. String Table 469. Response Message Description: Literature_ALLUpdate Node Description Type Id ID of the updated literature record. String Table 470. Request Message Description: Literature_ALLDelete Node Description Type Id ID of the literature record to be deleted. String
- 221. Siebel CRM Primary Web Services ■ LSSGOP_Literature_ALL Response Message Description: Literature_ALLDelete For a description of this response message, see Table 471. Table 471. Response Message Description: Literature_ALLDelete Node Description Type Id ID of the deleted literature record. String Request Message Description: Literature_ALLQueryPage For a description of this request message, see Table 472. Table 472. Response Message Description: Literature_ALLDelete Node Description Type Id ID of the literature record to be queried. Response Message Description: Literature_ALLDelete For a description of this response message, see Table 473. String Table 473. Response Message Description: Literature_ALLDelete Node Description Type Id ID of the literature record. String LSSGOP_Literature_ALL 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 474. Table 474. LSSGOP_Literature_ALL Service Object Name Boundary Object Type Class LSSGOP_Literature_ALL Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 221
- 222. Siebel CRM Primary Web Services ■ LSSGOP_LiteratureCatalog Data Object (Integration Object) For a description of the data objects for this Web service, see Table 475. Table 475. LSSGOP_Literature_ALL Data Object Siebel Repository Name External Name LS SGOP_Literature_ALL LS SGOP_Literature_ALL Interface Description (WSDL) for LSSGOP_Literature_ALL 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. ...LSSGOP_Literature_ALLhttp_siebel.com_asi_LSSGOP_Literature_ALL.WSDL LSSGOP_LiteratureCatalog Use this Web service to create, update, delete, and query records in the LiteratureCatalog object. LSSGOP_LiteratureCatalog Operations This Web service allows you to create, update, delete, and query records in the Literature Catalog object. For a list of operations, see Table 476. Table 476. LSSGOP_LiteratureCatalog Operations Name Description LiteratureCatalogInsert Creates a literaturecatalog record. LiteratureCatalogUpdate Updates an existing literaturecatalog record. LiteratureCatalogDelete Deletes a literaturecatalog record. LiteratureCatalogQueryPage Queries for a literaturecatalog record. Request Message Description: LiteratureCatalogInsert For a description of this request message, see Table 477. Table 477. Request Message Description: LiteratureCatalogInsert Node Description Type CtlgCatId ID of the catalog category to which Siebel CRM Web Services Reference Version 8.1/8.2 222 the literature is to be associated. String LitId ID of the literature record. String LitName Name of the literature record. String
- 223. Siebel CRM Primary Web Services ■ LSSGOP_LiteratureCatalog Response Message Description: LiteratureCatalogInsert For a description of this response message, see Table 478. Table 478. Response Message Description: LiteratureCatalogInsert Node Description Type Id ID of the newly created literaturecatalog record. Request Message Description: LiteratureCatalogUpdate For a description of this request message, see Table 479. Table 479. Request Message Description: LiteratureCatalogUpdate Node Description Type Id ID of the literaturecatalog record. String CtlgCatId CtigCatId of the corresponding record. LitId Literature ID of the corresponding record. LitName Literature Name of the corresponding record. Response Message Description: LiteratureCatalogUpdate For a description of this response message, see Table 480. Table 480. Response Message Description: LiteratureCatalogUpdate Node Description Type Id ID of the updated literaturecatalog record. Request Message Description: LiteratureCatalogDelete For a description of this request message, see Table 481. String String String String String Table 481. Request Message Description: LiteratureCatalogDelete Node Description Type Id ID of the literaturecatalog record to be deleted. String Siebel CRM Web Services Reference Version 8.1/8.2 223
- 224. Siebel CRM Primary Web Services ■ LSSGOP_LiteratureCatalog Response Message Description: LiteratureCatalogDelete For a description of this response message, see Table 482. Table 482. Response Message Description: LiteratureCatalogDelete Node Description Type Id ID of the deleted literaturecatalog Request Message Description: LiteratureCatalogQueryPage For a description of this request message, see Table 483. Response Message Description: LiteratureCatalogQueryPage For a description of this response message, see Table 484. LSSGOP_LiteratureCatalog 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 485. Siebel CRM Web Services Reference Version 8.1/8.2 224 record. String Table 483. Request Message Description: LiteratureCatalogQueryPage Node Description Type Id ID of the literaturecatalog record to be queried. String Table 484. Response Message Description: LiteratureCatalogQueryPage Node Description Type Id ID of the literaturecatalog record. String Table 485. LSSGOP_LiteratureCatalog Service Object Name Boundary Object Type Class LSSGOP_LiteratureCatalog Business Service CSSEAIUIDataService
- 225. Siebel CRM Primary Web Services ■ LSSGOP_MessagePlan Data Object (Integration Object) For a description of the data objects for this Web service, see Table 486. Table 486. LSSGOP_LiteratureCatalog Data Object Siebel Repository Name External Name LS SGOP_LiteratureCatalog LS SGOP_LiteratureCatalog Interface Description (WSDL) for LSSGOP_LiteratureCatalog 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. ...LSSGOP_LiteratureCataloghttp_siebel.com_asi_LSSGOP_LiteratureCatalog.WSDL LSSGOP_MessagePlan Use this Web service to create, update, delete, and query records in the MessagePlan object. LSSGOP_MessagePlan Operations This Web service allows you to create, update, delete and query records in the MessagePlan object using Sales Rep visibility. For a list of operations, see Table 487. Table 487. LSSGOP_MessagePlan Operations Name Description MessagePlanInsert Creates a messageplan record. MessagePlanUpdate Updates an existing messageplan record. MessagePlanDelete Deletes a messageplan record. MessagePlanQueryPage Queries for the messageplan record. Request Message Description: MessagePlanInsert For a description of this request message, see Table 488. Table 488. Request Message Description: MessagePlanInsert Node Description Type Name Name of the corresponding record. String MessagePlanType Message plan type of the corresponding record. String Owner Owner of the corresponding record. String Siebel CRM Web Services Reference Version 8.1/8.2 225
- 226. Siebel CRM Primary Web Services ■ LSSGOP_MessagePlan Table 488. Request Message Description: MessagePlanInsert Node Description Type Position Position of the corresponding Response Message Description: MessagePlanInsert For a description of this response message, see Table 489. Request Message Description: MessagePlanUpdate For a description of this request message, see Table 490. Siebel CRM Web Services Reference Version 8.1/8.2 226 record. String Product Product of the corresponding record. String Status Status of the corresponding record. String Version Version of the corresponding record. String Table 489. Response Message Description: MessagePlanInsert Node Description Type Id ID of the newly created messageplan record. String Table 490. Request Message Description: MessagePlanUpdate Node Description Type Id ID of the messageplan. String Name Name of the corresponding record. String MessagePlanType Message plan type of the corresponding record. String Owner Owner of the corresponding record. String Position Position of the corresponding record. String Product Product of the corresponding record. String Status Status of the corresponding record. String Version Version of the corresponding record. String
- 227. Siebel CRM Primary Web Services ■ LSSGOP_MessagePlan Response Message Description: MessagePlanUpdate For a description of this response message, see Table 491. Table 491. Response Message Description: MessagePlanUpdate Node Description Type Id Id of the updated messageplan record. Request Message Description: MessagePlanDelete For a description of this request message, see Table 492. Table 492. Request Message Description: MessagePlanDelete Node Description Type Id ID of the messageplan record to be deleted. Response Message Description: MessagePlanDelete For a description of this response message, see Table 493. Table 493. Response Message Description: MessagePlanDelete Node Description Type Id ID of the deleted messageplan record. Request Message Description: MessagePlanQueryPage For a description of this request message, see Table 494. Table 494. Request Message Description: MessagePlanQueryPage Node Description Type Id ID of the messageplan to be queried Response Message Description: MessagePlanQueryPage For a description of this response message, see Table 495. String String String String Table 495. Response Message Description: MessagePlanQueryPage Node Description Type Id ID of the messageplan String Siebel CRM Web Services Reference Version 8.1/8.2 227
- 228. Siebel CRM Primary Web Services ■ LSSGOP_MessagePlan_ALL LSSGOP_MessagePlan 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 496. Table 496. LSSGOP_MessagePlan Service Object Name Boundary Object Type Class LSSGOP_MessagePlan Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 497. Table 497. LSSGOP_MessagePlan Data Object Siebel Repository Name External Name LS SGOP_MessagePlan LS SGOP_MessagePlan Interface Description (WSDL) for LSSGOP_MessagePlan 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. ...LSSGOP_MessagePlanhttp_siebel.com_asi_LSSGOP_MessagePlan.WSDL LSSGOP_MessagePlan_ALL Use this Web service to create, update, delete, and query records in the MessagePlan_ALL object. LSSGOP_MessagePlan_ALL Operations This Web service allows you to create, update, delete, and query records in the MessagePlan_ALL object using Administrator visibility. For a list of operations, see Table 498. Table 498. LSSGOP_MessagePlan_ALL Operations Name Description MessagePlan_ALLInsert Creates a messageplan record. MessagePlan_ALLUpdate Updates an existing messageplan record. Siebel CRM Web Services Reference Version 8.1/8.2 228
- 229. Siebel CRM Primary Web Services ■ LSSGOP_MessagePlan_ALL Table 498. LSSGOP_MessagePlan_ALL Operations Name Description MessagePlan_ALLDelete Deletes a messageplan record. MessagePlan_ALLQueryPage Queries for a messageplan record. Request Message Description: MessagePlan_ALLInsert For a description of this request message, see Table 499. Table 499. Request Message Description: MessagePlan_ALLInsert Node Description Type Name Name the message plan to be inserted. MessagePlanType Type of message plan. String Owner The message plan owner. String Position The position of the message plan owner. Product The message plan product. String Status Status of the message plan. String Version The version of the message plan. String Response Message Description: MessagePlan_ALLInsert For a description of this response message, see Table 500. String String Table 500. Response Message Description: MessagePlan_ALLInsert Node Description Type Id ID of an newly created account. String Request Message Description: MessagePlan_ALLUpdate and MessagePlanUpdate For a description of this request message, see Table 501. Table 501. Request Message Description: MessagePlan_ALLUpdate and MessagePlanUpdate Node Description Type Id ID of the messageplan record. String Name Name of the corresponding record. String MessagePlanType MessagePlanType of the corresponding record. String Siebel CRM Web Services Reference Version 8.1/8.2 229
- 230. Siebel CRM Primary Web Services ■ LSSGOP_MessagePlan_ALL Table 501. Request Message Description: MessagePlan_ALLUpdate and MessagePlanUpdate Node Description Type Owner Owner of the corresponding Response Message Description: MessagePlan_ALLUpdate For a description of this response message, see Table 502. Request Message Description: MessagePlan_ALLDelete For a description of this request message, see Table 503. Response Message Description: MessagePlan_ALLDelete For a description of this response message, see Table 504. Siebel CRM Web Services Reference Version 8.1/8.2 230 record. String Position Position of the corresponding record. String Product Product of the corresponding record. String Status Status of the corresponding record. String Version Version of the corresponding record. String Table 502. Response Message Description: MessagePlan_ALLUpdate Node Description Type Id ID of an updated messageplan record. String Table 503. Request Message Description: MessagePlan_ALLDelete Node Description Type Id ID of the messageplan record to be deleted. String Table 504. Response Message Description: MessagePlan_ALLDelete Node Description Type Id ID of the deleted messageplan record. String
- 231. Siebel CRM Primary Web Services ■ LSSGOP_MessagePlan_ALL Request Message Description: MessagePlan_ALLQueryPage For a description of this request message, see Table 505. Table 505. Request Message Description: MessagePlan_ALLQueryPage Node Description Type Id ID of the messageplan record to be queried. Response Message Description: MessagePlan_ALLQueryPage For a description of this response message, see Table 506. String Table 506. Response Message Description: MessagePlan_ALLQueryPage Node Description Type Id ID of the messageplan record. String LSSGOP_MessagePlan_ALL 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 507. Table 507. LSSGOP_MessagePlan_ALL Service Object Name Boundary Object Type Class LSSGOP_MessagePlan_ALL Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 508. Table 508. LSSGOP_MessagePlan_ALL Data Object Siebel Repository Name External Name LS SGOP_MessagePlan_ALL LS SGOP_MessagePlan_ALL Interface Description (WSDL) for LSSGOP_MessagePlan_ALL 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. ...LSSGOP_MessagePlan_ALLhttp_siebel.com_asi_LSSGOP_MessagePlan_ALL.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 231
- 232. Siebel CRM Primary Web Services ■ LSSGOP_MessagePlanCatalog LSSGOP_MessagePlanCatalog Use this Web service to create, update, delete, and query records in the MessagePlanCatalog object. LSSGOP_MessagePlanCatalog Operations This Web service features four operations which allow you to create, update, delete, and query records in the MessagePlan Catalog object. For a list of operations, see Table 509. Table 509. LSSGOP_MessagePlanCatalog Operations Name Description MessagePlanCatalogInsert Creates a messageplancatalog record. MessagePlanCatalogUpdate Updates an existing messageplancatalog record. MessagePlanCatalogDelete Deletes a messageplancatalog record. MessagePlanCatalogQueryPage Queries for a messageplancatalog record. Request Message Description: MessagePlanCatalogInsert For a description of this request message, see Table 510. Table 510. Request Message Description: MessagePlanCatalogInsert Node Description Type CtlgCatId ID of the catalog category to be Response Message Description: MessagePlanCatalogInsert For a description of this response message, see Table 511. Siebel CRM Web Services Reference Version 8.1/8.2 232 associated with the message plan. String MsgPlanId ID of the message plan. String Table 511. Response Message Description: MessagePlanCatalogInsert Node Description Type Id ID of the newly created messageplancatalog record. String
- 233. Siebel CRM Primary Web Services ■ LSSGOP_MessagePlanCatalog Request Message Description: MessagePlanCatalogUpdate For a description of this request message, see Table 512. Table 512. Request Message Description: MessagePlanCatalogUpdate Node Description Type Id ID of the messageplancatalog record. CtlgCatId CtlgCatId of the corresponding record. MsgPlanId Message plan ID of the corresponding record. Response Message Description: MessagePlanCatalogUpdate For a description of this response message, see Table 513. Table 513. Response Message Description: MessagePlanCatalogUpdate Node Description Type Id ID of an updated messageplancatalog record. Request Message Description: MessagePlanCatalogDelete For a description of this request message, see Table 514. Table 514. Request Message Description: MessagePlanCatalogDelete Node Description Type Id ID of the messageplancatalog record to be deleted. Response Message Description: MessagePlanCatalogDelete For a description of this response message, see Table 515. String String String String String Table 515. Response Message Description: MessagePlanCatalogDelete Node Description Type Id ID of the deleted messageplancatalog record. String Siebel CRM Web Services Reference Version 8.1/8.2 233
- 234. Siebel CRM Primary Web Services ■ LSSGOP_MessagePlanCatalog Request Message Description: MessagePlanCatalogQueryPage For a description of this request message, see Table 516. Table 516. Request Message Description: MessagePlanCatalogQueryPage Node Description Type Id ID of the messageplancatalog Response Message Description: MessagePlanCatalogQueryPage For a description of this response message, see Table 517. LSSGOP_MessagePlanCatalog 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 518. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 519. Interface Description (WSDL) for LSSGOP_MessagePlanCatalog 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. Siebel CRM Web Services Reference Version 8.1/8.2 234 record to be queried. String Table 517. Response Message Description: MessagePlanCatalogQueryPage Node Description Type Id ID of the messageplancatalog record. String Table 518. LSSGOP_MessagePlanCatalog Service Object Name Boundary Object Type Class LSSGOP_MessagePlanCatalog Business Service CSSEAIUIDataService Table 519. LSSGOP_MessagePlanCatalog Data Object Siebel Repository Name External Name LS SGOP_MessagePlanCatalog LS SGOP_MessagePlanCatalog
- 235. Siebel CRM Primary Web Services ■ LSSGOP_MessageResponse ...LSSGOP_MessagePlanCataloghttp_siebel.com_asi_LSSGOP_MessagePlanCatalog.WSDL LSSGOP_MessageResponse Use this Web service to create, update, delete, and query records in the MessageResponse object. LSSGOP_MessageResponse Operations This Web service allows you to create, update, delete, and query records in the MessageResponse object. For a list of operations, see Table 520. Table 520. LSSGOP_MessageResponse Operations Name Description MessageResponseInsert Creates a messageresponse record. MessageResponseUpdate Updates an existing messageresponse record. MessageResponseDelete Deletes a messageresponse record. MessageResponseQueryPage Queries for a messageresponse record. Request Message Description: MessageResponseInsert For a description of this request message, see Table 521. Table 521. Request Message Description: MessageResponseInsert Node Description Type MessagePlan Name of the message plan. String MessagePlanId ID of the message plan. String MessageStartTime Start time of the message plan. String MessageEndTime End time of the message plan. String Response Response of the corresponding record. Response Message Description: MessageResponseInsert For a description of this response message, see Table 522. String Table 522. Response Message Description: MessageResponseInsert Node Description Type Id ID of the newly created messageresponse record. String Siebel CRM Web Services Reference Version 8.1/8.2 235
- 236. Siebel CRM Primary Web Services ■ LSSGOP_MessageResponse Request Message Description: MessageResponseUpdate For a description of this request message, see Table 523. Table 523. Request Message Description: MessageResponseUpdate Node Description Type Id ID of the messageresponse Response Message Description: MessageResponseUpdate For a description of this response message, see Table 524. Request Message Description: MessageResponseDelete For a description of this request message, see Table 525. Siebel CRM Web Services Reference Version 8.1/8.2 236 record. String MessagePlan Message plan of the corresponding record. String MessagePlanId Message plan ID of the corresponding record. String MessageStartTime Message start time of the corresponding record. String MessageEndTime Message end time of the corresponding record. String Response Response of the corresponding record. String Table 524. Response Message Description: MessageResponseUpdate Node Description Type Id ID of the updated messageresponse record. String Table 525. Request Message Description: MessageResponseDelete Node Description Type Id ID of the messageresponse record to be deleted. String
- 237. Siebel CRM Primary Web Services ■ LSSGOP_MessageResponse Response Message Description: MessageResponseDelete For a description of this response message, see Table 526. Table 526. Response Message Description: MessageResponseDelete Node Description Type Id ID of the deleted messageresponse record. Request Message Description: MessageResponseQueryPage For a description of this request message, see Table 527. Table 527. Request Message Description: MessageResponseQueryPage Node Description Type Id ID of the messageresponse record to be queried. Response Message Description: MessageResponseQueryPage For a description of this response message, see Table 528. String String Table 528. Response Message Description: MessageResponseQueryPage Node Description Type Id ID of the messageresponse record. String LSSGOP_MessageResponse 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 529. Table 529. LSSGOP_MessageResponse Service Object Name Boundary Object Type Class LSSGOP_ MessageResponse Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 237
- 238. Siebel CRM Primary Web Services ■ LSSGOP_ MsgPlanItem Data Object (Integration Object) For a description of the data objects for this Web service, see Table 530. Table 530. LSSGOP_MessageResponse Data Object Siebel Repository Name External Name LS SGOP_MessageResponse LS SGOP_MessageResponse Interface Description (WSDL) for LSSGOP_MessageResponse 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. ...LSSGOP_MessageResponsehttp_siebel.com_asi_LSSGOP_MessageResponse.WSDL LSSGOP_MsgPlanItem Use this Web service to create, update, delete, and query records in the MsgPlanItem object. LSSGOP_ MsgPlanItem Operations This Web service allows you to create, update, delete, and query records in the MsgPlanItem object using Sales Rep visibility. For a list of operations, see Table 531. Table 531. LSSGOP_ MsgPlanItem Operations Name Description MsgPlanItemInsert Creates a msgplanitem record. MsgPlanItemUpdate Updates an existing msgplanitem record. MsgPlanItemDelete Deletes a msgplanitem record. MsgPlanItemQueryPage Queries for a msgplanitem record. Request Message Description: MsgPlanItemInsert For a description of this request message, see Table 532. Table 532. Request Message Description: MsgPlanItemInsert Node Description Type Name Name of the message plan item. String SequenceNumber Sequence number of the message Siebel CRM Web Services Reference Version 8.1/8.2 238 plan. String Type Type of message plan. String ParentMPId ID of the parent message plan. String
- 239. Siebel CRM Primary Web Services ■ LSSGOP_ MsgPlanItem Response Message Description: MsgPlanItemInsert For a description of this response message, see Table 533. Table 533. Response Message Description: MsgPlanItemInsert Node Description Type Id ID of the newly created msgplanitem record. Request Message Description: MsgPlanItemUpdate For a description of this request message, see Table 534. Table 534. Request Message Description: MsgPlanItemUpdate Node Description Type Id ID of the msgplanitem record. String Name Name of the corresponding record. String SequenceNumber Sequence number of the corresponding record. Type Type of the corresponding record. String ParentMPId Parent message plan ID of the corresponding record. Response Message Description: MsgPlanItemUpdate For a description of this response message, see Table 535. Table 535. Response Message Description: MsgPlanItemUpdate Node Description Type Id ID of the updated msgplanitem record. Request Message Description: MsgPlanItemDelete For a description of this request message, see Table 536. String String String String Table 536. Request Message Description: MsgPlanItemDelete Node Description Type Id ID of the msgplanitem record to be deleted. String Siebel CRM Web Services Reference Version 8.1/8.2 239
- 240. Siebel CRM Primary Web Services ■ LSSGOP_ MsgPlanItem Response Message Description: MsgPlanItemDelete For a description of this response message, see Table 537. Table 537. Response Message Description: MsgPlanItemDelete Node Description Type Id ID of the deleted msgplanitem Request Message Description: MsgPlanItemQueryPage For a description of this request message, see Table 538. Response Message Description: MsgPlanItemQueryPage For a description of this response message, see Table 539. LSSGOP_MsgPlanItem 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 540. Siebel CRM Web Services Reference Version 8.1/8.2 240 record. String Table 538. Request Message Description: MsgPlanItemQueryPage Node Description Type Id ID of the msgplanitem record to be queried. String Table 539. Response Message Description: MsgPlanItemQueryPage Node Description Type Id ID of the msgplanitem record. String Table 540. LSSGOP_MsgPlanItem Service Object Name Boundary Object Type Class LSSGOP_MsgPlanItem Business Service CSSEAIUIDataService
- 241. Siebel CRM Primary Web Services ■ LSSGOP_MsgPlanItem_ALL Data Object (Integration Object) For a description of the data objects for this Web service, see Table 541. Table 541. LSSGOP_MsgPlanItem Data Object Siebel Repository Name External Name LS SGOP_MsgPlanItem LS SGOP_MsgPlanItem Interface Description (WSDL) for LSSGOP_MsgPlanItem 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. ...LSSGOP_MsgPlanItemhttp_siebel.com_asi_LSSGOP_MsgPlanItem.WSDL LSSGOP_MsgPlanItem_ALL Use this Web service to create, update, delete, and query records in the MsgPlanItem_ALL object. LSSGOP_MsgPlanItem_ALL Operations This Web service allows you to create, update, delete, and query records in the MsgPlanItems object using Administrator visibility. For a list of operations, see Table 542. Table 542. LSSGOP_MsgPlanItem_ALL Operations Name Description MsgPlanItem_ALLInsert Creates a msgplanitem record. MsgPlanItem_ALLUpdate Updates an existing msgplanitem record. MsgPlanItem_ALLDelete Deletes a msgplanitem record. MsgPlanItem_ALLQueryPage Queries for a msgplanitem record. Request Message Description: MsgPlanItem_ALLInsert For a description of this request message, see Table 543. Table 543. Request Message Description: MsgPlanItem_ALLInsert Node Description Type Name Name of the message plan item. String SequenceNumber Sequence number of the message plan item. String Type Message plan item type. String ParentMPId ID of the parent message plan. String Siebel CRM Web Services Reference Version 8.1/8.2 241
- 242. Siebel CRM Primary Web Services ■ LSSGOP_MsgPlanItem_ALL Response Message Description: MsgPlanItem_ALLInsert For a description of this response message, see Table 544. Table 544. Response Message Description: MsgPlanItem_ALLInsert Node Description Type Id ID of the newly created Request Message Description: MsgPlanItem_ALLUpdate For a description of this request message, see Table 545. Response Message Description: MsgPlanItem_ALLUpdate For a description of this response message, see Table 546. Request Message Description: MsgPlanItem_ALLDelete For a description of this request message, see Table 547. Siebel CRM Web Services Reference Version 8.1/8.2 242 msgplanitem String Table 545. Request Message Description: MsgPlanItem_ALLUpdate Node Description Type Id ID of the msgplanitem record. String Name Name. String SequenceNumber Sequence number of the corresponding record. Number Type Type of the corresponding record. String ParentMPId ParentMP ID of the corresponding record. String Table 546. Response Message Description: MsgPlanItem_ALLUpdate Node Description Type Id ID of the updated msgplanitem record. String Table 547. Request Message Description: MsgPlanItem_ALLDelete Node Description Type Id ID of the msgplanitem record to be deleted. String
- 243. Siebel CRM Primary Web Services ■ LSSGOP_MsgPlanItem_ALL Response Message Description: MsgPlanItem_ALLDelete For a description of this response message, see Table 548. Table 548. Response Message Description: MsgPlanItem_ALLDelete Node Description Type Id ID of the deleted msgplanitem record. Request Message Description: MsgPlanItem_ALLQueryPage For a description of this request message, see Table 549. Table 549. Request Message Description: MsgPlanItem_ALLQueryPage Node Description Type Id ID of the msgplanitem record to be queried. Response Message Description: MsgPlanItem_ALLQueryPage For a description of this response message, see Table 550. String String Table 550. Response Message Description: MsgPlanItem_ALLQueryPage Node Description Type Id ID of the msgplanitem record. String LSSGOP_MsgPlanItem_ALL 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 551. Table 551. LSSGOP_MsgPlanItem_ALL Service Object Name Boundary Object Type Class LSSGOP_MsgPlanItem_ALL Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 243
- 244. Siebel CRM Primary Web Services ■ LSSGOP_MsgPlanItemRelation Data Object (Integration Object) For a description of the data objects for this Web service, see Table 552. Table 552. LSSGOP_MsgPlanItem_ALL Service Object Siebel Repository Name External Name LS SGOP_Account LS SGOP_Account Interface Description (WSDL) for LSSGOP_MsgPlanItem_ALL 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. ...LSSGOP_MsgPlanItem_ALLhttp_siebel.com_asi_LSSGOP_MsgPlanItem_ALL.WSDL LSSGOP_MsgPlanItemRelation Use this Web service to create, update, delete, and query records in the MsgPlanItemRelation object. LSSGOP_MsgPlanItemRelation Operations This Web service allows you to create, update, delete, and query records in the MsgPlanItemRelation object using Sales Rep visibility. For a list of operations, see Table 553. Table 553. LSSGOP_MsgPlanItemRelation Operations Name Description MsgPlanItemRelationInsert Creates a msgplanitemrelation record. MsgPlanItemRelationUpdate Updates an existing msgplanitemrelation record. MsgPlanItemRelationDelete Deletes a msgplanitemrelation record. MsgPlanItemRelationQueryPage Queries for a msgplanitemrelation record. Request Message Description: MsgPlanItemRelationInsert For a description of this request message, see Table 554. Table 554. Request Message Description: MsgPlanItemRelationInsert Node Description Type SequenceNumber Sequence number of the Siebel CRM Web Services Reference Version 8.1/8.2 244 msgplanitemrelation record. String
- 245. Siebel CRM Primary Web Services ■ LSSGOP_MsgPlanItemRelation Response Message Description: MsgPlanItemRelationInsert For a description of this response message, see Table 555. Table 555. Response Message Description: MsgPlanItemRelationInsert Node Description Type Id Id of the newly created msgplanitemrelation record. Request Message Description: MsgPlanItemRelationUpdate For a description of this request message, see Table 556. Table 556. Request Message Description: MsgPlanItemRelationUpdate Node Description Type Id ID of the msgplanitemrelation record. SequenceNumber Sequence number of the corresponding record. Response Message Description: MsgPlanItemRelationUpdate For a description of this response message, see Table 557. Table 557. Response Message Description: MsgPlanItemRelationUpdate Node Description Type Id ID of the updated msgplanitemrelation record. Request Message Description: MsgPlanItemRelationDelete For a description of this request message, see Table 558. String String String String Table 558. Request Message Description: MsgPlanItemRelationDelete Node Description Type Id ID of the msgplanitemrelation record to be deleted. String Siebel CRM Web Services Reference Version 8.1/8.2 245
- 246. Siebel CRM Primary Web Services ■ LSSGOP_MsgPlanItemRelation Response Message Description: MsgPlanItemRelationDelete For a description of this response message, see Table 559. Table 559. Response Message Description: MsgPlanItemRelationDelete Node Description Type Id ID of the deleted Request Message Description: MsgPlanItemRelationQueryPage For a description of this request message, see Table 560. Response Message Description: MsgPlanItemRelationQueryPage For a description of this response message, see Table 561. LSSGOP_MsgPlanItemRelation 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 562. Siebel CRM Web Services Reference Version 8.1/8.2 246 msgplanitemrelation record. String Table 560. Request Message Description: MsgPlanItemRelationQueryPage Node Description Type Id ID of the msgplanitemrelation record to be queried. String Table 561. Response Message Description: MsgPlanItemRelationQueryPage Node Description Type Id ID of the msgplanitemrelation record. String Table 562. LSSGOP_MsgPlanItemRelation Service Object Name Boundary Object Type Class LSSGOP_MsgPlanItemRelation Business Service CSSEAIUIDataService
- 247. Siebel CRM Primary Web Services ■ LSSGOP_MsgPlanItemRelation_ALL Data Object (Integration Object) For a description of the data objects for this Web service, see Table 563. Table 563. LSSGOP_MsgPlanItemRelation Service Object Siebel Repository Name External Name LS SGOP_MsgPlanItemRelation LS SGOP_MsgPlanItemRelation Interface Description (WSDL) for LSSGOP_MsgPlanItemRelation 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. ...LSSGOP_MsgPlanItemRelationhttp_siebel.com_asi_LSSGOP_MsgPlanItemRelation.WSDL LSSGOP_MsgPlanItemRelation_ALL Use this Web service to create, update, delete, and query records in the MsgPlanItemRelation_ALL objects. LSSGOP_MsgPlanItemRelation_ALL Operations This Web service allows you to create, update, delete, and query records in the MsgPlanItemRelation object using Administrator visibility. For a list of operations, see Table 564. Table 564. LSSGOP_MsgPlanItemRelation_ALL Operations Name Description MsgPlanItemRelation_ALLInsert Creates a msgplanitemrelation record. MsgPlanItemRelation_ALLUpdate Updates an existing msgplanitemrelation record. MsgPlanItemRelation_ALLDelete Deletes a msgplanitemrelation record. MsgPlanItemRelation_ALLQueryPage Queries for a msgplanitemrelation record. Request Message Description: MsgPlanItemRelation_ALLInsert For a description of this request message, see Table 565. Table 565. Request Message Description: MsgPlanItemRelation_ALLInsert Node Description Type SequenceNumber Sequence number. String Siebel CRM Web Services Reference Version 8.1/8.2 247
- 248. Siebel CRM Primary Web Services ■ LSSGOP_MsgPlanItemRelation_ALL Response Message Description: MsgPlanItemRelation_ALLInsert For a description of this response message, see Table 566. Table 566. Response Message Description: MsgPlanItemRelation_ALLInsert Node Description Type Id ID of an newly created account Request Message Description: MsgPlanItemRelation_ALLUpdate For a description of this request message, see Table 567. Response Message Description: MsgPlanItemRelation_ALLUpdate For a description of this response message, see Table 568. Request Message Description: MsgPlanItemRelation_ALLDelete For a description of this request message, see Table 569. Siebel CRM Web Services Reference Version 8.1/8.2 248 record. String Table 567. Request Message Description: MsgPlanItemRelation_ALLUpdate Node Description Type Id ID of the msgplanitemrelation record. String SequenceNumber Sequence number of the corresponding record. String Table 568. Response Message Description: MsgPlanItemRelation_ALLUpdate Node Description Type Id ID of the updated msgplanitemrelation record. String Table 569. Request Message Description: MsgPlanItemRelation_ALLDelete Node Description Type Id ID of the msgplanitemrelation record to be deleted. String
- 249. Siebel CRM Primary Web Services ■ LSSGOP_MsgPlanItemRelation_ALL Response Message Description: MsgPlanItemRelation_ALLDelete For a description of this response message, see Table 570. Table 570. Response Message Description: MsgPlanItemRelation_ALLDelete Node Description Type Id ID of the deleted msgplanitemrelation record. String Request Message Description: MsgPlanItemRelation_ALLQueryPage For a description of this request message, see Table 571. Table 571. Request Message Description: MsgPlanItemRelation_ALLQueryPage Node Description Type Id ID of the msgplanitemrelation record to be queried. String Response Message Description: MsgPlanItemRelation_ALLQueryPage For a description of this response message, see Table 572. Table 572. Response Message Description: MsgPlanItemRelation_ALLQueryPage Node Description Type Id ID of the msgplanitemrelation record. String LSSGOP_MsgPlanItemRelation_ALL 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 573. Table 573. LSSGOP_MsgPlanItemRelation_ALL Service Object Name Boundary Object Type Class LSSGOP_ MsgPlanItemRelation_ALL Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 249
- 250. Siebel CRM Primary Web Services ■ LSSGOP_PersonalList Data Object (Integration Object) For a description of the data objects for this Web service, see Table 574. Table 574. LSSGOP_MsgPlanItemRelation_ALL Data Object Siebel Repository Name External Name LS SGOP_MsgPlanItemRelation_ALL LS SGOP_MsgPlanItemRelation_ALL Interface Description (WSDL) for LSSGOP_MsgPlanItemRelation_ALL 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. ...LSSGOP_MsgPlanItemRelation_ALLhttp_siebel.com_asi_LSSGOP_MsgPlanItemRelation_ALL. WSDL LSSGOP_PersonalList Use this Web service to create, update, delete, and query records in the PersonalList object. LSSGOP_PersonalList Operations This Web service allows you to create, update, delete, and query records in the PersonalList object. For a list of operation, see Table 575. Table 575. LSSGOP_PersonalList Operations Name Description PersonalListInsert Creates a personallist record. PersonalListUpdate Updates an existing personallist record. PersonalListDelete Deletes a personallist record. PersonalListQueryPage Queries for a personallist record. Request Message Description: PersonalListInsert For a description of this request message, see Table 576. Table 576. Request Message Description: PersonalListInsert Node Description Type Sample Name of the sample to be inserted. String Siebel CRM Web Services Reference Version 8.1/8.2 250
- 251. Siebel CRM Primary Web Services ■ LSSGOP_PersonalList Response Message Description: PersonalListInsert For a description of this response message, see Table 577. Table 577. Response Message Description: PersonalListInsert Node Description Type Id Id of the newly created personallist record. Request Message Description: PersonalListUpdate For a description of this request message, see Table 578. Table 578. Request Message Description: PersonalListUpdate Node Description Type Id Id of a personallist record. String Sample Sample of the corresponding record. Response Message Description: PersonalListUpdate For a description of this response message, see Table 579. Table 579. Response Message Description: PersonalListUpdate Node Description Type Id ID of the updated personallist record. Request Message Description: PersonalListDelete For a description of this request message, see Table 580. Table 580. Request Message Description: PersonalListDelete Node Description Type Id ID of the personallist record to be deleted. Response Message Description: PersonalListDelete For a description of this response message, see Table 581. String String String String Table 581. Response Message Description: PersonalListDelete Node Description Type Id ID of the deleted personallist record. String Siebel CRM Web Services Reference Version 8.1/8.2 251
- 252. Siebel CRM Primary Web Services ■ LSSGOP_PersonalList Request Message Description: PersonalListQueryPage For a description of this request message, see Table 582. Table 582. Request Message Description: PersonalListQueryPage Node Description Type Id ID of the personallist record to be Response Message Description: PersonalListQueryPage For a description of this response message, see Table 583. LSSGOP_PersonalList 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 584. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 585. Interface Description (WSDL) for LSSGOP_PersonalList 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. ...LSSGOP_PersonalListhttp_siebel.com_asi_LSSGOP_PersonalList.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 252 queried. String Table 583. Response Message Description: PersonalListQueryPage Node Description Type Id ID of a personallist record. String Table 584. LSSGOP_PersonalList Service Object Name Boundary Object Type Class LSSGOP_PersonalList Business Service CSSEAIUIDataService Table 585. LSSGOP_PersonalList Data Object Siebel Repository Name External Name LS SGOP_PersonalList LS SGOP_PersonalList
- 253. Siebel CRM Primary Web Services ■ LSSGOP_PositionContactAddress LSSGOP_PositionContactAddress Use this Web service to create, update, delete, and query records in the PositionContactAddress object. LSSGOP_PositionContactAddress Operations This Web service allows you to create, update, delete, and query records in the PositioncontactAddress object. For a list of operations, see Table 586. Table 586. LSSGOP_PositionContactAddress Operations Name Description PositionContactAddressInsert Creates a positioncontactaddress record. PositionContactAddressUpdate Updates an existing positioncontactaddress record. PositionContactAddressDelete Deletes a positioncontactaddress record. PositionContactAddressQueryPage Queries for a positioncontactaddress record. Request Message Description: PositionContactAddressInsert For a description of this request message, see Table 587. Table 587. Request Message Description: PositionContactAddressInsert Node Description Type AddressId Address Id. String ContactAddressId Contact address Id. String ContactId Contact Id. String PositionId Position Id. String Response Message Description: PositionContactAddressInsert For a description of this response message, see Table 588. Table 588. Response Message Description: PositionContactAddressInsert Node Description Type Id Id of the newly created positioncontactaddress record. String Siebel CRM Web Services Reference Version 8.1/8.2 253
- 254. Siebel CRM Primary Web Services ■ LSSGOP_PositionContactAddress Request Message Description: PositionContactAddressUpdate For a description of this request message, see Table 589. Table 589. Request Message Description: PositionContactAddressUpdate Node Description Type Id ID of the positioncontactaddress Response Message Description: PositionContactAddressUpdate For a description of this response message, see Table 590. Request Message Description: PositionContactAddressDelete For a description of this request message, see Table 591. Response Message Description: PositionContactAddressDelete For a description of this response message, see Table 592. Siebel CRM Web Services Reference Version 8.1/8.2 254 record. String AddressId AddressId of the corresponding record. String ContactAddressId ContactAddressId of the corresponding record. String ContactId ContactId of the corresponding record. String PositionId PositionId of the corresponding record. String Type Type of the corresponding record. String Table 590. Response Message Description: PositionContactAddressUpdate Node Description Type Id ID of the updated positioncontactaddress record. String Table 591. Request Message Description: PositionContactAddressDelete Node Description Type Id ID of a positioncontactaddress record to be deleted. String Table 592. Response Message Description: PositionContactAddressDelete Node Description Type Id ID of the deleted positioncontactaddress record. String
- 255. Siebel CRM Primary Web Services ■ LSSGOP_PositionContactAddress Request Message Description: PositionContactAddressQueryPage For a description of this request message, see Table 593. Table 593. Request Message Description: PositionContactAddressQueryPage Node Description Type Id ID of the positioncontactaddress record to be queried. String Response Message Description: PositionContactAddressQueryPage For a description of this response message, see Table 594. Table 594. Response Message Description: PositionContactAddressQueryPage Node Description Type Id ID of the positioncontactaddress record. String LSSGOP_PositionContactAddress 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 595. Table 595. LSSGOP_PositionContactAddress Service Object Name Boundary Object Type Class LSSGOP_PositionContactAddress Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 596. Table 596. LSSGOP_PositionContactAddress Data Object Siebel Repository Name External Name LS SGOP_PositionContactAddress LS SGOP_PositionContactAddress Interface Description (WSDL) for LSSGOP_PositionContactAddress 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. Siebel CRM Web Services Reference Version 8.1/8.2 255
- 256. Siebel CRM Primary Web Services ■ LSSGOP_Product ...LSSGOP_PositionContactAddresshttp_siebel.com_asi_LSSGOP_PositionContactAddress.WS DL LSSGOP_Product Use this Web service to query records in the Product object. LSSGOP_Product Operations This Web service allows you to query records in the Product object. For a list of operations, see Table 597. Table 597. LSSGOP_Product Operations Name Description ProductQueryPage Queries for a product. Request Message Description: ProductQueryPage For a description of this request message, see Table 598. Table 598. Request Message Description: ProductQueryPage Node Description Type Id Id of the product record to be Response Message Description: ProductQueryPage For a description of this response message, see Table 599. LSSGOP_Product 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. Siebel CRM Web Services Reference Version 8.1/8.2 256 queried. String Table 599. Response Message Description: ProductQueryPage Node Description Type Id Id of the product record. String
- 257. Siebel CRM Primary Web Services ■ LSSGOP_ProductIndication Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 600. Table 600. LSSGOP_Product Service Object Name Boundary Object Type Class LSSGOP_Product Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 601. Table 601. LSSGOP_Product Data Object Siebel Repository Name External Name LS SGOP_Product LS SGOP_Product Interface Description (WSDL) for LSSGOP_Product 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. ...LSSGOP_Producthttp_siebel.com_asi_LSSGOP_Product.WSDL LSSGOP_ProductIndication Use this Web service to query records in the ProductIndication object. LSSGOP_ProductIndication Operations This Web service allows you to query records in the ProductIndication object. For a list of operations, see Table 602. Table 602. LSSGOP_ProductIndication Operations Name Description ProductIndicationQueryPage Queries for a productindication record. Request Message Description: ProductIndicationQueryPage For a description of this request message, see Table 603. Table 603. Request Message Description: ProductIndicationQueryPage Node Description Type Id ID of a productindication record to be queried. String Siebel CRM Web Services Reference Version 8.1/8.2 257
- 258. Siebel CRM Primary Web Services ■ LSSGOP_ProductsDetailed Response Message Description: ProductIndicationQueryPage For a description of this response message, see Table 604. Table 604. Response Message Description: ProductIndicationQueryPage Node Description Type Id ID of a productindication record. String LSSGOP_ProductIndication 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 605. Table 605. LSSGOP_ProductIndication Service Object Name Boundary Object Type Class LSSGOP_ProductIndication Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 606. Table 606. LSSGOP_ProductIndication Data Object Siebel Repository Name External Name LS SGOP_ProductIndication LS SGOP_ProductIndication Interface Description (WSDL) for LSSGOP_ProductIndication 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. ...LSSGOP_ProductIndicationhttp_siebel.com_asi_LSSGOP_ProductIndication.WSDL LSSGOP_ProductsDetailed Use this Web service to create, update, delete, and query records in the ProductDetailed object. Siebel CRM Web Services Reference Version 8.1/8.2 258
- 259. Siebel CRM Primary Web Services ■ LSSGOP_ProductsDetailed LSSGOP_ProductsDetailed Operations This Web service allows you to create, update, delete, and query records in the ProductDetailed object. For a list of operations, see Table 607. Table 607. LSSGOP_ProductsDetailed Operations Name Description ProductsDetailedInsert Creates a productdetailed record. ProductsDetailedUpdate Updates an existing productdetailed record. ProductsDetailedDelete Deletes a productdetailed record. ProductsDetailedQueryPage Queries for a productdetailed record. Request Message Description: ProductsDetailedInsert For a description of this request message, see Table 608. Table 608. Request Message Description: ProductsDetailedInsert Node Description Type Name Name of the record. String Indication Indication of the corresponding record. Priority Priority of the corresponding record. ProductAllocationId Product allocation Id of the corresponding record. ProductId Product Id of the corresponding record. Response Message Description: ProductsDetailedInsert For a description of this response message, see Table 609. String String String String Table 609. Response Message Description: ProductsDetailedInsert Node Description Type Id ID of the newly created productdetailed record. String Siebel CRM Web Services Reference Version 8.1/8.2 259
- 260. Siebel CRM Primary Web Services ■ LSSGOP_ProductsDetailed Request Message Description: ProductsDetailedUpdate For a description of this request message, see Table 610. Table 610. Request Message Description: ProductsDetailedUpdate Node Description Type Id ID of the productdetailed record. String Name Name of the corresponding record. String Indication Indication of the corresponding Response Message Description: ProductsDetailedUpdate For a description of this response message, see Table 611. Request Message Description: ProductsDetailedDelete For a description of this request message, see Table 612. Response Message Description: ProductsDetailedDelete For a description of this response message, see Table 613. Siebel CRM Web Services Reference Version 8.1/8.2 260 record. String Priority Priority of the corresponding record. String ProductAllocationId Product allocation ID of the corresponding record. String ProductId Product ID of the corresponding record. String Table 611. Response Message Description: ProductsDetailedUpdate Node Description Type Id ID of the updated productdetailed record. String Table 612. Request Message Description: ProductsDetailedDelete Node Description Type Id ID of the productdetailed record to be deleted. String Table 613. Response Message Description: ProductsDetailedDelete Node Description Type Id ID of the deleted productdetailed record. String
- 261. Siebel CRM Primary Web Services ■ LSSGOP_ProductsDetailed Request Message Description: ProductsDetailedQueryPage For a description of this request message, see Table 614. Table 614. Request Message Description: ProductsDetailedQueryPage Node Description Type Id ID of the productdetailed record to be queried. Response Message Description: ProductsDetailedQueryPage For a description of this response message, see Table 615. String Table 615. Response Message Description: ProductsDetailedQueryPage Node Description Type Id ID of the productdetailed record. String LSSGOP_ProductsDetailed 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 616. Table 616. LSSGOP_ProductsDetailed Service Object Name Boundary Object Type Class LSSGOP_ProductsDetailed Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 617. Table 617. LSSGOP_ProductsDetailed Data Object Siebel Repository Name External Name LS SGOP_ProductsDetailed LS SGOP_ProductsDetailed Interface Description (WSDL) for LSSGOP_ProductsDetailed 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. ...LSSGOP_ProductsDetailedhttp_siebel.com_asi_LSSGOP_ProductsDetailed.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 261
- 262. Siebel CRM Primary Web Services ■ LSSGOP_PromotionalItemsDropped LSSGOP_PromotionalItemsDropped Use this Web service to create, update, delete, and query records in the PromotionalItemsDropped object. LSSGOP_PromotionalItemsDropped Operations This Web service allows you to create, update, delete, and query records in the PromotionalItemsDropped object. For a list of operations, see Table 618. Table 618. LSSGOP_PromotionalItemsDropped Operations Name Description PromotionalItemsDroppedInsert Creates a promotionalitemsdropped record. PromotionalItemsDroppedUpdate Updates an existing promotionalitemsdropped record. PromotionalItemsDroppedDelete Deletes a promotionalitemsdropped record. PromotionalItemsDroppedQueryPage Queries for a promotionalitemsdropped record. Request Message Description: PromotionalItemsDroppedInsert For a description of this request message, see Table 619. Table 619. Request Message Description: PromotionalItemsDroppedInsert Node Description Type ProductId Product ID of the corresponding Response Message Description: PromotionalItemsDroppedInsert For a description of this response message, see Table 620. Siebel CRM Web Services Reference Version 8.1/8.2 262 record. String ProductAllocationId Product allocation ID of the corresponding record. String Quantity Quantity of the corresponding record. String Type Type of the corresponding record. String Table 620. Response Message Description: PromotionalItemsDroppedInser Node Description Type Id ID of the newly created promotionalitemsdropped String
- 263. Siebel CRM Primary Web Services ■ LSSGOP_PromotionalItemsDropped Request Message Description: PromotionalItemsDroppedUpdate For a description of this request message, see Table 621. Table 621. Request Message Description: PromotionalItemsDroppedUpdate Node Description Type Id ID of the corresponding record. String ProductId Product ID of the corresponding record. String ProductAllocationId Product allocation ID of the corresponding record. String Quantity Quantity of the corresponding record. String Type Type of the corresponding record. String Response Message Description: PromotionalItemsDroppedUpdate For a description of this response message, see Table 622. Table 622. Response Message Description: PromotionalItemsDroppedUpdate Node Description Type Id ID of the updated promotionalitemsdropped record. Request Message Description: PromotionalItemsDroppedDelete For a description of this request message, see Table 623. String Table 623. Request Message Description: PromotionalItemsDroppedDelete Node Description Type Id ID of the promotionalitemsdropped record to be deleted. String Response Message Description: PromotionalItemsDroppedDelete For a description of this response message, see Table 624. Table 624. Response Message Description: PromotionalItemsDroppedDelete Node Description Type Id ID of the deleted promotionalitemsdropped record. String Siebel CRM Web Services Reference Version 8.1/8.2 263
- 264. Siebel CRM Primary Web Services ■ LSSGOP_PromotionalItemsDropped Request Message Description: PromotionalItemsDroppedQueryPage For a description of this request message, see Table 625. Table 625. Request Message Description: PromotionalItemsDroppedQueryPage Node Description Type Id ID of the Response Message Description: PromotionalItemsDroppedQueryPage For a description of this response message, see Table 626. LSSGOP_PromotionalItemsDropped 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 627. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 628. Siebel CRM Web Services Reference Version 8.1/8.2 264 promotionalitemsQuantity of the corresponding dropped record to be queried. String Table 626. Response Message Description: PromotionalItemsDroppedQueryPage Node Description Type Id ID of the promotionalitemsdropped record. String Table 627. LSSGOP_PromotionalItemsDropped Service Object Name Boundary Object Type Class LSSGOP_PromotionalItemsDropped Business Service CSSEAIUIDataService Table 628. LSSGOP_PromotionalItemsDropped Data Object Siebel Repository Name External Name LS SGOP_PromotionalItemsDropped LS SGOP_PromotionalItemsDropped
- 265. Siebel CRM Primary Web Services ■ LSSGOP_RelatedAccount Interface Description (WSDL) for LSSGOP_PromotionalItemsDropped 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. ...LSSGOP_PromotionalItemsDroppedhttp_siebel.com_asi_LSSGOP_PromotionalItemsDropped. WSDL LSSGOP_RelatedAccount Use this Web service to create, update, delete, and query records in the RelatedAccount object. LSSGOP_RelatedAccount Operations This Web service allows you to create, update, delete, and query records in the RelatedAccount object. For a list of operations, see Table 629. Table 629. LSSGOP_RelatedAccount Operations Name Description RelatedAccountInsert Creates a relatedaccount record. RelatedAccountUpdate Updates an existing relatedaccount record. RelatedAccountDelete Deletes a relatedaccount record. RelatedAccountQueryPage Queries for a relatedaccount record. Request Message Description: RelatedAccountInsert For a description of this request message, see Table 630. Table 630. Request Message Description: RelatedAccountInsert Node Description Type AccountId Account Id of the corresponding record. String RelatedAccountId Related account Id of the corresponding record. String RelationshipRole Relationship role of the corresponding record. String Siebel CRM Web Services Reference Version 8.1/8.2 265
- 266. Siebel CRM Primary Web Services ■ LSSGOP_RelatedAccount Response Message Description: RelatedAccountInsert For a description of this response message, see Table 631. Table 631. Response Message Description: RelatedAccountInsert Node Description Type Id Id of the newly created Request Message Description: RelatedAccountUpdate For a description of this request message, see Table 632. Response Message Description: RelatedAccountUpdate For a description of this response message, see Table 633. Request Message Description: RelatedAccountDelete For a description of this request message, see Table 634. Siebel CRM Web Services Reference Version 8.1/8.2 266 relatedaccount record. String Table 632. Request Message Description: RelatedAccountUpdate Node Description Type Id Id of the relatedaccount record. String AccountId Account Id of the corresponding record. String RelatedAccountId Related account ID of the corresponding record. String RelationshipRole Relationship role of the corresponding record. String Table 633. Response Message Description: RelatedAccountUpdate Node Description Type Id ID of the updated relatedaccount record. String Table 634. Request Message Description: RelatedAccountDelete Node Description Type Id ID of the relatedaccount record to be deleted. String
- 267. Siebel CRM Primary Web Services ■ LSSGOP_RelatedAccount Response Message Description: RelatedAccount Delete For a description of this response message, see Table 635. Table 635. Response Message Description: RelatedAccountDelete Node Description Type Id ID of the deleted relatedaccount record. Request Message Description: RelatedAccountQueryPage For a description of this request message, see Table 636. Table 636. Request Message Description: RelatedAccountQueryPag Node Description Type Id ID of the relatedaccount record to be queried. Response Message Description: RelatedAccountQueryPage For a description of this response message, see Table 637. String String Table 637. Response Message Description: RelatedAccountQueryPage Node Description Type Id ID of the relatedaccount record. String LSSGOP_RelatedAccount 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 638. Table 638. LSSGOP_RelatedAccount Service Object Name Boundary Object Type Class LSSGOP_RelatedAccount Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 267
- 268. Siebel CRM Primary Web Services ■ LSSGOP_RelatedContact Data Object (Integration Object) For a description of the data objects for this Web service, see Table 639. Table 639. LSSGOP_RelatedAccount Data Object Siebel Repository Name External Name LS SGOP_RelatedAccount LS SGOP_RelatedAccount Interface Description (WSDL) for LSSGOP_RelatedAccount 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. ...LSSGOP_RelatedAccounthttp_siebel.com_asi_LSSGOP_RelatedAccount.WSDL LSSGOP_RelatedContact Use this Web service to create, update, delete, and query records in the RelatedContact object. LSSGOP_RelatedContact Operations This Web service allows you to create, update, delete, and query records in the RelatedContact object. For a list of operations, see Table 640. Table 640. LSSGOP_RelatedContact Operations Name Description RelatedContactInsert Creates a relatedcontact record. RelatedContactUpdate Updates an existing relatedcontact record. RelatedContactDelete Deletes a relatedcontact record. RelatedContactQueryPage Queries for a relatedcontact record. Request Message Description: RelatedContactInsert For a description of this request message, see Table 641. Table 641. Request Message Description: RelatedContactInsert Node Description Type ContactId Contact ID of the corresponding Siebel CRM Web Services Reference Version 8.1/8.2 268 record. String RelatedContactId Related contact ID of the corresponding record. String Role Role of the corresponding record. String
- 269. Siebel CRM Primary Web Services ■ LSSGOP_RelatedContact Response Message Description: RelatedContactInsert For a description of this response message, see Table 642. Table 642. Response Message Description: RelatedContactInsert Node Description Type Id ID of the newly created relatedcontact record. Request Message Description: RelatedContactUpdate For a description of this request message, see Table 643. Table 643. Request Message Description: RelatedContactUpdate Node Description Type Id ID of the relatedcontact record. String ContactId ContactId of the corresponding record. RelatedContactId RelatedContactId of the corresponding record. Role Role of the corresponding record. String Response Message Description: RelatedContactUpdate For a description of this response message, see Table 644. Table 644. Response Message Description: RelatedContactUpdate Node Description Type Id ID of the updated relatedcontact record. Request Message Description: RelatedContactDelete For a description of this request message, see Table 645. String String String String Table 645. Request Message Description: RelatedContactDelete Node Description Type Id ID of the relatedcontact record to be deleted. String Siebel CRM Web Services Reference Version 8.1/8.2 269
- 270. Siebel CRM Primary Web Services ■ LSSGOP_RelatedContact Response Message Description: RelatedContactDelete For a description of this response message, see Table 646. Table 646. Response Message Description: RelatedContactDelete Node Description Type Id ID of the deleted relatedcontact Request Message Description: RelatedContactQueryPage For a description of this request message, see Table 647. Response Message Description: RelatedContactQueryPage For a description of this response message, see Table 648. LSSGOP_RelatedContact 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 649. Siebel CRM Web Services Reference Version 8.1/8.2 270 record. String Table 647. Request Message Description: RelatedContactQueryPage Node Description Type Id ID of the relatedcontact record to be queried. String Table 648. Response Message Description: RelatedContactQueryPage Node Description Type Id ID of the relatedcontact record. String Table 649. LSSGOP_RelatedContact Service Object Name Boundary Object Type Class LSSGOP_RelatedContact Business Service CSSEAIUIDataService
- 271. Siebel CRM Primary Web Services ■ LSSGOP_RelatedLiterature Data Object (Integration Object) For a description of the data objects for this Web service, see Table 650. Table 650. LSSGOP_RelatedContact Service Object Siebel Repository Name External Name LS SGOP_RelatedContact LS SGOP_RelatedContact Interface Description (WSDL) for LSSGOP_RelatedContact 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. ...LSSGOP_RelatedContacthttp_siebel.com_asi_LSSGOP_RelatedContact.WSDL LSSGOP_RelatedLiterature Use this Web service to create, update, delete, and query records in the RelatedLiterature object. LSSGOP_RelatedLiterature Operations This Web service allows you to create, update, delete, and query the RelatedLiterature object. For a list of operations, see Table 651. Table 651. LSSGOP_RelatedLiterature Operations Name Description RelatedLiteratureInsert Creates a relatedliterature record. RelatedLiteratureUpdate Updates an existing relatedliterature record. RelatedLiteratureDelete Deletes a relatedliterature record. RelatedLiteratureQueryPage Queries for a relatedliterature record. Request Message Description: RelatedLiteratureInsert For a description of this request message, see Table 652. Table 652. Request Message Description: RelatedLiteratureInsert Node Description Type LitId Name of the account to be inserted. String ParLitId ParLitId of the corresponding record. String Siebel CRM Web Services Reference Version 8.1/8.2 271
- 272. Siebel CRM Primary Web Services ■ LSSGOP_RelatedLiterature Response Message Description: RelatedLiteratureInsert For a description of this response message, see Table 653. Table 653. Response Message Description: RelatedLiteratureInsert Node Description Type Id ID of the newly created Request Message Description: RelatedLiteratureUpdate For a description of this request message, see Table 654. Response Message Description: RelatedLiteratureUpdate For a description of this response message, see Table 655. Request Message Description: RelatedLiteratureDelete For a description of this request message, see Table 656. Siebel CRM Web Services Reference Version 8.1/8.2 272 relatedliterature record. String Table 654. Request Message Description: RelatedLiteratureUpdate Node Description Type Id ID of a relatedliterature record. String LitId Literature ID of the corresponding record. String ParLitId ParLitId of the corresponding record. String Table 655. Response Message Description: RelatedLiteratureUpdate Node Description Type Id ID of the updated relatedliterature record. String Table 656. Request Message Description: RelatedLiteratureDelete Node Description Type Id ID of the account to be designated as relatedliterature. String
- 273. Siebel CRM Primary Web Services ■ LSSGOP_RelatedLiterature Response Message Description: RelatedLiteratureDelete For a description of this response message, see Table 657. Table 657. Response Message Description: RelatedLiteratureDelete Node Description Type Id ID of the deleted relatedliterature record. Request Message Description: RelatedLiteratureQueryPage For a description of this request message, see Table 658. Table 658. Request Message Description: RelatedLiteratureQueryPage Node Description Type Id ID of the account to be queried. String Response Message Description: RelatedLiteratureQueryPage For a description of this response message, see Table 659. String Table 659. Response Message Description: RelatedLiteratureQueryPage Node Description Type Id ID of the relatedliterature record. String LSSGOP_RelatedLiterature 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 660. Table 660. LSSGOP_RelatedLiterature Service Object Name Boundary Object Type Class LSSGOP_RelatedLiterature Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 273
- 274. Siebel CRM Primary Web Services ■ LSSGOP_RetailObjective Data Object (Integration Object) For a description of the data objects for this Web service, see Table 661. Table 661. LSSGOP_RelatedLiterature Data Object Siebel Repository Name External Name LS SGOP_RelatedLiterature LS SGOP_RelatedLiterature Interface Description (WSDL) for LSSGOP_RelatedLiterature 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. ...LSSGOP_RelatedLiteraturehttp_siebel.com_asi_LSSGOP_RelatedLiterature.WSDL LSSGOP_RetailObjective Use this Web service to create, update, delete, and query records in the RetailObjective object. LSSGOP_RetailObjective Operations This Web service allows you to create, update, delete, and query records in the RetailObjective object. For a list of operations, see Table 662. Table 662. LSSGOP_RetailObjective Operations Name Description RetailObjectiveInsert Creates a retailobjective record. RetailObjectiveUpdate Updates an existing retailobjective record. RetailObjectiveDelete Deletes a retailobjective record. RetailObjectiveQueryPage Queries for a retailobjective record. Request Message Description: RetailObjectiveInsert For a description of this request message, see Table 663. Table 663. Request Message Description: RetailObjectiveInsert Node Description Type Name Name of the corresponding Siebel CRM Web Services Reference Version 8.1/8.2 274 record. String Description Description of the corresponding record. String
- 275. Siebel CRM Primary Web Services ■ LSSGOP_RetailObjective Table 663. Request Message Description: RetailObjectiveInsert Node Description Type StartDate Start date of the corresponding record. EndDate End date of the corresponding record. GoalRevenueDate Goal revenue date of the corresponding record. PeriodName Period name of the corresponding record. Type Type of the corresponding record. PromoNum Promotion number of the corresponding record. Response Message Description: RetailObjectiveInsert For a description of this response message, see Table 664. Table 664. Response Message Description: RetailObjectiveInsert Node Description Type Id ID of the newly created retailobjective Request Message Description: RetailObjectiveUpdate For a description of this request message, see Table 665. String String String String String String String Table 665. Request Message Description: RetailObjectiveUpdate Node Description Type Id ID of the retailobjective record. String Name Name of the corresponding record. String Description Description of the corresponding record. String StartDate Start date of the corresponding record. String EndDate End date of the corresponding record. String GoalRevenueDate Goal revenue date of the corresponding record. String Siebel CRM Web Services Reference Version 8.1/8.2 275
- 276. Siebel CRM Primary Web Services ■ LSSGOP_RetailObjective Table 665. Request Message Description: RetailObjectiveUpdate Node Description Type PeriodName Period name of the corresponding Response Message Description: RetailObjectiveUpdate For a description of this response message, see Table 666. Request Message Description: RetailObjectiveDelete For a description of this request message, see Table 667. Response Message Description: RetailObjectiveDelete For a description of this response message, see Table 668. Siebel CRM Web Services Reference Version 8.1/8.2 276 record. String Type Type of the corresponding record. String PromoNum Promotion number of the corresponding record. String Type Name of the corresponding record. String Table 666. Response Message Description: RetailObjectiveUpdate Node Description Type Id ID of the updated retailobjective record. String Table 667. Request Message Description: RetailObjectiveDelete Node Description Type Id ID of the retailobjective record to be deleted. String Table 668. Response Message Description: RetailObjectiveDelete Node Description Type Id ID of the deleted retailobjective record. String
- 277. Siebel CRM Primary Web Services ■ LSSGOP_RetailObjective Request Message Description: RetailObjectiveQueryPage For a description of this request message, see Table 669. Table 669. Request Message Description: RetailObjectiveQueryPage Node Description Type Id ID of the retailobjective record to be queried. Response Message Description: RetailObjectiveQueryPage For a description of this response message, see Table 670. String Table 670. Response Message Description: RetailObjectiveQueryPage Node Description Type Id ID of the retailobjective record. String LSSGOP_RetailObjective 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 671. Table 671. LSSGOP_RetailObjective Service Object Name Boundary Object Type Class LSSGOP_RetailObjective Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 672. Table 672. LSSGOP_RetailObjective Data Object Siebel Repository Name External Name LS SGOP_RetailObjective LS SGOP_RetailObjective Interface Description (WSDL) for LSSGOP_RetailObjective 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. ...LSSGOP_RetailObjectivehttp_siebel.com_asi_LSSGOP_RetailObjective.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 277
- 278. Siebel CRM Primary Web Services ■ LSSGOP_Revenue LSSGOP_Revenue Use this Web service to create, update, delete, and query records in the Revenue object. LSSGOP_Revenue Operations This Web service allows you to create, update, delete, and query records in the Revenue object. For a list of operations, see Table 673. Table 673. LSSGOP_Revenue Operations Name Description RevenueInsert Creates a revenue record. RevenueUpdate Updates an existing revenue record. RevenueDelete Deletes a revenue record. RevenueQueryPage Queries for a revenue record. Request Message Description: RevenueInsert For a description of this request message, see Table 674. Table 674. Request Message Description: RevenueInsert Node Description Type Date Date of the corresponding record. String Response Message Description: RevenueInsert For a description of this response message, see Table 675. Table 675. Response Message Description: RevenueInsert Node Description Type Id ID of the newly created revenue Request Message Description: RevenueUpdate For a description of this request message, see Table 676. Siebel CRM Web Services Reference Version 8.1/8.2 278 record. String Table 676. Request Message Description: RevenueUpdate Node Description Type Id ID of the revenue record. String Date Date of the corresponding record. String
- 279. Siebel CRM Primary Web Services ■ LSSGOP_Revenue Response Message Description: RevenueUpdate For a description of this response message, see Table 677. Table 677. Response Message Description: RevenueUpdate Node Description Type Id ID of the updated revenue record. String Request Message Description: RevenueDelete For a description of this request message, see Table 678. Table 678. Request Message Description: RevenueDelete Node Description Type Id ID of the revenue record to be deleted Response Message Description: RevenueDelete For a description of this response message, see Table 679. Table 679. Response Message Description: RevenueDelete Node Description Type Id ID of the deleted revenue String Request Message Description: RevenueQueryPage For a description of this request message, see Table 680. Table 680. Request Message Description: RevenueQueryPage Node Description Type Id ID of the revenue to be queried. String Response Message Description: RevenueQueryPage For a description of this response message, see Table 681. String Table 681. Response Message Description: RevenueQueryPage Node Description Type Id ID of the revenue. String Siebel CRM Web Services Reference Version 8.1/8.2 279
- 280. Siebel CRM Primary Web Services ■ LSSGOP_SampleDisclaimer LSSGOP_Revenue 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 682. Table 682. LSSGOP_Revenue Service Object Name Boundary Object Type Class LSSGOP_Revenue Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 683. Table 683. LSSGOP_Revenue Data Object Siebel Repository Name External Name LS SGOP_Revenue LS SGOP_Revenue Interface Description (WSDL) for LSSGOP_Revenue 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. ...LSSGOP_Revenuehttp_siebel.com_asi_LSSGOP_Revenue.WSDL LSSGOP_SampleDisclaimer Use this Web service to create, update, delete, and query records in the SampleDisclaimer object. LSSGOP_SampleDisclaimer Operations This Web service allows you to create, update, delete, and query records in the SampleDisclaimer object. For a list of operations, see Table 684. Table 684. LSSGOP_SampleDisclaimer Operations Name Description SampleDisclaimerInsert Creates a sampledisclaimer record. SampleDisclaimerUpdate Updates an existing sampledisclaimer record. Siebel CRM Web Services Reference Version 8.1/8.2 280
- 281. Siebel CRM Primary Web Services ■ LSSGOP_SampleDisclaimer Table 684. LSSGOP_SampleDisclaimer Operations Name Description SampleDisclaimerDelete Deletes a sampledisclaimer record. SampleDisclaimerQueryPage Queries for a sampledisclaimer record. Request Message Description: SampleDisclaimerInsert For a description of this request message, see Table 685. Table 685. Request Message Description: SampleDisclaimerInsert Node Description Type Disclaimer Name of the account to be inserted. DisclaimerNumber Disclaimer number. Number Response Message Description: SampleDisclaimerInsert For a description of this response message, see Table 686. Table 686. Response Message Description: SampleDisclaimerInsert Node Description Type Id ID of the newly created sampledisclaimer record. Request Message Description: SampleDisclaimerUpdate For a description of this request message, see Table 687. String String Table 687. Request Message Description: SampleDisclaimerUpdate Node Description Type Id ID of the sampledisclaimer record. String Disclaimer Disclaimer of the co.rresponding record. String DisclaimerNumber Disclaimer number of the corresponding record. String Siebel CRM Web Services Reference Version 8.1/8.2 281
- 282. Siebel CRM Primary Web Services ■ LSSGOP_SampleDisclaimer Response Message Description: SampleDisclaimerUpdate For a description of this response message, see Table 688. Table 688. Response Message Description: SampleDisclaimerUpdate Node Description Type Id ID of the updated Request Message Description: SampleDisclaimerDelete For a description of this request message, see Table 689. Response Message Description: SampleDisclaimerDelete For a description of this response message, see Table 690. Request Message Description: SampleDisclaimerQueryPage For a description of this request message, see Table 691. Response Message Description: SampleDisclaimerQueryPage For a description of this response message, see Table 692. Siebel CRM Web Services Reference Version 8.1/8.2 282 sampledisclaimer record. String Table 689. Request Message Description: SampleDisclaimerDelete Node Description Type Id ID of the sampledisclaimer record to be deleted. String Table 690. Response Message Description: SampleDisclaimerDelete Node Description Type Id ID of the deleted sampledisclaimer record. String Table 691. Request Message Description: SampleDisclaimerQueryPage Node Description Type Id ID of the sampledisclaimer record to be queried. String Table 692. Response Message Description: SampleDisclaimerQueryPage Node Description Type Id ID of the sampledisclaimer record. String
- 283. Siebel CRM Primary Web Services ■ LSSGOP_SampleDropped LSSGOP_SampleDisclaimer 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 693. Table 693. LSSGOP_SampleDisclaimer Service Object Name Boundary Object Type Class LSSGOP_SampleDisclaimer Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 694. Table 694. LSSGOP_SampleDisclaimer Data Object Siebel Repository Name External Name LS SGOP_SampleDisclaimer LS SGOP_SampleDisclaimer Interface Description (WSDL) for LSSGOP_SampleDisclaimer 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. ...LSSGOP_SampleDisclaimerhttp_siebel.com_asi_LSSGOP_SampleDisclaimer.WSDL LSSGOP_SampleDropped Use this Web service to create, update, delete, and query records in the SampleDropped object. LSSGOP_SampleDropped Operations This Web service allows you to create, update, delete, and query records in the SampleDropped object. For a list of operations, see Table 695. Table 695. LSSGOP_SampleDropped Operations Name Description SampleDroppedInsert Creates a sampledropped record. SampleDroppedUpdate Updates an existing sampledropped record. Siebel CRM Web Services Reference Version 8.1/8.2 283
- 284. Siebel CRM Primary Web Services ■ LSSGOP_SampleDropped SampleDroppedDelete Deletes a sampledropped record. SampleDroppedQueryPage Queries for a sampledropped record. Request Message Description: SampleDroppedInsert For a description of this request message, see Table 696. Table 696. Request Message Description: SampleDroppedInsert Node Description Type Name Name of the corresponding record. String LotId Lot ID of the corresponding Response Message Description: SampleDroppedInsert For a description of this response message, see Table 697. Request Message Description: SampleDroppedUpdate For a description of this request message, see Table 698. Siebel CRM Web Services Reference Version 8.1/8.2 284 record. String ProductAllocationId Product allocation ID of the corresponding record. String Quantity Quantity of the corresponding record. String Type Type of the corresponding record. String Table 697. Response Message Description: SampleDroppedInsert Node Description Type Id ID of the newly created sampledropped record. String Table 698. Request Message Description: SampleDroppedUpdate Node Description Type Id ID of the sampledropped record. String Name Name of the corresponding record. String LotId Lot ID of the corresponding record. Number ProductAllocationId Product allocation ID of the corresponding record. Number Table 695. LSSGOP_SampleDropped Operations Name Description
- 285. Siebel CRM Primary Web Services ■ LSSGOP_SampleDropped Table 698. Request Message Description: SampleDroppedUpdate Node Description Type Quantity Quantity of the corresponding record. Type Type of the corresponding record. String Response Message Description: SampleDroppedUpdate For a description of this response message, see Table 699. Table 699. Response Message Description: SampleDroppedUpdate Node Description Type Id ID of the updated sampledropped record. Request Message Description: SampleDroppedDelete For a description of this request message, see Table 700. Table 700. Request Message Description: SampleDroppedDelete Node Description Type Id ID of the sampledropped record to be deleted. Response Message Description: SampleDroppedDelete For a description of this response message, see Table 701. Table 701. Response Message Description: SampleDroppedDelete Node Description Type Id ID of the deleted sampledropped record. Request Message Description: SampleDroppedQueryPage For a description of this request message, see Table 702. String String String String Table 702. Request Message Description: SampleDroppedQueryPage Node Description Type Id ID of the sampledropped record to be queried. String Siebel CRM Web Services Reference Version 8.1/8.2 285
- 286. Siebel CRM Primary Web Services ■ LSSGOP_SampleInventory Response Message Description: SampleDroppedQueryPage For a description of this response message, see Table 703. Table 703. Response Message Description: SampleDroppedQueryPage Node Description Type Id ID of the sampledropped record. String LSSGOP_SampleDropped 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 704. Table 704. LSSGOP_SampleDropped Service Object Name Boundary Object Type Class LSSGOP_SampleDropped Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 705 Table 705. LSSGOP_SampleDropped Data Object Siebel Repository Name External Name LS SGOP_SampleDropped LS SGOP_SampleDropped Interface Description (WSDL) for LSSGOP_SampleDropped 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. ...LSSGOP_SampleDroppedhttp_siebel.com_asi_LSSGOP_SampleDropped.WSDL LSSGOP_SampleInventory Use this Web service to create, update, delete, and query records in the SampleInventory object. Siebel CRM Web Services Reference Version 8.1/8.2 286
- 287. Siebel CRM Primary Web Services ■ LSSGOP_SampleInventory LSSGOP_SampleInventory Operations This Web service allows you to create, update, delete, and query records in the SampleInventory object. For a list of operations, see Table 706. Table 706. LSSGOP_SampleInventory Operations Name Description SampleInventoryInsert Creates a sampleinventory record. SampleInventoryUpdate Updates an existing sampleinventory record. SampleInventoryDelete Deletes a sampleinventory record. SampleInventoryQueryPage Queries for a sampleinventory record. Request Message Description: SampleInventoryInsert For a description of this request message, see Table 707. Table 707. Request Message Description: SampleInventoryInsert Node Description Type ProductId Product ID of the corresponding record. StockPeriodId Stock period ID of the corresponding record. ServerQuantity Server quantity of the corresponding record. ClientQuantity Client quantity of the corresponding record. Response Message Description: SampleInventoryInsert For a description of this response message, see Table 708 String String String String Table 708. Response Message Description: SampleInventoryInsert Node Description Type Id ID of the newly created sampleinventory String Siebel CRM Web Services Reference Version 8.1/8.2 287
- 288. Siebel CRM Primary Web Services ■ LSSGOP_SampleInventory Request Message Description: SampleInventoryUpdate For a description of this request message, see Table 709. Table 709. Request Message Description: SampleInventoryUpdate Node Description Type Id ID of the sampleinventory. String ProductId Product ID of the corresponding Response Message Description: SampleInventoryUpdate For a description of this response message, see Table 710. Request Message Description: SampleInventoryDelete For a description of this request message, see Table 711. Response Message Description: SampleInventoryDelete For a description of this response message, see Table 712. Siebel CRM Web Services Reference Version 8.1/8.2 288 record. String StockPeriodId Stock period ID of the corresponding record. String ServerQuantity Server quantity of the corresponding record. String ClientQuantity Client quantity of the corresponding record. String Table 710. Response Message Description: SampleInventoryUpdate Node Description Type Id ID of the updated sampleinventory record. String Table 711. Request Message Description: SampleInventoryDelete Node Description Type Id ID of the sampleinventory record to be deleted. String Table 712. Response Message Description: SampleInventoryDelete Node Description Type Id ID of the deleted sampleinventory record. String
- 289. Siebel CRM Primary Web Services ■ LSSGOP_SampleInventory Request Message Description: SampleInventoryQueryPage For a description of this request message, see Table 713. Table 713. Request Message Description: SampleInventoryQueryPage Node Description Type Id ID of the sampleinventory record to be queried. Response Message Description: SampleInventoryQueryPage For a description of this response message, see Table 714. String Table 714. Response Message Description: SampleInventoryQueryPage Node Description Type Id ID of the sampleinventory record. String LSSGOP_SampleInventory 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 715. Table 715. LSSGOP_SampleInventory Service Object Name Boundary Object Type Class LSSGOP_SampleInventory Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 716. Table 716. LSSGOP_SampleInventory Data Object Siebel Repository Name External Name LS SGOP_SampleInventory LS SGOP_SampleInventory Interface Description (WSDL) for LSSGOP_SampleInventory 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. ...LSSGOP_SampleInventoryhttp_siebel.com_asi_LSSGOP_SampleInventory.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 289
- 290. Siebel CRM Primary Web Services ■ LSSGOP_SampleTransaction LSSGOP_SampleTransaction Use this Web service to create, update, delete, and query records in the SampleTransaction object. LSSGOP_SampleTransaction Operations This Web service allows you to create, update, delete, and query records in the SampleTransaction object. For a list of operations, see Table 717. Table 717. LSSGOP_SampleTransaction Operations Name Description SampleTransactionInsert Creates a sampletransaction record. SampleTransactionUpdate Update an existing sampletransaction record. SampleTransactionDelete Delete a sampletransaction record. SampleTransactionQueryPage Query for a sampletransaction record. Request Message Description: SampleTransactionInsert For a description of this request message, see Table 718. Table 718. Request Message Description: SampleTransactionInsert Node Description Type Name Name of the corresponding record. String TransactionDate Transaction date of the Response Message Description: SampleTransactionInsert For a description of this response message, see Table 719. Siebel CRM Web Services Reference Version 8.1/8.2 290 corresponding record. String TransactionStatus Transaction status of the corresponding record. String Table 719. Response Message Description: SampleTransactionInsert Node Description Type Id ID of the newly created sampletransaction. String
- 291. Siebel CRM Primary Web Services ■ LSSGOP_SampleTransaction Request Message Description: SampleTransactionUpdate For a description of this request message, see Table 720. Table 720. Request Message Description: SampleTransactionUpdate Node Description Type Id ID of the sampletransaction record. Name Name of the corresponding record. String TransactionDate Transaction date of the corresponding record. TransactionStatus Transaction status of the corresponding record. Response Message Description: SampleTransactionUpdate For a description of this response message, see Table 721. Table 721. Response Message Description: SampleTransactionUpdate Node Description Type Id ID of the updated account. String Request Message Description: SampleTransactionDelete For a description of this request message, see Table 722. Table 722. Request Message Description: SampleTransactionDelete Node Description Type Id ID of the sampletransaction record to be deleted. Response Message Description: SampleTransactionDelete For a description of this response message, see Table 723. String String String String Table 723. Response Message Description: SampleTransactionDelete Node Description Type Id ID of the deleted sampletransaction record. String Siebel CRM Web Services Reference Version 8.1/8.2 291
- 292. Siebel CRM Primary Web Services ■ LSSGOP_SampleTransaction Request Message Description: SampleTransactionQueryPage For a description of this request message, see Table 724. Table 724. Request Message Description: SampleTransactionQueryPage Node Description Type Id ID of the sampletransaction record Response Message Description: SampleTransactionQueryPage For a description of this response message, see Table 725. LSSGOP_SampleTransaction 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 726. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 727. Interface Description (WSDL) for LSSGOP_SampleTransaction 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. Siebel CRM Web Services Reference Version 8.1/8.2 292 to be queried. String Table 725. Response Message Description: SampleTransactionQueryPage Node Description Type Id ID of the sampletransaction record. String Table 726. LSSGOP_SampleTransaction Service Object Name Boundary Object Type Class LSSGOP_SampleTransaction Business Service CSSEAIUIDataService Table 727. LSSGOP_SampleTransaction Data Object Siebel Repository Name External Name LS SGOP_SampleDisclaimer LS SGOP_SampleDisclaimer
- 293. Siebel CRM Primary Web Services ■ LSSGOP_Signature ...LSSGOP_SampleTransactionhttp_siebel.com_asi_LSSGOP_SampleTransaction.WSDL LSSGOP_Signature Use this Web service to create, update, delete, and query records in the Signature object. LSSGOP_Signature Operations This Web service allows you to create, update, delete, and query records in the Signature object. For a list of operations, see Table 728. Table 728. LSSGOP_Signature Operations Name Description SignatureInsert Creates a signature record. SignatureUpdate Updates an existing signature record. SignatureDelete Deletes a signature record. SignatureQueryPage Queries for a signature record. Request Message Description: SignaturetInsert For a description of this request message, see Table 729. Table 729. Request Message Description: SignaturetInsert Node Description Type ActivityId Activity ID of the corresponding record. String CallDate Call date of the corresponding record. String ContactId Contact ID of the corresponding record. String DisclaimerId Disclaimer ID of the corresponding record. String Signature Signature of the corresponding record. String SignatureBodyText Signature body text of the corresponding record. String SignatureHeaderText Signature header text of the corresponding record. String Siebel CRM Web Services Reference Version 8.1/8.2 293
- 294. Siebel CRM Primary Web Services ■ LSSGOP_Signature Response Message Description: SignatureInsert For a description of this response message, see Table 730. Table 730. Response Message Description: SignatureInsert Node Description Type Id ID of the newly created Request Message Description: SignatureUpdate For a description of this request message, see Table 731. Response Message Description: SignatureUpdate For a description of this response message, see Table 732. Siebel CRM Web Services Reference Version 8.1/8.2 294 signature record. String Table 731. Request Message Description: SignatureUpdate Node Description Type Id ID of the signature record. String ActivityId Activity ID of the corresponding record. String CallDate Call date of the corresponding record. String ContactId Contact ID of the corresponding record. String DisclaimerId Disclaimer ID of the corresponding record. String Signature Signature of the corresponding record. String SignatureBodyText Signature body text of the corresponding record. String SignatureHeaderText Signature header text of the corresponding record. String Table 732. Response Message Description: SignatureUpdate Node Description Type Id Activity ID of the corresponding record. String
- 295. Siebel CRM Primary Web Services ■ LSSGOP_Signature Request Message Description: SignatureDelete For a description of this request message, see Table 733. Table 733. Request Message Description: SignatureDelete Node Description Type Id ID of the signature record to be deleted. Response Message Description: SignatureDelete For a description of this response message, see Table 734. Table 734. Response Message Description: SignatureDelete Node Description Type Id ID of the deleted signature record. String Request Message Description: SignatureQueryPage For a description of this request message, see Table 735. Table 735. Request Message Description: SignatureQueryPage Node Description Type Id ID of the signature record to be queried. Response Message Description: SignatureQueryPage For a description of this response message, see Table 736. String String Table 736. Response Message Description: SignatureQueryPage Node Description Type Id ID of the signature record. String LSSGOP_Signature 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. Siebel CRM Web Services Reference Version 8.1/8.2 295
- 296. Siebel CRM Primary Web Services ■ LSSGOP_TransactionItem Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 737. Table 737. LSSGOP_Signature Service Object Name Boundary Object Type Class LSSGOP_Signature Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 738. Table 738. LSSGOP_Signature Data Object Siebel Repository Name External Name LS SGOP_Signature LS SGOP_Signature Interface Description (WSDL) for LSSGOP_Signature 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. ...LSSGOP_Signaturehttp_siebel.com_asi_LSSGOP_Signature.WSDL LSSGOP_TransactionItem Use this Web service to create, update, delete, and query records in the TransactionItem object. LSSGOP_TransactionItem Operations This Web service allows you to create, update, delete, and query records in the TransactionItem object. For a list of operations, see Table 739. Table 739. LSSGOP_TransactionItem Operations Name Description TransactionItemInsert Creates a transactionitem record. TransactionItemUpdate Updates a existing transactionitem record. TransactionItemDelete Deletes a transactionitem record. TransactionItemQueryPage Queries for a transactionitem record. Siebel CRM Web Services Reference Version 8.1/8.2 296
- 297. Siebel CRM Primary Web Services ■ LSSGOP_TransactionItem Request Message Description: TransactionItemInsert For a description of this request message, see Table 740. Table 740. Request Message Description: TransactionItemInsert Node Description Type ProductId Product ID of the corresponding record. SampleTransactionId Sample transaction ID of the corresponding record. Lot Lot of the corresponding record. String LineNumber Line number of the corresponding record. ItemStatus Item status of the corresponding record. Quantity Quantity of the corresponding record. Response Message Description: TransactionItemInsert For a description of this response message, see Table 741. Table 741. Response Message Description: TransactionItemInsert Node Description Type Id ID of the newly created transactionitem record. Request Message Description: TransactionItemUpdate For a description of this request message, see Table 742. String String String String String String Table 742. Request Message Description: TransactionItemUpdat Node Description Type Id ID of the transactionitem record. String ProductId Product ID of the corresponding record. String SampleTransactionId Sample transaction ID of the corresponding record. String Lot Lot of the corresponding record. String LineNumber Line number of the corresponding record. String Siebel CRM Web Services Reference Version 8.1/8.2 297
- 298. Siebel CRM Primary Web Services ■ LSSGOP_TransactionItem Table 742. Request Message Description: TransactionItemUpdat Node Description Type ItemStatus Item status of the corresponding Response Message Description: TransactionItemUpdate For a description of this response message, see Table 743. Request Message Description: TransactionItemDelete For a description of this request message, see Table 744. Response Message Description: TransactionItemDelete For a description of this response message, see Table 745. Request Message Description: TransactionItemQueryPage For a description of this request message, see Table 746. Siebel CRM Web Services Reference Version 8.1/8.2 298 record. String Quantity Quantity of the corresponding record. String Table 743. Response Message Description: TransactionItemUpdate Node Description Type Id ID of the updated account. String Table 744. Request Message Description: TransactionItemDelete Node Description Type Id ID of the transactionitem record to be deleted. String Table 745. Response Message Description: TransactionItemDelete Node Description Type Id ID of the deleted transactionitem record. String Table 746. Request Message Description: TransactionItemQueryPage Node Description Type Id ID of the transactionitem record to be queried. String
- 299. Siebel CRM Primary Web Services ■ ModificationTracking Response Message Description: TransactionItemQueryPage For a description of this response message, see Table 747. Table 747. Response Message Description: TransactionItemQueryPage Node Description Type Id ID of the transactionitem record. String LSSGOP_TransactionItem 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 748. Table 748. LSSGOP_TransactionItem Service Object Name Boundary Object Type Class LSSGOP_TransactionItem Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 749. Table 749. LSSGOP_TransactionItem Data Object Siebel Repository Name External Name LS SGOP_TransactionItem LS SGOP_TransactionItem Interface Description (WSDL) for LSSGOP_TransactionItem 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. ...LSSGOP_TransactionItemhttp_siebel.com_asi_LSSGOP_TransactionItem.WSDL ModificationTracking Use this Web service to query records in the ModificationTracking object. Siebel CRM Web Services Reference Version 8.1/8.2 299
- 300. Siebel CRM Primary Web Services ■ ModificationTracking ModificationTracking Operations This Web service allows you to query records in the ModificationTracking object. For a list of operations, see Table 750. Table 750. ModificationTracking Operations Name Description QueryPage Creates a modificationtracking record. Request Message Description: QueryPage For a description of this request message, see Table 751. Table 751. Request Message Description: QueryPage Node Description Type Id ID of a modificationtracking record Response Message Description: QueryPage For a description of this response message, see Table 752. ModificationTracking 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 753. Siebel CRM Web Services Reference Version 8.1/8.2 300 to be queried. String Table 752. Response Message Description: QueryPage Node Description Type Id ID of a modificationtracking record. String Table 753. ModificationTracking Service Object Name Boundary Object Type Class Modification Tracking Business Service CSSEAIUIDataService
- 301. Siebel CRM Primary Web Services ■ LSSGOP_ModificationTrackingPurge Data Object (Integration Object) For a description of the data objects for this Web service, see Table 754. Table 754. ModificationTracking Data Object Siebel Repository Name External Name Modification Tracking LS SGOP Modification Tracking Interface Description (WSDL) for ModificationTracking 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. ...ModificationTrackinghttp_siebel.com_asi_ModificationTracking.WSDL LSSGOP_ModificationTrackingPurge Use this Web service to delete records from the ModificationTracking object. LSSGOP_ModificationTrackingPurge Operations This Web service allows you to delete records from the ModificationTracking object. For a list of operations, see Table 755. Table 755. LSSGOP_ModificationTrackingPurge Operations Name Description Delete Deletes a modificationtracking record. Request Message Description: Delete For a description of this request message, see Table 756. Table 756. Request Message Description: Delete Node Description Type Id ID of a modificationtracking record to be deleted. String Siebel CRM Web Services Reference Version 8.1/8.2 301
- 302. Siebel CRM Primary Web Services ■ MatchAccountSiebelReqABCSImpl Response Message Description: Delete For a description of this response message, see Table 757. Table 757. Response Message Description: Delete Node Description Type Id ID of a deleted LSSGOP_ModificationTrackingPurge 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 758. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 759. Interface Description (WSDL) for LSSGOP_ModificationTrackingPurge 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. ...LSSGOP_ModificationTrackingPurgehttp_siebel.com_asi_ModificationTrackingPurge.WSD L MatchAccountSiebelReqABCSImpl Use this outbound Web service to synchronize account details with the participating application by fetching the account details from the Siebel database. This Web service is called when the fetch process is triggered in the Siebel application from the Account list or form applets and also from the Match Account pop-up applet. Siebel CRM Web Services Reference Version 8.1/8.2 302 modificationtracking record. String Table 758. LSSGOP_ModificationTrackingPurge Service Object Name Boundary Object Type Class Modification Tracking Business Service CSSEAIUIDataService Table 759. LSSGOP_ModificationTrackingPurge Service Object Siebel Repository Name External Name LS SGOP Modification Tracking Purge LS SGOP Modification Tracking
- 303. Siebel CRM Primary Web Services ■ MatchAccountSiebelReqABCSImpl MatchAccountSiebelReqABCSImpl Operations For a list of operations associated with this Web service, see Table 760. Table 760. MatchAccountSiebelReqABCSImpl Operations Name Description MatchAccount Use this Web service to query an account to satisfy search criteria from a participating application and display the results in the Siebel CRM application without storing the data inthe Siebel database. This operation is called from the Match Account pop-up window when a user clicks the Go button to query account details from the participating application. Request Message Description: MatchAccount For a description of this request message, see Table 761. Table 761. Request Message Description: MatchAccount Node Description Type MatchAccountReqMsg:payload Optional Hierarchy CustomHeaderContext Optional Hierarchy Response Message Description: MatchAccount For a description of this response message, see Table 762. Table 762. Request Message Description: MatchAccount Node Description Type CustomHeaderContext Optional Hierarchy MatchAccountRespMsg:payload Optional Hierarchy XMLHierarchyOutput Optional Hierarchy faultactor Optional String faultcode Optional String faultstring Optional String MatchAccountFaultMsg:payload Optional Integration Object MatchAccountSiebelReqABCSImpl 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. Siebel CRM Web Services Reference Version 8.1/8.2 303
- 304. Siebel CRM Primary Web Services ■ MatchContactSiebelReqABCSImpl Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 763. Table 763. MatchAccountSiebelReqABCSImpl Service Object Siebel Repository Name Data Object (Integration Object) For a description of data objects for this Web service, see Table 764. Methods For a description of the methods for this Web service, see Table 765. Interface Description (WSDL) for MatchAccountSiebelReqABCSImpl 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. WSDL ...WSDLMatchAccountSiebelReqABCSImpl.wsdl MatchContactSiebelReqABCSImpl Use this outbound Web service to synchronize Contact details with the participating application and the Siebel database. This Web service is called from the Siebel application when the fetch process is called from the Contact list or form applets and also from the Match Contact pop-up applet. Siebel CRM Web Services Reference Version 8.1/8.2 304 Boundary Object Type Class SSWI External Account Integration Process Workflow Not applicable Table 764. MatchAccountSiebelReqABCSImpl Data Object Siebel Repository Name External Name SWIMatchAccountVBCIO Account Fault Fault Table 765. MatchAccountSiebelReqABCSImpl Methods Operation Method MatchAccount MatchAccount
- 305. Siebel CRM Primary Web Services ■ MatchContactSiebelReqABCSImpl MatchContactSiebelReqABCSImpl Operations For a list of operations associated with this Web service, see Table 766. Table 766. MatchContactSiebelReqABCSImpl Operations Name Description MatchContact Use this Web service to query a contact to satisfy search criteria from a participating application and display the results in the Siebel CRM application without storing the data in the Siebel database. This operation is called from the Match Contact pop-up window when a user clicks the Go button to query account details from the participating application. Request Message Description: MatchContact For a description of this request message, see Table 767. Table 767. Request Message Description: MatchContact Node Description Type MatchContactReqMsg:payload Optional Hierarchy CustomHeaderContext Optional Hierarchy Response Message Description: MatchContact For a description of this response message, see Table 768. Table 768. Response Message Description: MatchContact Node Description Type CustomHeaderContext Optional Hierarchy MatchContactRespMsg:payload Optional Hierarchy XMLHierarchyOutput Optional Hierarchy faultactor Optional String faultcode Optional String faultstring Optional String MatchContactFaultMsg:payload Optional Integration Object MatchContactSiebelReqABCSImpl 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. Siebel CRM Web Services Reference Version 8.1/8.2 305
- 306. Siebel CRM Primary Web Services ■ MktgDeduplicationService Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 769. Table 769. MatchContactSiebelReqABCSImpl Service Object Siebel Repository Name Data Object (Integration Object) For a description of data objects for this Web service, see Table 770. Methods For a description of the methods for this Web service, see Table 771. MktgDeduplicationService Use this Web service to check whether a duplicate record exists for an account, contact, opportunity or prospect. Mktg Deduplication Service Operations For a list of operations associated with this Web service, see Table 772. Siebel CRM Web Services Reference Version 8.1/8.2 306 Boundary Object Type Class SWI External Contact Integration Process Workflow Not applicable Table 770. MatchContactSiebelReqABCSImpl Data Object Siebel Repository Name External Name SWIMatchAccountVBCIO SWIMatchContactVBCIO Fault Fault Table 771. MatchAccountSiebelReqABCSImpl Methods Operation Method MatchContact MatchContact Table 772. Mktg Deduplication Service Operations Node Description MktgDeduplicationServiceMatchAccount Matches account information provided with the accounts in the system and returns the row ids of the duplicates found with the score for each account. MktgDeduplicationServiceMatchOpportunity Matches the opportunities. MktgDeduplicationServiceMatchProspect Matches the prospects. MktgDeduplicationServiceMatchContact Matches the contacts.
- 307. Siebel CRM Primary Web Services ■ MktgDeduplicationService Request Message Description: MktgDeduplicationServiceMatchAccount For a description of this request message, see Table 773. Table 773. Request Message Description: MktgDeduplicationServiceMatchAccount Node Description Type DUNS Number Dun and Bradstreet data universal numbering system number. Name Account name. String Primary Account City City name. String Primary Account Country Country name. String Primary Account Postal Code City postal code. String Primary Account State State. String Primary Account Street Address Street address of primary account. String Response Message Description: MktgDeduplicationServiceMatchAccount For a description of this response message, see Table 774. Table 774. Response Message Description: MktgDeduplicationServiceMatchAccount Node Description Type HasMatch The output string is “hasMatch” or “hasNoMatch”. String Match Info Score of the match and row id of the record matched. Integration Object Response Message Description: MktgDeduplicationServiceMatchOpportunity For a description of this response message, see Table 775. String Table 775. Response Message Description: MktgDeduplicationServiceMatchOpportunity Node Description Type Account Id Opportunity’s account ID. String Business Unit Id Opportunity’s business unit ID. String Name Opportunity’s name. String Siebel CRM Web Services Reference Version 8.1/8.2 307
- 308. Siebel CRM Primary Web Services ■ MktgDeduplicationService Response Message Description: MktgDeduplicationServiceMatchOpportunity For a description of this response message, see Table 776. Table 776. Response Message Description: MktgDeduplicationServiceMatchOpportunity Node Description Type HasMatch Output string as “hasMatch” or “hasNoMatch”. String Match Info Score of the match and row id of the record Request Message Description: MktgDeduplicationServiceMatchProspect For a description of this request message, see Table 777. Response Message Description: MktgDeduplicationServiceMatchProspect For a description of this response message, see Table 778. Siebel CRM Web Services Reference Version 8.1/8.2 308 matched. Integration Object Table 777. Request Message Description: MktgDeduplicationServiceMatchProspect Node Description Type Account Account name of prospect. String Phone Phone number of prospect. String City Prospect’s city. String Country Prospect’s country. String Email Address Prospect’s email address. String First Name Prospect’s first name. String Home Phone # Prospect’s home phone number. String Last Name Prospect’s last name. String Middle Name Prospect’s middle name. String Primary Postal Code Postal code. String Social Security Number Prospect’s social security number. String State Prospect’s state of residence. String Street Address Prospect’s street address. String Work Phone # Prospect’s work phone number. String Table 778. Response Message Description: MktgDeduplicationServiceMatchProspect Node Description Type HasMatch Output String as “hasMatch” or “hasNoMatch”. String Match Info Score of the match and row id of the record matched. Integration Object
- 309. Siebel CRM Primary Web Services ■ MktgDeduplicationService Request Message Description: MktgDeduplicationServiceMatchContact For a description of this request message, see Table 779. Table 779. Request Message Description: MktgDeduplicationServiceMatchContact Node Description Type Account Account name of contact. String Birth Date Contact’s birth date. String Phone Contact’s phone number. String City Contact’s city of residence. String Country Contact’s country of residence. String Email Address Contact’s email address. String First Name Contact’s first name. String Home Phone # Contact’s home phone number. String Last Name Contact’s last name. String Middle Name Contact’s middle name. String Primary Postal Code Contact’s primary postal code. String Social Security Number Contact’s social security number. String State Contact’s state of residence. String Street Address Contact’s street address. String Work Phone # Contact’s work phone number. String Response Message Description: MktgDeduplicationServiceMatchContact For a description of this response message, see Table 780. Table 780. Response Message Description: MktgDeduplicationServiceMatchContact Node Description Type HasMatch Output String as “hasMatch” or “hasNoMatch”. String Match Info Score of the match and row id of the record matched. Integration Object MktgImportDeduplicationService 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. Siebel CRM Web Services Reference Version 8.1/8.2 309
- 310. Siebel CRM Primary Web Services ■ MktgDeduplicationService Data Object (Integration Object) For a description of data objects for this Web service, see Table 781. Table 781. MktgImportDeduplicationService Data Object Siebel Repository Name External Name Mktg Deduplication Mktg Deduplication Example Package for MktgDeduplicationService To view an example of messages 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. Request (MatchAccount) See the following file to view the sample code: ...MktgDeduplicationServiceMatchAccount_request.xml Response (MatchAccount) See the following file to view the sample code: ...MktgDeduplicationServiceMatchAccount_response.xml Request (MatchOpportunity) See the following file to view the sample code: ...MktgDeduplicationServiceMatchOpportuntity_request.xml Response (MatchOpportunity) See the following file to view the sample code: ...MktgDeduplicationServiceMatchOpportuntity_response.xml Request (MatchProspect) See the following file to view the sample code: ...MktgDeduplicationServiceMatchProspect_request.xml Response (MatchProspect) See the following file to view the sample code: ...MktgDeduplicationServiceMatchProspect_response.xml Siebel CRM Web Services Reference Version 8.1/8.2 310
- 311. Siebel CRM Primary Web Services ■ MktgImportService Request (MatchContact) See the following file to view the sample code: ...MktgDeduplicationServiceMatchContact_request.xml Response (MatchContact) See the following file to view the sample code: ...MktgDeduplicationServiceMatchContact_response.xml Interface Description (WSDL) for Mktg Deduplication Service 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. ...MktgDeduplicationServiceMktgDedup.wsdl MktgImportService This Web service is used for all the imports into the Siebel Marketing application such as Leads, Contacts, Prospects and so on. Mktg Import Service Operations For a list of operations associated with this Web service, see Table 782. Table 782. Mktg Import Service Operations Node Description MktgImportServiceInvokeImportJob Schedules various import processes for Marketing. Request Message Description: MktgImportServiceInvokeImportJob This method gets the details of the records from the business component Invoke Import Jobs and schedules the import process. For a description of this request message, see Table 783. Table 783. Request Message Description: MktgImportServiceInvokeImportJob Node Description Type ImportJobParams Required. An instance of the integration object Import Job Integration Object. Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 311
- 312. Siebel CRM Primary Web Services ■ MktgImportService Response Message Description: MktgImportServiceInvokeImportJob For a description of this response message, see Table 784. Table 784. Response Message Description: MktgImportServiceInvokeImportJob Node Description Type ErrorCode Error code values are OK or NOTOK. String Error Message Error message (if any) String Mktg Import Service 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 785. Table 785. Mktg Import Service Service Object Name Boundary Object Type Class Mktg System Task Service Business Service CSSSystemTaskService Data Object (Integration Object) For a description of data objects for this Web service, see Table 786. Table 786. Mktg Import Service Data Object Siebel Repository Name External Name Import Job Integration Object Import Job Integration Object Example Package for MktgImportService To view an example of messages 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. Request See the following file to view the sample code: ...MktgImportServiceMktgImportServiceInvokeImportJob_request.xml Response See the following file to view the sample code: Siebel CRM Web Services Reference Version 8.1/8.2 312
- 313. Siebel CRM Primary Web Services ■ NetworkOrderEntry ...MktgImportServiceMktgImportServiceInvokeImportJob_response.xml Interface Description (WSDL) for Mktg Import Service 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. ...MktgImportServiceMktgImportService.wsdl NetworkOrderEntry Use this Web service to access network assets, as well as related attributes, attached files, and open orders. Additionally, use this Web service to validate a network based on product rules and return projected assets for a network. NetworkOrderEntry Operations For a list of operations associated with this Web service, see Table 787. Table 787. NetworkOrderEntry Operations Name Description GetNetworkAssets Returns the network asset based on the asset ID. GetNetworkAssetAttributes Returns the attribute of a network asset regardless of whether the attribute is a network, network node, or network connection. GetNetworkAssetAttachments Returns the file attachment for a network asset. GetOpenNetworkOrders Returns the open order line items for a network asset. ValidateNetworkOrder Validates a network based on product rules. If the network is invalid, then an error message is returned. QueryProjectedNetworkAsset Returns the projected asset for a network. Common Request Message Description The service has six operations. They do not share a common request message format. Common Response Message Description The service has six operations. They do not share a common response message format. NetworkOrderEntry 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. Siebel CRM Web Services Reference Version 8.1/8.2 313
- 314. Siebel CRM Primary Web Services ■ NetworkOrderEntry Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 788. Table 788. NetworkOrderEntry Service Object Name Boundary Object Type Class (if BusService) VORD NOE Complex Data Service Business Service CSSVORDWebService VORD NOE Simple Data Service Business Service CSSVORDWebService Data Object (Integration Object) For a description of data objects for this Web service, see Table 789. Table 789. NetworkOrderEntry Data Object Siebel Repository Name External Name Business Service VORD NOE Network Assets VORD NOE Asset Attributes VORD NOE Simple Data Methods For a description of methods for this Web service, see Table 790. Siebel CRM Web Services Reference Version 8.1/8.2 314 Service VORD NOE Asset Attributes VORD NOE Asset Attributes VORD NOE Simple Data Service VORD NOE Network Attachments VORD Network Asset VORD NOE Simple Data Service VORD NOE Network Open Order Line Items VORD Network Asset VORD NOE Simple Data Service VORD NOE Network Validation Rule VORD Network Validation Rule VORD NOE Complex Data Service VORD NOE Projected Asset VORD NOE Projected Asset VORD NOE Complex Data Service Table 790. NetworkOrderEntry Methods Operation Business Service Method GetNetworkAssets VORD NOE Simple Data Service GetNetworkAssets GetNetworkAssetAttributes VORD NOE Simple Data Service GetNetworkAssetAttributes GetNetworkAssetAttachments VORD NOE Simple Data Service GetNetworkAssetAttachments GetOpenNetworkOrders VORD NOE Simple Data Service GetOpenNetworkOrders ValidateNetworkOrder VORD NOE Complex Data Service ValidateNetworkOrder QueryProjectedNetworkAsset VORD NOE Complex Data Service QueryProjectedNetworkAsset
- 315. Siebel CRM Primary Web Services ■ OrderDetailWebService OrderDetailWebService Use this Web service to query orders based on search criteria, and to retrieve details from a particular order. Details include payments, approvals, shipping, and billing charges, and tracked order shipment details. Additionally, you can copy current order lines to a cart, or cancel an order. OrderDetailWebService Operations For a list of operations associated with this Web service, see Table 791. Table 791. OrderDetailWebService Operations Name Description OrderDetailQueryPage Performs query operations based on the view criteria and the search specifications set on the PDS Order Detail integration object as the input. This operation is used for querying order details including the payment, approvals, and shipping, and billing details. OrderDetailUpdate Performs update operations on the PDS Order Detail integration object as the input. This operation is used for editing the details of an order such as copying lines of the current order or cancelling an order. Request Message Description: OrderDetailQueryPage Based on the view criteria and search specification set on the integration object, the order query can query the order header, line details of the order, approvals, payment, shipping, billing and shipment details. For a description of this request message, see Table 792. Table 792. Request Message Description: OrderDetailQueryPage Node Description Type OrderDetailQueryPage_Input The method arguments are Orders IO with query parameters set, Language Mode (value is LDC) and viewMode (All). Integration Object Response Message Description: OrderDetailQueryPage Based on the view criteria and search specification set on the integration object, information about order header, line details of the order, approvals, payment, shipping, billing and shipment details is returned in the response.For a description of this response message, see Table 793. Table 793. Response Message Description: OrderDetailQueryPage Node Description Type OrderDetailQueryPage_Output The retrieved data for the query set on the view criteria and search specification. Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 315
- 316. Siebel CRM Primary Web Services ■ OrderDetailWebService Request Message Description: OrderDetailUpdate For a description of this request message, see Table 794. Table 794. Request Message Description: OrderDetailUpdate Node Description Type OrderDetailUpdate_Input The method arguments are Orders IO with parameters Response Message Description: OrderDetailUpdate For a description of this response message, see Table 795. OrderDetailWebService 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. This Web service makes available the EAI UI Business Service PDS Order Detail, which provides update and query operations on the integration object PDS Order Detail. Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 796. Data Object (Integration Object) For a description of data objects for this Web service, see Table 797. Example Package for OrderDetailWebService To view an example of messages 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. Siebel CRM Web Services Reference Version 8.1/8.2 316 set, Language Mode (value is LDC) and viewMode (All). Integration Object Table 795. Response Message Description: OrderDetailUpdate Node Description Type OrderDetailUpdate_Output The retrieved data for the update operation performed. Integration Object Table 796. OrderDetailWebService Service Object Name Boundary Object Type Class PDS Order Detail Integration Object CSSEAIUIDataService Table 797. OrderDetailWebService Data Object Siebel Repository Name External Name PDS Order Detail PDS Simplified Order
- 317. Siebel CRM Primary Web Services ■ PaymentAuthorizationSalesOrderSiebelReqABCSImpl Request See the following file to view the sample code: ...OrderDetailWebServiceOrderDetailWebService_request.xml Response See the following file to view the sample code: ...OrderDetailWebServiceOrderDetailWebService_response.xml Interface Description (WSDL) for OrderDetailWebService 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. ...OrderDetailWebServiceOrderDetail.wsdl PaymentAuthorizationSalesOrderSiebel ReqABCSImpl Use this Web service to check whether this payment record is valid for the customer PaymentAuthorizationSalesOrderSiebelReqABCSImpl Operations For a list of operations associated with this Web service, see Table 798. Table 798. PaymentAuthorizationSalesOrderSiebelReqABCSImpl Operations Name Description PaymentAuthorization Checks for the validity of the payment record. Request Message Description: PaymentAuthorization For a description of this request message, see Table 799. Table 799. Request Message Description: PaymentAuthorization Node Description Type PaymentAuthorizationSalesOrderRe qMsg:ListOfSWIOrderIO Optional Hierarchy CustomHeaderContext Optional Hierarchy Siebel CRM Web Services Reference Version 8.1/8.2 317
- 318. Siebel CRM Primary Web Services ■ PaymentAuthorizationSalesOrderSiebelReqABCSImpl Response Message Description: PaymentAuthorization For a description of this response message, see Table 800. Table 800. Response Message Description: PaymentAuthorization Node Description Type CustomHeaderContext Optional Hierarchy PaymentAuthorizationSalesOrderRe spMsg:ListOfSWIOrderIO PaymentAuthorizationSalesOrderSiebelReqABCSImpl 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 801. Data Object (Integration Object) For a description of data objects for this Web service, see Table 802. Siebel CRM Web Services Reference Version 8.1/8.2 318 Optional Hierarchy XMLHierarchyOutput Optional Hierarchy faultactor Optional String faultcode Optional String faultstring Optional String SiebelFaultMsg:Fault Optional Integration Object Table 801. PaymentAuthorizationSalesOrderSiebelReqABCSImpl Service Object Siebel Repository Name Boundary Object Type Class SWISendPaymentAuthorization Workflow Not applicable Table 802. PaymentAuthorizationSalesOrderSiebelReqABCSImpl Data Object Siebel Repository Name External Name SWIOrderIO SWIOrderIO Fault Fault
- 319. Siebel CRM Primary Web Services ■ PaymentSiebelCommsReqABCS Methods For a description of the methods for this Web service, see Table 803. Table 803. PaymentAuthorizationSalesOrderSiebelReqABCSImpl Methods Operation Method PaymentAuthorization PaymentAuthorization Interface Description (WSDL) for PaymentAuthorizationSalesOrderSiebelReqABCSImpl 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. ...PaymentAuthorizationSalesOrderSiebelReqABCSImplPaymentAuthorizationSalesOrderSieb elReqABCSImpl.wsdl PaymentSiebelCommsReqABCS Use this Web service to query for invoice details in the external Oracle Communications Billing and Revenue Management application that will be displayed on a billing profile in the Billing user interface. PaymentSiebelCommsReqABCS Operations For a list of operations associated with this Web service, see Table 804. Table 804. PaymentSiebelCommsReqABCS Operations Name Description QueryPayment Queries for payments on a billing profile in the Siebel Communications Billing UI SearchPayment Searches for payments on a billing profile in the Siebel Communications Billing UI CreatePayment Creates payments on a billing profile in the Siebel Communications Billing UI CreateInvoicePayment Creates payments on a bill in the Siebel Communications Billing UI QueryInvoicePayment Queries for payments on a bill in the Siebel Communications Billing UI Siebel CRM Web Services Reference Version 8.1/8.2 319
- 320. Siebel CRM Primary Web Services ■ PaymentSiebelCommsReqABCS Request Message Description: QueryPayment For a description of this request message, see Table 805. Table 805. Request Message Description: QueryPayment Node Description Type CustomHeaderContext Optional Hierarchy QueryPaymentReqMsg:ListOfCmuRequestBillingProfileIo Optional Integration Object Response Message Description: QueryPayment For a description of this response message, see Table 806. Table 806. Response Message Description: QueryPayment Node Description Type QueryPaymentRespMsg:ListOfCmuResponseBillingProfilePayments Io Request Message Description: SearchPayment For a description of this request message, see Table 807. Response Message Description: SearchPayment For a description of this response message, see Table 808. Siebel CRM Web Services Reference Version 8.1/8.2 320 Optional Integration Object Table 807. Request Message Description: SearchPayment Node Description Type CustomHeaderContext Optional Hierarchy SearchPaymentReqMsg:ListOfCmuRequestBillingProfilePayments SearchIo Optional Integration Object Table 808. Response Message Description: SearchPayment Node Description Type SearchPaymentRespMsg:ListOfCmuResponseBillingProfilePaymentsIo Optional Integration Object
- 321. Siebel CRM Primary Web Services ■ PaymentSiebelCommsReqABCS Request Message Description: CreatePayment For a description of this request message, see Table 809. Table 809. Request Message Description: CreatePayment Node Description Type CustomHeaderContext Optional Hierarchy CreatePaymentReqMsg:ListOfCmuRequestNewPaymentCaptureIo Optional Integration Response Message Description: CreatePayment For a description of this response message, see Table 810. Table 810. Response Message Description: CreatePayment Node Description Type CreatePaymentRespMsg:ListOfCmuResponseNewPaymentsIo Optional Integration Object Request Message Description: CreateInvoicePayment For a description of this request message, see Table 811. Table 811. Request Message Description: CreateInvoicePayment Node Description Type CustomHeaderContext Optional Hierarchy CreateInvoicePaymentReqMsg:ListOfCmuRequestNewPayment CaptureInvoiceIo Response Message Description: CreateInvoicePayment For a description of this response message, see Table 812. Object Optional Integration Object Table 812. Response Message Description: CreateInvoicePayment Node Description Type CreateInvoicePaymentRespMsg:ListOfCmuResponseNew PaymentInvoiceIo Optional Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 321
- 322. Siebel CRM Primary Web Services ■ PaymentSiebelCommsReqABCS Request Message Description: QueryInvoicePayment For a description of this request message, see Table 813. Table 813. Request Message Description: QueryInvoicePayment Node Description Type CustomHeaderContext Optional Hierarchy QueryInvoicePaymentReqMsg:ListOfCmuRequestBilledUsageIo Optional Integration Object Response Message Description: QueryInvoicePayment For a description of this response message, see Table 814. Table 814. Response Message Description: QueryInvoicePayment Node Description Type QueryInvoicePaymentRespMsg:ListOfCmuResponseBilledUsgae PaymentsIo PaymentSiebelCommsReqABCS 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 815. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 816. Siebel CRM Web Services Reference Version 8.1/8.2 322 Optional Integration Object Table 815. PaymentSiebelCommsReqABCS Service Object Name Boundary Object Type Class PaymentSiebelCommsReqABCS Business Service CSSWSOutboundDispatcher Table 816. PaymentSiebelCommsReqABCS Data Object Siebel Repository Name External Name CMU Response Billed Usage Payments IO Account CMU Request Billed Usage IO Account CMU Request Billing Profile IO Account CMU Response Billing Profile Payments IO Account CMU Request Billing Profile Payments Search IO Account
- 323. Siebel CRM Primary Web Services ■ PaymentSiebelCommsReqABCS Table 816. PaymentSiebelCommsReqABCS Data Object Siebel Repository Name External Name CMU Response Billing Profile Payments IO Account CMU Request New Payment Capture IO Account CMU Response New Payments IO Account CMU Request New Payment Capture Invoice IO Account CMU Response New Payment Invoice IO Account Methods For a description of the methods for this Web service, see Table 817. Table 817. PaymentSiebelCommsReqABCS Methods Operation Method QueryPayment QueryPayment SearchPayment SearchPayment CreatePayment CreatePayment CreateInvoicePayment CreateInvoicePayment QueryInvoicePayment QueryInvoicePayment Example Package for PaymentSiebelCommsReqABCS To view an example of messages 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. Request See the following file to view the sample code: ...PaymentSiebelCommsReqABCSRequest.xml Response See the following file to view the sample code: ...PaymentSiebelCommsReqABCSResponse.xml Interface Description (WSDL) for PaymentSiebelCommsReqABCS 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. Siebel CRM Web Services Reference Version 8.1/8.2 323
- 324. Siebel CRM Primary Web Services ■ PDSOrderHeader ...PaymentSiebelCommsReqABCSWSDL PDSOrderHeader Use this Web service to get header information for specific open orders. PDSOrderHeader Operations For a list of operations associated with this Web service, see Table 818. Table 818. PDSOrderHeader Operations Name Description PDSOrderHeaderQueryPage Get the header information of open orders for a specific asset. Request Message Description: PDSOrderHeaderQueryPage For a description of this request message, see Table 819. Table 819. Request Message Description: PDSOrderHeaderQueryPage Node Description Type PDSOrderHeaderQueryPage_Input The request message includes the search Response Message Description: PDSOrderHeaderQueryPage For a description of this response message, see Table 820. Example Package for PDSOrderHeader To view an example of messages 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. Request See the following file to view the sample code: ...PDSOrderHeaderPDSOrderHeader_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 324 criteria for order status and asset integration ID. ComplexType Table 820. Response Message Description: PDSOrderHeaderQueryPage Node Description Type PDSOrderHeaderQueryPage_Output The response message includes list of order headers matching the search criteria. ComplexType
- 325. Siebel CRM Primary Web Services ■ PriceListsWS Response See the following file to view the sample code: ...PDSOrderHeaderPDSOrderHeader_response.xml Interface Description (WSDL) for PDSOrderHeader 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. ...PDSOrderHeaderPDSOrderHeader.wsdl PriceListsWS Use this Web service to obtain price lists based on defined search specifications. PriceListsWS Operations For a list of operations associated with this Web service, see Table 821. Table 821. PriceListsWS Operations Node Description GetPriceLists Get all the price lists based on search spec. Request Message Description: GetPriceLists For a description of this request message, see Table 822. Table 822. Request Message Description: GetPriceLists Node Description Type GetPriceLists_Input Request message includes the search specification. Response Message Description: GetPriceLists For a description of this response message, see Table 823. ComplexType Table 823. Response Message Description: GetPriceLists Node Description Type GetPriceLists_Output Response message includes the price lists matching the search specification. ComplexType Siebel CRM Web Services Reference Version 8.1/8.2 325
- 326. Siebel CRM Primary Web Services ■ ProcessSalesOrderSiebelJMSProducer Example Package for PriceListsWS To view an example of messages 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. Request See the following file to view the sample code: ...PriceListsWSPriceListsWS_request.xml Response See the following file to view the sample code: ...PriceListsWSPriceListsWS_response.xml Interface Description (WSDL) for PriceListsWS 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. ...PriceListsWSPriceListsWS.wsdl ProcessSalesOrderSiebelJMSProducer Use this Web service to submit a sales order from the Siebel CRM application to the billing application and to create a customer account, if needed, in the billing application. The response message returns only an acknowledgement message and not data. ProcessSalesOrderSiebelJMSProducer Operations For a list of operations associated with this Web service, see Table 824. Table 824. ProcessSalesOrderSiebelJMSProducer Operations Operation Name Description Process Submits a sales order to the billing application and creates a customer Siebel CRM Web Services Reference Version 8.1/8.2 326 account, if needed, in the billing application.
- 327. Siebel CRM Primary Web Services ■ ProcessSalesOrderSiebelJMSProducer Request Message Description: Process For a description of this request message, see Table 825. Table 825. Request Message Description: Process Node Description Order The details of the header for the order. OrderItem The details of the order item. OrderItemXA The properties of the order item. ProcessSalesOrderSiebelJMSProducer 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 826. Table 826. ProcessSalesOrderSiebelJMSProducer Service Object Name Boundary Object Type Class (If Business Service) ProcessSalesOrderSiebelJMSProducer Business Service CSSWSOutboundDispatcher Data Object (Integration Object) For a description of data objects for this Web service, see Table 827. Table 827. ProcessSalesOrderSiebelJMSProducer Data Object Siebel Repository Name External Name PDS Order - No Hierarchy PDS Simplified Order Methods For a description of the methods for this Web service, see Table 828. Table 828. ProcessSalesOrderSiebelJMSProducer Methods Operation Method process [BS: ProcessSalesOrderSiebelJMSProducer].process Example Package for ProcessSalesOrderSiebelJMSProducer To view an example of messages 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. Siebel CRM Web Services Reference Version 8.1/8.2 327
- 328. Siebel CRM Primary Web Services ■ Product Configurator Web Service Request See the following file to view the sample code: ...ProcessSalesOrderSiebelJMSProducerProcessSalesOrderSiebelJMSProducerRequest Message.xml Response See the following file to view the sample code: ...ProcessSalesOrderSiebelJMSProducerProcessSalesOrderSiebelJMSProducerResponse Message.xml Interface Description (WSDL) for ProcessSalesOrderSiebelJMSProducer 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. ...ProcessSalesOrderSiebelJMSProducerProcessSalesOrderSiebelJMSProducer.xml Product Configurator Web Service NOTE: This version of Siebel Product Configurator Web Service is available only for implementations of Siebel CRM version 8.1 and later. To use the Siebel Configurator Web service with Siebel CRM version 8.0, see version 8.0 of Siebel CRM Web Services Reference. The Web service enables queries on information contained within the product model, such as relationships, attributes, linked items, resources, UI groups. The service also allows you to configure a product and perform multiple batch requests. Product Configurator Web Service Operations For a list of operations associated with this Web service, see Table 829. Table 829. Configurator Web service operations Name Description GetCfgObjectStructure Retrieves product relationships, attributes, linked items and Siebel CRM Web Services Reference Version 8.1/8.2 328 resources. GetCfgObjectGroupItems Retrieves the Product UI definition, UI group and group items. GetCfgObjectDefaultGroup Items Retrieves Default Product Group Items (group items will be based on all relationships, attributes, linked items and resources). BeginConfiguration Enables customization of products stored in the Siebel database. Initializes the configurator session with a quote instance and product model.
- 329. Siebel CRM Primary Web Services ■ Product Configurator Web Service Table 829. Configurator Web service operations Name Description UpdateConfiguration Executes operations on the quote instance initialized in BeginConfiguration. EndConfiguration Release server resources used during the Begin or Update Configuration operation. Request Message Description: GetCfgObjectStructure GetCfgObjectStructure has the same request and response message. GetCfgObjectGroupItems has the same request and response message. GetCfgObjectDefaultGroupItems request and response message is the same as GetCfgObjectGroupItems. The Object’s direct child properties are ignored as well those of UIOption, Responsibilities, and Group. Only the GroupItem child is looked at and returned (others are copied to the Response message). GroupItem behavior is similar to that of GetCfgObjectGroupItems. For a description of this request message, see Table 830. Table 830. Request Message: GetCfgObjectStructure Node Description WebChannelObjStructure Required. This structure identified the objects that will be queries as well the data that will be returned about the objects. Object Required. One or more must be specified. Name Required. Name of an object (product or class). Either Name or Id is required. Id Required. Id of an object (product or class). Either Name or Id is required. ObjectType Required. Either Product or Class. ParentClassId Class Id of the parent. DisplayName Display name. Description Description. Attribute Zero or more (only those child objects that are specified will be queried for). Name Name of attribute. If empty, then all attributes are returned. LocalType Local type. InternalType Internal type. OrigId Internal Id. DisplayName Display name. Hidden Hidden flag. Siebel CRM Web Services Reference Version 8.1/8.2 329
- 330. Siebel CRM Primary Web Services ■ Product Configurator Web Service Table 830. Request Message: GetCfgObjectStructure Node Description Required Required flag. ReadOnly Read Only flag. ValidationSpec Validation specification. UnitOfMeasure Unit of measure. Description Description. AttributeDomain Zero or more. LocalValue Local value. InternalValue Internal value. AttributeDomainDecoration Zero or more. Attribute domain specific properties name value Siebel CRM Web Services Reference Version 8.1/8.2 330 pairs. Name Name of attribute. Value Value of attribute. AttributeDefaultValue Default value of the attribute. Only one of the value types will be populated depending on the type of the value. DisplayValue Display value. String String value. Number Number value. Integer Integer value. Date Date value. Boolean Boolean value. AttributeRejectedValue Rejected value of the attribute. Only one of the value types will be populated depending on the type of the value. DisplayValue Display value. String String value. Number Number value. Integer Integer value. Date Date value. Boolean Boolean value. AttributeDecoration Zero or more. Name Attribute properties name. Value Value pairs.
- 331. Siebel CRM Primary Web Services ■ Product Configurator Web Service Table 830. Request Message: GetCfgObjectStructure Node Description Relationship Zero or more (only those child objects that are specified will be queried for). Name Name of relationship. If Name and or Id is specified, then only that particular relationship will be returned. If both are empty, then all relationships are returned. Id Id of relationship. If Name and or Id is specified, then only that particular relationship will be returned. If both are empty, then all relationships will be returned. DisplayName Display name. ClassName Class name. ClassId Class Id. DefaultProductId Default product Id. DefaultCardinality Default cardinality. MinimumCardinality Minimum cardinality. MaximumCardinality Maximum cardinality. RelationshipDomain Zero or more. Name Name of product. If Name and or Id is specified, then only that particular relationship domain will be returned. If both are empty, then all relationship domain products will be returned. Id Id of product. If Name and or Id is specified, then only that particular relationship domain will be returned. If both are empty, then all relationship domain products will be returned. DisplayName Display Name. OrigId Originating Id. Description Description. RelationshipDomainDecoration Zero or more. Name Relationship domain specific properties name. Value Value pairs. RelationshipDecoration Zero or more. Name Relationship properties name Value Value pairs. LinkedItem Zero or more (only those child objects that are specified will be queried for). Name Name of linked item. Siebel CRM Web Services Reference Version 8.1/8.2 331
- 332. Siebel CRM Primary Web Services ■ Product Configurator Web Service Table 830. Request Message: GetCfgObjectStructure Node Description Id Id of linked item. If Name and or Id is specified, then only that Siebel CRM Web Services Reference Version 8.1/8.2 332 particular linked item will be returned. If both are empty, then all linked items will be returned. DisplayName Display name. VariableName Variable Name. SortSpec Sort specification. SearchSpec Search specification. NeedsExecution The Needs Execution flag used for business component-based queries. Expression Expression. DefaultValue Default value. BusinessObject Business object for business component based query. BusinessComponent Business component for business component based query. FieldName Field name in the business component. Active Active flag. LinkedItemDecoration Linked Item properties. Name Name value. Value Pairs. Resource Zero or more (only those child objects that are specified will be queried for). Name Name of resource. If Name and or Id is specified, then only that particular resource will be returned. If both are empty, then all resources are returned. Id Id of resource. If Name and or Id is specified, then only that particular resource will be returned. If both are empty, then all resources are returned. DisplayName Display name. ResourceDecoration Resource properties. Name Name value. Value Pairs. ObjectDecoration Object properties. Name Name value. Value Pairs.
- 333. Siebel CRM Primary Web Services ■ Product Configurator Web Service Request Message Description: GetCfgObjectGroupItems, GetCfgObjectDefaultGroupItems For a description of this request message, see Table 831. Table 831. Request Message: GetCfgObjectGroupItems, GetCfgObjectDefaultGroupItems Node Description WebChannelObjGroupItems Required. This structure identified the objects that will be queries as well the data that will be returned about the objects. Object Required. One or more must be specified. Name Required. Name of Object (product or class). Either Name or Id is required. Id Required. Id of Object (product or class). Either Name or Id is required. ObjectType Required. Either Product or Class. ParentClassId Class Id of the parent. DisplayName Display name. Description Description. UIOption Zero or more. Name Name of UI option. If Name and or Id is specified, then only that particular UI option will be returned. If both are empty, then all UI options will be returned. Id Id of UI option. If Name and or Id is specified, then only that particular UI option will be returned. If both are empty, then all UI options will be returned. Type Type. DisplayName Display name. Sequence Sequence. BaseTheme Base theme. ProductTheme Product theme. Responsibility Zero or more. Name Name of responsibility. If Name and or Id is specified, then only that particular responsibility will be returned. If both are empty, then all responsibilities will be returned. Id Id of responsibility. If Name and or Id is specified, then only that particular responsibility will be returned. If both are empty, then all responsibilities will be returned. Group Zero or more. Siebel CRM Web Services Reference Version 8.1/8.2 333
- 334. Siebel CRM Primary Web Services ■ Product Configurator Web Service Table 831. Request Message: GetCfgObjectGroupItems, GetCfgObjectDefaultGroupItems Node Description Name Name of group. If Name and or Id is specified, then only that Siebel CRM Web Services Reference Version 8.1/8.2 334 particular group will be returned. If both are empty, then all groups will be returned. Id Id of Group. If Name value and or Id value is specified, then only that particular group will be returned. If both are empty, then all groups will be returned. DisplayName Display name. Sequence Sequence. GroupTheme Group theme. Description Description. GroupItem Zero or more. Id Id of Group Item. If Id and or Type is specified, then only that particular group item will be returned. If both are empty, then all group items will be returned. Type Type of Group Item (Relationship, Attribute, LinkedItem, or Resource). If Id and or Type is specified, then only that particular group item will be returned. If both are empty, then all group items will be returned. Sequence Sequence. GroupItemTheme Group item theme. Attribute An attribute child object of GetCfgObjectStructure request message. Relationship A relationship child object of GetCfgObjectStructure request message. LinkedItem A LinkedItem child object of GetCfgObjectStructure request message. Resource Refer to Resource child object of GetCfgObjectStructure request message. GroupDecoration Group properties. Name Name value. Value Pairs. Object Decoration Object properties name value pairs.
- 335. Siebel CRM Primary Web Services ■ Product Configurator Web Service Request Message Description: BeginConfiguration For a description of this request message, see Table 832. Table 832. Request Message: BeginConfiguration Node Description BeginConfiguration_Input Required. InitInstanceOperation Required. The operation type for BeginConfiguration session. LOAD. This will load the hierarchy object from the db. HeaderId and RootId are required. IntegrationObjectName is needed to determine which table to query and what the structure of the hierarchy is. DEFAULT. This will load the hierarchy object from the db and create new line item for a product with its default instance. HeaderId and ProductId are required. IntegrationObjectName is needed to determine which table to query and what the structure of the hierarchy is. SET. This will load the hierarchy object from the ListOfQuote parameter (PDS Quote integration object). RootId is required to determine the root line item to use in this session. ADD. This will add a new line item to the hierarchy object from the ListOfQuote parameter (PDS Quote integration object). ProductId is required. HeaderId Required for InitInstanceOperation of LOAD / DEFAULT. Row Id of the Header. RootId Required for InitInstanceOperation of LOAD / SET. Row Id for the root line item. ProductId Required for InitInstanceOperation of DEFAULT / ADD. Product Id for the root line item. ListOfQuote Required for InitInstanceOperation of SET / ADD. Hierarchy object in PDS Quote integration object format. ListOfData List of products, attributes, or relationships on which user requires domain information (with exclusions) in CfgInteractData integration object format. ProductData Product type. Item Item name. IntegrationId Integration Id of the line item. If IntegrationId specified, then only this line item and its sub line items are looked at. ProductId is optional. If ProductId is also specified, then it should match IntegrationId. If IntegrationId and ProductId are not specified, then the root line item is looked at. Siebel CRM Web Services Reference Version 8.1/8.2 335
- 336. Siebel CRM Primary Web Services ■ Product Configurator Web Service Table 832. Request Message: BeginConfiguration Node Description ProductId Product Id of the line item. If IntegrationId specified, then only this Siebel CRM Web Services Reference Version 8.1/8.2 336 line item and its sub line items are looked at. ProductId is optional. If ProductId is also specified, then that value should match the IntegrationId. If IntegrationId and ProductId are not specified, then the root line item is considered. Name Name of the product. Quantity Quantity. RelationshipName Relationship name. For sub line items, RelationshipName can be specified to limit the search to a particular relationship. RootIntegrationId Integration Id of the root line item. PortId Relationship ID. ParentProductId Parent Product ID. ParentIntegrationId Parent Integration ID. CanDrilldown Can drilldown flag. Used to indicate whether the line item is a customizable product. ListPrice List price. NRCCxTotal Non-recurring total price - only set on the root line item. MRCCxTotal Recurring total price - only set on the root line item. CurrentPrice Current price of the item after all the discounts have been factored in. ExchangeDate Exchange date of the pricing field values. CurrencyCode Currency code of the pricing field values. HasGenericsFlag Has Generics flag. Used to indicate whether the line item is incomplete. EligibilityStatus Eligibility status. EligibilityReason Eligibility reason. Explanation Explanation, if required. ExplanationText Text of explanation. Relationship Zero or more. List of relationships on which information is required. Name Name of relationship to query for. If empty, then all relationships are returned. Id Id. Always returned whether specified in the request or not.
- 337. Siebel CRM Primary Web Services ■ Product Configurator Web Service Table 832. Request Message: BeginConfiguration Node Description Request Type Indicates the type of the information that will be calculated for this relationship. Possible values include: ■ SelectionInfo - Only current line items for this relationship will be outputted. ■ DomainInfo - Only the possible domain items for this relationship will be outputted. ■ Any other values results in both of the above information being calculated and outputted. DomainItem Zero or more. Domain items of the relationship. Always returned whether specified in Request or not. Name Name of domain item. Id Id of domain item. ListPrice List price. ExchangeDate Exchange date of the pricing field values. CurrencyCode Currency code of the pricing field values. PriceType Indicated the type of list price: One-time or Recurring. CanDrilldown Can Drilldown flag. Used to indicate whether the line item is a customizable product. Excluded Excluded flag indicates the whether this domain item is excluded by a Constraint, Eligibility & Compatibility rule, or Promotion. Attribute Zero or more. List of attributes on which information is required. Name Name of attribute to query for. If empty, then all attributes are returned. ValueType Type of attribute. Always returned whether specified in the request or not. AttributeValue Zero or more. List of attribute values. Always returned whether specified in the request or not. DisplayValue Display value. StringValue Value displayed in a string. IntegerValue Value displayed as integer. NumberValue Value displayed as number. BooleanValue Value displayed in Boolean format. DateTimeValue Date and time value. Selected Selected flag indicates whether this value is selected. Siebel CRM Web Services Reference Version 8.1/8.2 337
- 338. Siebel CRM Primary Web Services ■ Product Configurator Web Service Table 832. Request Message: BeginConfiguration Node Description Excluded Excluded flag indicates whether this value is excluded by a Response Message Description: Begin Configuration GetCfgObjectStructure has the same request and response message. For more information, see Table 832. GetCfgObjectGroupItems and GetCfgObjectDefaultGroupItems have the same request and response messages. See the response message description for Begin Configuration for details. For a description of this response message, see Table 833. Siebel CRM Web Services Reference Version 8.1/8.2 338 Constraint, Eligibility & Compatibility rule or Promotion. Item Zero or more. Same recursive structure as that defined above. ListOfLinkedItems Linked Items. LinkedItems Linked Items. LinkedItemValue One or more. Name Name of linked item. ValueType Type of value. StatusText Details on the error if any. ConflictResolution Values are Proceed or Undo. This indicates whether a Procced or Undo was done on the conflicts and also whether there were any other violations that resulted in an Undo (like Promotion or Cardinality). Messages Zero or one. List of messages. MessageType Zero or more. MessageSource Source of the messages (Eligibility, Promotion, Cardinality, Proceed Actions and so on). Message Message text. Table 833. Response Message Description: Begin Configuration Node Description BeginConfiguration_Output Required. Error_spcCode Error code if error occurred. Error_spcMessage Error message if error occurred. RootId New item root Id. RootIntegrationId New item root Integration Id. ListOfQuote Quote instance if ReturnFullInstance input parameter was set to Y. See BeginConfiguration Request Message for details.
- 339. Siebel CRM Primary Web Services ■ Product Configurator Web Service Table 833. Response Message Description: Begin Configuration Node Description ListOfData The domain information about products, attributes, and relationships as well current selections for the attributes, or relationships that was requested in the request message. ListOfStatus This indicates whether the request was successful or not and contains messages to be displayed. Status Required StatusCode Success, Warning, or Error. If the StatusCode is Success, then the operation was successful. If the StatusCode is Warning, then there were conflicts, messages are present in ListOfMessage, that were automatically resolved. If the StatusCode is Error, then there were conflicts, messages are present in ListOfMessage, that could not be resolved, and further requests to this session will not be honored. Request Message Description: UpdateConfiguration For a description of this request message, see Table 834. Table 834. Request Message Description: UpdateConfiguration Node Description UpdateConfiguration_Input Required. ConflictAutoResolve Proceed or Undo. If set to Proceed, then all conflicts are auto resolved. If set to Undo, then any conflict will result in an Undo of the entire batch. FinishInstanceInFlag If set Y, then FinishIt is called. SaveInstanceInFlag If set Y, then the instance is saved to the database. RepriceInstanceInFlag If set Y, then a reprice is called. VerifyInstanceInFlag If set Y, then verify the instance is called. ListOfData Same as ListOfData in BeginConfiguration Request Message. ListOfRequest List of Requests that will be executed on the product instance. Requests Requests. Request Zero or more. Type Type of request (AddItem, RemoveItem, SetItemQuantitty, SetAttribute, ReplaceItem). Item Zero or more requests. AddProductId Add product Id for AddItem, ReplaceItem. Quantity Quantity. Siebel CRM Web Services Reference Version 8.1/8.2 339
- 340. Siebel CRM Primary Web Services ■ Product Configurator Web Service Table 834. Request Message Description: UpdateConfiguration Node Description RelationshipId Relationship Id which contains the new product for AddItem, Response Message Description: UpdateConfiguration For a description of this response message, see Table 835. Siebel CRM Web Services Reference Version 8.1/8.2 340 ReplaceItem. IntegrationId Integration Id on which the operation will be performed. Attribute Zero or more SetAttribute request details. Name Name or attribute. ValueType Type of value. AttributeValue Zero or more. DisplayValue New display value of attribute String Value displayed in a string. Number Value displayed as number. Integer Value displayed as integer. Date Date. Boolean Value displayed in Boolean format. Table 835. Response Message Description: UpdateConfiguration Node Description UpdateConfiguration_Output Required. Error_spcCode Error Code if error occurred. Error_spcMessage Error Message if error occurred. FinishConfigurationOutFlag Y or N. Indicates whether Finish Configuration was performed. It might not be performed if there were some errors. RepriceOutFlag Y or N. Indicates whether Reprice was done. It might not be performed if there were errors. SaveInstanceOutFlag Y or N. Indicates whether Save Instance was done. It might not be performed if there were conflicts. VerifyOutFlag Y or N. Indicates whether Verify was done. It might not be performed if there were errors. ListOfData The domain information about products, attributes, and relationships as well current selections for the attributes, or relationships that was requested in the request message. ListOfStatus This indicates whether the request was successful or not and contains messages to be displayed.
- 341. Siebel CRM Primary Web Services ■ Product Configurator Web Service Request Message Description: EndConfiguration For a description of this request message, see Table 836. Table 836. Request Message Description: EndConfiguration Node Description EndConfiguration_Input Required. SaveInstanceFlag Save instance flag. Response Message Description: EndConfiguration For a description of this response message, see Table 837. Table 837. Response Message Description: EndConfiguration Node Description EndConfiguration_Output Required. Error_spcCode Error Code if error occurred. Error_spcMessage Error Message if error occurred. ListOfQuote Quote instance. Product Configurator Web Service 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 838. Table 838. Product Configurator Service Objects Name Boundary Object Type Class (if BusService) Cfg Object Broker Business Service CSSCfgObjBrokerService ConfiguratorWebChannelBeginConfig Workflow Not applicable ConfiguratorWebChannelUpdateConfig Workflow Not applicable ConfiguratorWebChannelEndConfig Workflow Not applicable Siebel CRM Web Services Reference Version 8.1/8.2 341
- 342. Siebel CRM Primary Web Services ■ Product Configurator Web Service Data Object (Integration Object) For a description of data objects for this Web service, see Table 839. Table 839. Product Configurator Data Objects Siebel Repository Name External Name CfgInteractData ListOfData CfgInteractRequest ListOfRequest CfgInteractStatus ListOfStatus CfgLinkedItems ListOfLinkedItems PDS Quote ListOfQuote Methods For a description of the methods for this Web service, see Table 840. Table 840. Product Configurator Methods Operation Method GetCfgObjectStructure GetObjStructure GetCfgObjectGroupItems GetObjGroupItems GetCfgObjectDefaultGroupItems GetObjDefaultGroupItems Example Package for Product Configurator To view an example of messages 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. Request (GetObjDefaultGroupItems) See the following file to view the sample code: ...ProductConfiguratorGetObjDefaultGroupItems_request.xml Response (GetObjDefaultGroupItems) See the following file to view the sample code: ...ProductConfiguratorGetObjDefaultGroupItems_response.xml Request (GetObjGroupItems) See the following file to view the sample code: ...ProductConfiguratorGetObjGroupItems_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 342
- 343. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Response (GetObjGroupItems) See the following file to view the sample code: ...ProductConfiguratorGetObjGroupItems_response.xml Request (GetObjStructure) See the following file to view the sample code: ...ProductConfiguratorGetObjStructure_request.xml Response (GetObjStructure) See the following file to view the sample code: ...ProductConfiguratorGetObjStructure_response.xml Interface Description (WSDL) for Product Configurator 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. ...ProductConfiguratorProductConfigurator.wsdl Product Configurator Web Service for Orders This Web service enables queries on information contained within the product model, such as relationships, attributes, linked items, resources, and UI groups. The service also enables you to configure a product and perform multiple batch requests in the context of a sales order. NOTE: This version of Product Configurator Web Service for Orders is available only for Siebel CRM version 8.1.1.10 and later. To use Product Configurator Web Service for Quotes with Siebel CRM version 8.0, see version 8.0 of Siebel CRM Web Services Reference. Product Configurator Web Service for Orders Operations Table 841 provides a list of the operations associated with this Web service. . Table 841. Product Configurator Web Service for Orders operations Name Description GetObjStructureOrder Retrieves the product relationships, attributes, linked items and resources. GetObjGroupItemsOrder Retrieves the product UI definition, UI group, and group items. Siebel CRM Web Services Reference Version 8.1/8.2 343
- 344. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Table 841. Product Configurator Web Service for Orders operations Name Description GetObjDefaultGroupItems Order Request Message Description: GetObjStructureOrder GetObjStructureOrder and GetObjGroupItemsOrder have the same request and response message. GetObjDefaultGroupItemsOrder request and response message is the same as GetObjGroupItemsOrder. The Object’s direct child properties are ignored as well those of UIOption, Responsibilities, and Group. Only the GroupItem child is looked at and returned (others are copied to the Response message). GroupItem behavior is similar to that of GetObjGroupItemsOrder. Table 842 provides a description of the request message GetObjStructureOrder. Siebel CRM Web Services Reference Version 8.1/8.2 344 Retrieves the default product group items. Group items are based on all relationships, attributes, linked items and resources. BeginConfigurationOrder Enables customization of products stored in the Siebel database. Initializes the configurator session with an order instance and product model. UpdateConfigurationOrder Executes operations on the order instance initialized in BeginConfigurationOrder. EndConfigurationOrder Releases server resources used during the configuration of the product. Table 842. Request Message: GetObjStructureOrder Node Description WebChannelObjStructure Required.This structure specifies the objects that are queried and the data that is returned about the objects. Object Required. Specify one or more objects. Name The name of the object (product or class). Either Name or Id is required. Id The Id of an object (product or class). Either Name or Id is required. ObjectType Required. The object type, either Product or Class. ParentClassId The class Id of the parent object. DisplayName The display name. Description The description. Attribute Zero or more child objects to be queried for. Name The name of the attribute. If this value is empty, then all attributes are returned. LocalType The local type.
- 345. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Table 842. Request Message: GetObjStructureOrder Node Description InternalType The internal type. OrigId The internal Id. DisplayName The display name. Hidden The hidden flag. Required Required flag. ReadOnly Read-only flag. ValidationSpec The validation specification. UnitOfMeasure The unit of measure. Description The description. AttributeDomain Zero or more. LocalValue The local value. InternalValue The internal value. AttributeDomainDecoration Zero or more name value pairs of attribute-domain-specific properties. Name The name of the attribute. Value The value of the attribute. AttributeDefaultValue The default value of the attribute. Only one of the value types is populated depending on the type of the value. DisplayValue The display value. String A string value. Number A number value. Integer An integer value. Date A date value. Boolean A Boolean value. AttributeRejectedValue A rejected value of the attribute. Only one of the value types is populated depending on the type of the value. DisplayValue The display value. String A string value. Number A number value. Integer An integer value. Date A date value. Boolean A Boolean value. Siebel CRM Web Services Reference Version 8.1/8.2 345
- 346. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Table 842. Request Message: GetObjStructureOrder Node Description AttributeDecoration Zero or more. Name The attribute properties name. Value Value pairs. Relationship Zero or more relationships. Only those child objects that are Siebel CRM Web Services Reference Version 8.1/8.2 346 specified are queried for. Name The name of the relationship. If Name or Id is specified, then only that particular relationship is returned. If both are empty, then all relationships are returned. Id The Id of the relationship. If Name or Id is specified, then only that particular relationship is returned. If both are empty, then all relationships are returned. DisplayName The display name. ClassName The class name. ClassId The class Id. DefaultProductId The default product Id. DefaultCardinality The default cardinality. MinimumCardinality The minimum cardinality. MaximumCardinality The maximum cardinality. RelationshipDomain Zero or more. Name The name of the product. If Name or Id is specified, then only that particular relationship domain will be returned. If both are empty, then all relationship domain products will be returned. Id The Id of the product. If Name or Id is specified, then only that particular relationship domain are returned. If both are empty, then all relationship domain products are returned. DisplayName The display name. OrigId The originating Id. Description The description of the product. RelationshipDomainDecoration Zero or more. Name The name of the specific properties of the relationship domain. Value Value pairs. RelationshipDecoration Zero or more. Name The relationship properties name. Value Value pairs.
- 347. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Table 842. Request Message: GetObjStructureOrder Node Description LinkedItem Zero or more linked items. Only those child objects that are specified are queried for. Name The name of the linked item. Id The Id of the linked item. If Name or Id is specified, then only that particular linked item is returned. If both are empty, then all linked items are returned. DisplayName The display name. VariableName The variable name. SortSpec The sort specification. SearchSpec The search specification. NeedsExecution The needs-execution flag, used for business-component-based queries. Expression The expression. DefaultValue The default value. BusinessObject The business object, used for business-component-based queries. BusinessComponent The business component, used for business-component-based queries. FieldName The field name in the business component. Active The active flag. LinkedItemDecoration The linked item properties. Name The name value. Value Value pairs. Resource Zero or more resources. Only those child objects that are specified will be queried for. Name The name of the resource. If Name or Id is specified, then only that particular resource is returned. If both are empty, then all resources are returned. Id The Id of the resource. If Name or Id is specified, then only that particular resource is returned. If both are empty, then all resources are returned. DisplayName The display name. ResourceDecoration The resource properties. Name The name value. Siebel CRM Web Services Reference Version 8.1/8.2 347
- 348. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Table 842. Request Message: GetObjStructureOrder Node Description Value Value pairs. ObjectDecoration The object properties. Name The name value. Value Value pairs. Request Message Description: GetObjGroupItemsOrder, GetObjDefaultGroupItemsOrder Table 843 provides a description of the request messages GetObjGroupItemsOrder and GetObjDefaultGroupItemsOrder. Table 843. Request Message: GetObjGroupItemsOrder, GetObjDefaultGroupItemsOrder Node Description WebChannelObjGroupItems Required. This structure identifies the objects that will be queries Siebel CRM Web Services Reference Version 8.1/8.2 348 and the data that will be returned for the objects. Object Required. One or more must be specified. Name The name of the object (product or class). Either Name or Id is required. Id The Id of the object (product or class). Either Name or Id is required. ObjectType Required. The type of the object, either Product or Class. ParentClassId The class Id of the parent. DisplayName The display name. Description The description. UIOption Zero or more. Name The name of the UI option. If Name or Id is specified, then only that particular UI option will be returned. If both are empty, then all UI options will be returned. Id The Id of the UI option. If Name or Id is specified, then only that particular UI option will be returned. If both are empty, then all UI options will be returned. Type The type. DisplayName The display name. Sequence The sequence. BaseTheme The base theme. ProductTheme The product theme. Responsibility Zero or more.
- 349. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Table 843. Request Message: GetObjGroupItemsOrder, GetObjDefaultGroupItemsOrder Node Description Name The name of the responsibility. If Name or Id is specified, only that particular responsibility will be returned. If both are empty, then all responsibilities will be returned. Id The Id of the responsibility. If Name or Id is specified, only that particular responsibility will be returned. If both are empty, then all responsibilities will be returned. Group Zero or more. Name The name of the group. If Name or Id is specified, then only that particular group will be returned. If both are empty, then all groups will be returned. Id The Id of the group. If Name value or Id value is specified, then only that particular group will be returned. If both are empty, then all groups will be returned. DisplayName The display name. Sequence The sequence. GroupTheme The group theme. Description The description. GroupItem Zero or more. Id The Id of the group item. If Id or Type is specified, then only that particular group item will be returned. If both are empty, then all group items will be returned. Type The type of the group item (Relationship, Attribute, LinkedItem, or Resource). If Id or Type is specified, then only that particular group item will be returned. If both are empty, then all group items will be returned. Sequence The sequence. GroupItemTheme The theme of the group item. Attribute An attribute child object of GetObjStructureOrder request message. Relationship A relationship child object of GetObjStructureOrder request message. LinkedItem A LinkedItem child object of GetObjStructureOrder request message. Resource Refer to the Resource child object of GetObjStructureOrder request message. GroupDecoration The group properties. Name The name value. Siebel CRM Web Services Reference Version 8.1/8.2 349
- 350. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Table 843. Request Message: GetObjGroupItemsOrder, GetObjDefaultGroupItemsOrder Node Description Value Pairs. Object Decoration The object properties of the name value pairs. Request Message Description: BeginConfigurationOrder Table 844 provides a description of the request message, BeginConfigurationOrder. Table 844. Request Message: BeginConfigurationOrder Node Description BeginConfigurationOrder_Input Required. InitInstanceOperation Required. The operation type for the BeginConfigurationOrder Siebel CRM Web Services Reference Version 8.1/8.2 350 session. There are the following options: ■ Load. Loads the hierarchy object from the database. HeaderId and RootId are required. IntegrationObjectName is required to determine which table to query and what the structure of the hierarchy is. ■ Default. Load the hierarchy object from the database and creates a new line item for a product with its default instance. HeaderId and ProductId are required. IntegrationObjectName is required to determine which table to query and what the structure of the hierarchy is. ■ Set. Loads the hierarchy object from the ListOfOrder parameter (PDS Order integration object). RootId is required to determine the root line item to use in this session. ■ Add. Adds a new line item to the hierarchy object from the ListOfOrder parameter (PDS Order integration object). ProductId is required. HeaderId Required for InitInstanceOperation of LOAD or DEFAULT. The row Id of the header. RootId Required for InitInstanceOperation of LOAD or SET. The row Id for the root line item. ProductId Required for InitInstanceOperation of DEFAULT or ADD. The product Id for the root line item. ListOfOrder Required for InitInstanceOperation of SET or ADD. The hierarchy object in PDS Order integration object format. ListOfData The list of products, attributes, or relationships for which a user requires the domain information (with exclusions) in CfgInteractData integration object format.
- 351. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Table 844. Request Message: BeginConfigurationOrder Node Description ProductData The product type. Item The item name. IntegrationId The integration Id of the line item. If IntegrationId is specified, then only this line item and its subline items are considered. ProductId is optional. If ProductId is also specified, then it must match IntegrationId. If the IntegrationId and ProductId are not specified, then the root line item is considered. ProductId The product Id of the line item. If IntegrationId specified, then only this line item and its subline items are considered. ProductId is optional. If ProductId is also specified, then it must match IntegrationId. If IntegrationId and ProductId are not specified, then the root line item is considered. Name The name of the product. Quantity The quantity. RelationshipName The relationship name. For subline items, RelationshipName can be specified to limit the search to a particular relationship. RootIntegrationId The integration Id of the root line item. PortId The relationship Id. ParentProductId The parent product Id. ParentIntegrationId The parent Integration Id. CanDrilldown The can-drilldown flag. It indicates whether the line item is a customizable product. ListPrice The list price. NRCCxTotal The nonrecurring total price. Set this price only on the root line item. MRCCxTotal The recurring total price. Set this price only on the root line item. CurrentPrice The current price of the item after all the discounts have been applied. ExchangeDate The exchange date of the pricing field values. CurrencyCode The currency code of the pricing field values. HasGenericsFlag The has-generics flag. It indicates whether the line item is incomplete. EligibilityStatus The eligibility status. EligibilityReason The eligibility reason. Siebel CRM Web Services Reference Version 8.1/8.2 351
- 352. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Table 844. Request Message: BeginConfigurationOrder Node Description Explanation The explanation, if required. ExplanationText The text of the explanation. Relationship Zero or more. The list of relationships for which information is Siebel CRM Web Services Reference Version 8.1/8.2 352 required. Name The name of the relationship to query for. If the query is empty, then all relationships are returned. Id The Id. It is always returned whether specified in the request or not. Request Type Indicates the type of the information that is calculated for this relationship. The values include: ■ SelectionInfo. Only current line items for this relationship are generated. ■ DomainInfo. Only the possible domain items for this relationship are generated. ■ Any other value. Both of the previous values are generated. DomainItem Zero or more domain items of the relationship. Always returned whether specified in the request or not. Name The name of the domain item. Id The Id of the domain item. ListPrice The list price. ExchangeDate The exchange date of the pricing field values. CurrencyCode The currency code of the pricing field values. PriceType Indicates the type of list price: one-time or recurring. CanDrilldown The can-drill-down flag. It indicates whether the line item is a customizable product. Excluded The excluded flag. It indicates whether this domain item is excluded by a constraint, eligibility and compatibility rule, or a promotion. Attribute Zero or more attributes for which information is required. Name The name of attribute to query for. If the query is empty, then all attributes are returned. ValueType The type of the attribute. It is always returned whether specified in the request or not.
- 353. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Table 844. Request Message: BeginConfigurationOrder Node Description AttributeValue Zero or more attribute values. It is always returned whether specified in the request or not. DisplayValue The display value. StringValue The value displayed as a string. IntegerValue The value displayed as an integer. NumberValue The value displayed as a number. BooleanValue The value displayed as a Boolean value. DateTimeValue The date and time value. Selected The selected flag. It indicates whether this value is selected. Excluded The Excluded flag. It indicates whether this value is excluded by a constraint, eligibility and compatibility rule, or promotion. Item Zero or more items. Same recursive structure as defined above. ListOfLinkedItems The linked items. LinkedItems The linked items. LinkedItemValue One or more values of linked items. Name The name of the linked item. ValueType The type of value. StatusText The details of the error, if an error occurs. ConflictResolution Indicates whether a Proceed or Undo operation was performed on the conflicts and also whether any other violations occurred that resulted in an Undo operation. The values are: Proceed or Undo. Messages Zero or one message. MessageType Zero or more message types. MessageSource The source of the messages, which might be eligibility, promotion, cardinality, proceed actions, and so on. Message The message text. ReturnFullInstance Indicates whether the Order instance is returned in the ListOfOrder parameter of the response message. The values are: Y (default) and N. Siebel CRM Web Services Reference Version 8.1/8.2 353
- 354. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Response Message Description: BeginConfigurationOrder GetObjGroupItemsOrder and GetObjDefaultGroupItemsOrder have the same request and response messages. See the response message description for BeginConfigurationOrder for details. Table 845 includes a description of this response message BeginConfigurationOrder. Table 845. Response Message Description: BeginConfigurationOrder Node Description BeginConfigurationOrder_Output Required. Error_spcCode Displays an error code if an error occurs. Error_spcMessage Displays an error message if an error occurs. RootId The new item’s root Id. RootIntegrationId The new item’s root integration Id. ListOfOrder Indicates the order instance, if the ReturnFullInstance input Siebel CRM Web Services Reference Version 8.1/8.2 354 parameter was set to Y. See BeginConfigurationOrder Request Message for details. ListOfData The domain information about products, attributes, or relationships and the current selections for the attributes, or relationships that was requested in the request message. See the Request Message for more details. ListOfStatus Indicates whether the request was successful or not and contains messages to be displayed. Status Required. StatusCode The values are: ■ Success. The operation was successful. ■ Warning. Some conflicts occurred that were automatically resolved. The messages are present in ListOfMessages. ■ Error. Some conflicts could not be resolved. Any further requests to this session will not be responded to. Messages are present in ListOfMessages.
- 355. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Request Message Description: UpdateConfigurationOrder Table 846 includes a description of this request message UpdateConfigurationOrder. Table 846. Request Message Description: UpdateConfigurationOrder Node Description UpdateConfigurationOrder_Input Required. ConflictAutoResolve The values are: ■ Proceed. All conflicts are resolved automatically. ■ Undo. Any conflict will undo the entire batch job. FinishInstanceInFlag If this flag is set to Y, then FinishIt is called. SaveInstanceInFlag If this flag is set to Y, then the instance is saved to the database. RepriceInstanceInFlag If this flag is set to Y, then reprice is called. VerifyInstanceInFlag If this flag is set to Y, then the verify instance is called. ListOfData Same as ListOfData in BeginConfigurationOrder Request Message. ListOfRequest The list of requests that are executed on the product instance. Requests The requests. Request Zero or more. Type The type of request. The values are: AddItem, RemoveItem, SetItemQuantitty, SetAttribute, and ReplaceItem. Item Zero or more requests. AddProductId The add product Id for AddItem or ReplaceItem. Quantity The quantity. RelationshipId The relationship Id that contains the new product for AddItem or ReplaceItem. IntegrationId The integration Id on which the operation is performed. Attribute Zero or more SetAttribute request details. Name The name of the attribute. ValueType The type of value. AttributeValue Zero or more. DisplayValue The new display value of the attribute String The value displayed as a string. Number The value displayed as a number. Integer The value displayed as an integer. Siebel CRM Web Services Reference Version 8.1/8.2 355
- 356. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Table 846. Request Message Description: UpdateConfigurationOrder Node Description Date The value displayed as a date. Boolean The value displayed as a Boolean value. Response Message Description: UpdateConfigurationOrder Table 847 includes a description of this request message UpdateConfigurationOrder. Table 847. Response Message Description: UpdateConfigurationOrder Node Description UpdateConfigurationOrder_Output Required. Error_spcCode Displays an error code if an error occurs. Error_spcMessage Displays an error message if an error occurs. FinishConfigurationOutFlag Y or N. Indicates whether Finish Configuration was done. It Request Message Description: EndConfigurationOrder Table 848 includes a description of this request message EndConfigurationOrder. Siebel CRM Web Services Reference Version 8.1/8.2 356 might not be performed if errors occur. RepriceOutFlag Y or N. Indicates whether a Reprice operation was done. It might not be performed if errors occur. SaveInstanceOutFlag Y or N. Indicates whether the Save Instance was done. It might not be performed if conflicts occur. VerifyOutFlag Y or N. Indicates whether Verify was done. It might not be performed if there were errors. ListOfData The domain information about products, attributes, or relationships as well as current selections for the attributes, or relationships requested in the request message. ListOfStatus Indicates whether the request was successful or not, and contains messages to be displayed. Table 848. Request Message Description: EndConfigurationOrder Node Description EndConfigurationOrder_Input Required. SaveInstanceFlag The save-instance flag.
- 357. Siebel CRM Primary Web Services ■ Product Configurator Web Service for Orders Response Message Description: EndConfigurationOrder Table 849 includes a description of this request message EndConfigurationOrder. Table 849. Response Message Description: EndConfigurationOrder Node Description EndConfigurationOrder_Output Required. Error_spcCode Displays an error code if an error occurs. Error_spcMessage Displays an error message if an error occurs. ListOfOrder The order instance. Product Configurator Web Service for Orders 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) Table 850 includes a description of the service objects for the Product Configurator Web Service for Orders. Table 850. Product Configurator Service Objects Data Objects (Integration Object) Table 851 includes a description of the date objects for the Product Configurator Web Service for Orders. Siebel CRM Web Services Reference Version 8.1/8.2 357 Name Boundary Object Type Class (if BusService) Cfg Object Broker Business Service CSSCfgObjBrokerService ConfiguratorWebChannelBeginConfigOrder Workflow Not applicable ConfiguratorWebChannelUpdateConfig Workflow Not applicable ConfiguratorWebChannelEndConfigOrder Workflow Not applicable Table 851. Product Configurator Data Objects Siebel Repository Name External Name CfgInteractData ListOfData CfgInteractRequest ListOfRequest CfgInteractStatus ListOfStatus CfgLinkedItems ListOfLinkedItems PDS Order ListOfOrder
- 358. Siebel CRM Primary Web Services ■ Product Import Methods Table 852 includes a description of the methods for the Product Configurator Web Service for Orders. Table 852. Product Configurator Methods Operation Method GetObjStructureOrder GetObjStructure GetObjGroupItemsOrder GetObjGroupItems GetObjDefaultGroupItemsOrder GetObjDefaultGroupItems Example Package for Product Configurator Web Service for Orders To view an example of messages 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. Request See the following file to view the sample code: ...ProductConfiguratorforOrders Response See the following file to view the sample code: ...ProductConfiguratorforOrders Interface Description (WSDL) for ProductConfigurator Web Service for Orders 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. ...ProductConfiguratorforOrders Product Import Use this Web service to add and update product definitions and product structures in the Siebel CRM application. In this Web service, upsert denotes a combination of the insert and update operations. The response message returns only an acknowledgement message and not data. Siebel CRM Web Services Reference Version 8.1/8.2 358
- 359. Siebel CRM Primary Web Services ■ Product Import Product Import Operations For a list of operations associated with this Web service, see Table 853. Table 853. Product Import Operations Operation Name Description Product Import Insert This operation: ■ Inserts the root product definition. Generates an error if the product definition exists. ■ Upserts the related products in the product structure. Performs the insert operation if the child product structure does not exist. Performs the update operation if the child product structure exists. ■ Upserts the workspace project. Product Import Update This operation: ■ Updates the root product definition and the related products in the product structure. Generates an error if the product definition or the child product structure does not exist. ■ Upserts the workspace project. Product Import Upsert This operation: ■ Upserts the root product definition and the related products in the product structure. Performs the insert operation if the product definition or the child product structure does not exist. Performs the update operation if the product definition or the child product structure exists. ■ Upserts the workspace project. Request Message Description: Product Import Insert For a description of this request message, see Table 854. Table 854. Request Message Description: Product Import Insert Node Description SiebelMessage The Siebel message for the integration object of CMU Product Integration. Request Message Description: Product Import Update For a description of this request message, see Table 855. Table 855. Request Message Description: Product Import Update Node Description SiebelMessage The Siebel message for the integration object of CMU Product Integration. Siebel CRM Web Services Reference Version 8.1/8.2 359
- 360. Siebel CRM Primary Web Services ■ Product Import Request Message Description: Product Import Upsert For a description of this request message, see Table 856. Table 856. Request Message Description: Product Import Upsert Node Description SiebelMessage The Siebel message for the integration object of CMU Product Integration. Application Interface for Product Import 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 857. Table 857. Product Import Service Object Name Boundary Object Type Class (If Business Service) Product Import Business Service CSSCMUProdWebSvc Siebel CRM Web Services Reference Version 8.1/8.2 360
- 361. Siebel CRM Primary Web Services ■ Product Import Business Service User Property For a description of the user properties for this Business Service, see Table 858. Table 858. Product Import Business Service User Property Name Value Comment Data Sync Service EAI Siebel Adapter EAI Adapter service that is invoked. Siebel CRM Web Services Reference Version 8.1/8.2 361 Data Sync Service: Attribute CMU Attribute Integration object name for data sync service. Currently not supported. Data Sync Service: Class CMU Product Class Integration object name for data sync service. Currently not supported. Data Sync Service: Product CMU Product Integration object name for data sync service. Data Sync Service: Workspace CMU Joint Workspace Integration object name for data sync service. Definition Business Component CMU Product Definition VBC See the first note after this table. Definition Business Object CMU Admin ISS Product Definition See the first note after this table. Detail Business Component CMU ISS Product Details BusComp See the first note after this table. Integration Field Map: Auto Explode Flag Product|CMU Internal Product VOD| Auto Explode Flag See the second note after this table. Integration Field Map: Billable Flag Product|CMU Internal Product VOD| Billable Flag See the second note after this table. Integration Field Map: Billing Service Type Product|CMU Internal Product VOD| Billing Service Type See the second note after this table. Integration Field Map: Billing Type Product|CMU Internal Product VOD| Billing Type See the second note after this table. Integration Field Map: Business Unit Id Product|CMU Internal Product VOD| Primary Organization ID See the second note after this table. Integration Field Map: Check Eligibility Flag Product|CMU Internal Product VOD| Pre Pick CD See the second note after this table. Integration Field Map: Description Product|CMU Internal Product VOD| Description See the second note after this table. Integration Field Map: Effective End Time Product|CMU Internal Product VOD| End Date See the second note after this table.
- 362. Siebel CRM Primary Web Services ■ Product Import Table 858. Product Import Business Service User Property Name Value Comment Integration Field Map: Effective Start Time Siebel CRM Web Services Reference Version 8.1/8.2 362 Product|CMU Internal Product VOD| Start Date See the second note after this table. Integration Field Map: Inclusive Eligibility Flag Product|CMU Internal Product VOD| Inclusive Eligibility Flag See the second note after this table. Integration Field Map: Orderable Flag Product|CMU Internal Product VOD| Orderable See the second note after this table. Integration Field Map: Price Type Product|CMU Internal Product VOD| Price Type See the second note after this table. Integration Field Map: Product Id Product|CMU Internal Product VOD| ID See the second note after this table. Integration Field Map: Product Name Product|CMU Internal Product VOD| Name See the second note after this table. Integration Field Map: Product Type Product|CMU Internal Product VOD| Product Type Code See the second note after this table. Integration Field Map: Sales Product Flag Product|CMU Internal Product VOD| Sales Product Flag See the second note after this table. Integration Field Map: Service Instance Flag Product|CMU Internal Product VOD| Service Instance See the second note after this table. Integration Field Map: Service Product Flag Product|CMU Internal Product VOD| Sales Service Flag See the second note after this table. Integration Field Map: Structure Type Product|CMU Internal Product VOD| Product Def Type Code See the second note after this table. Integration Field Map: Track As Asset Flag Product|CMU Internal Product VOD| Track As Asset Flag See the second note after this table. Integration Field Map: Type Product|CMU Internal Product VOD| Type See the second note after this table. Integration Field Map: Unit of Measure Product|CMU Internal Product VOD| Unit of Measure See the second note after this table. Integration Field Map: Vendor Id Product|CMU Internal Product VOD| Vendor ID See the second note after this table. Integration Object: External CMU Product Integration See the first note after this table. Integration Object: Product CMU Admin ISS Product Definition See the first note after this table. Integration Object: Product Structure CMU Admin ISS Product Structure See the first note after this table.
- 363. Siebel CRM Primary Web Services ■ Product Import Table 858. Product Import Business Service User Property Name Value Comment Siebel CRM Web Services Reference Version 8.1/8.2 363 Integration Object: Workspace CMU Admin ISS Joint Workspace Definition See the first note after this table. Preset Value: CMU Attribute VOD BusComp VOD Type:ISS_ATTR_DEF See the first note after this table. Preset Value: CMU Attribute Versions BusComp Version:1 See the first note after this table. Preset Value: CMU ISS Product Attribute BusComp Last Version:0 See the first note after this table. Preset Value: CMU ISS Product Details BusComp Last Version:0 See the first note after this table. Preset Value: CMU ISS Product Structure Admin BusComp Last Version:0 See the first note after this table. Preset Value: CMU ISS Product VOD BusComp VOD Type:ISS_PROD_DEF See the first note after this table. Preset Value: CMU ISS Product Versions BusComp Released Flag:N See the first note after this table. Preset Value: CMU Internal Product Organization Organization ID: See the first note after this table. Product Business Component CMU Internal Product VOD See the first note after this table. Required Integration Component 1 CMU Attribute Versions BusComp See the first note after this table. Required Integration Component 2 CMU ISS Product VOD BusComp See the first note after this table. Required Integration Component 3 CMU ISS Product Versions BusComp See the first note after this table. Required Integration Component 4 CMU ISS Product Details BusComp See the first note after this table. Required Integration Component 5 CMU Internal Product Organization See the first note after this table. Structure Business Component CMU Product Structure VBC See the first note after this table.
- 364. Siebel CRM Primary Web Services ■ Product Import Table 858. Product Import Business Service User Property Name Value Comment Structure Internal Business Component NOTE: You must change the value of the operation if you use an integration object, integration component, business object, or business component with a different name. NOTE: The value of this operation is the field map. The first part is the data type (for example, product, class, and attribute). The second part is the integration component name. The third part is the integration component field name. Data Object (Integration Object) For a description of data objects for this Web service, see Table 859. Siebel CRM Web Services Reference Version 8.1/8.2 364 CMU ISS Product Structure Admin BusComp See the first note after this table. Version Business Component CMU ISS Product Versions BusComp See the first note after this table. Workspace Business Component CMU ISS Joint Workspace BusComp See the first note after this table. Workspace Business Object CMU Admin ISS Joint Workspace Definition See the first note after this table. Workspace Object Business Component CMU ISS Joint Workspace Object BusComp See the first note after this table. Workspace Project Business Component ISS Joint Workspace BusComp See the first note after this table. Workspace Project Business Object Admin ISS Joint Workspace Definition See the first note after this table. Workspace Project Item Business Component ISS Joint Workspace VOD Pick BusComp See the first note after this table. Workspace Project Lock Business Component ISS Joint Workspace VOD Lock BusComp See the first note after this table. Table 859. Product Import Data Object Siebel Repository Name External Name CMU Product Integration CMU Product Integration
- 365. Siebel CRM Primary Web Services ■ Product Offer Methods For a description of the methods for this Web service, see Table 860. Table 860. Product Import Methods Operation Method Product Import Insert [BS: Product Import].Insert Product Import Update [BS: Product Import]. Update Product Import Upsert [BS: Product Import]. Upsert Example Package for Product Import To view an example of messages 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. Request See the following file to view the sample code: ...ProductImportProductImport_request.xml Response See the following file to view the sample code: ...ProductImportProductImport_response.xml Interface Description for Product Import 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. ...ProductImportProduct Import.wsdl Product Offer Use this Web service to retrieve and apply product offer information. Siebel CRM Web Services Reference Version 8.1/8.2 365
- 366. Siebel CRM Primary Web Services ■ Product Offer Product Offer Operations For a list of operations associated with this Web service, see Table 861. Table 861. ProductOffer Operations Node Description GetProductOffer Retrieves a flat, nonhierarchical list of product offers. Siebel CRM Web Services Reference Version 8.1/8.2 366 This operation does not require any input data. Optional input is the offer ID, the offer name, or a search specification to retrieve a specific list of offers. Output of this operation returns product offer header information such as Offer Id, Offer Name and Offer Description. When an offer ID not provided in the input message, the output will list all the product offers defined in the application. GetProductOfferStructure Retrieves the detailed structure of a specific product offer. The input message requires the offer ID. The output message returns product offer definition data such as product offer responses, actions, workflow parameters, named parameters, recommendations, eligibility and compatibility rules, and messages. GetRecommendedOffers Retrieves the recommended product offers for a specific account. It also retrieves recommended offers for a specific asset, open quote, or open order. If the account ID is specified in the input message, then the output message will return all the recommended product offers for that account. If the Account ID, Document ID, and Mode are specified in the input message, then the output message will return the recommended offers for that specific asset or open order or open quote This operation only returns recommended product offers. It does not return recommend promotions as part of the response message. Also, this operation enforces response suppression, which means the same offer is not recommended for an account that has previously accepted the offer.
- 367. Siebel CRM Primary Web Services ■ Product Offer Table 861. ProductOffer Operations Node Description ApplyOfferToCreateOrder Applies a product offer to an account whose type is set to Residential. The input message requires the account ID and offer ID. If the offer requires modification to the customer's asset, then the asset ID is also required. The output message returns the complete order structure. The user has the option to retrieve just the order ID, or the order number without returning the full order structure. For offers that require user interaction, in other words, offers with named parameters, the input message must be configured with run-time values. Values include attribute value, field value, base product, component product, or upgrade product. ApplyOfferToCreateQuote Applies a product offer to an account of a type other than residential. The input message requires the account ID, and offer ID. The output message returns the complete quote structure. The user can retrieve just the quote ID or quote number without returning the full quote structure For offers that require user interaction, in other words, offers with named parameters, the input message must be configured with run-time values. Values include attribute value, field value, base product, component product, or upgrade product. Request Message Description: GetProductOffer For a description of this request message, see Table 862. Table 862. Request Message Description: GetProductOffer Node Description Type RAFProductOfferListIO Based on an integration object that is used for both the request and response messages. The user can pass the offer ID to query relevant offer details. Integration object Siebel CRM Web Services Reference Version 8.1/8.2 367
- 368. Siebel CRM Primary Web Services ■ Product Offer Response Message Description: GetProductOffer For a description of this response message, see Table 863. Table 863. Response Message Description: GetProductOffer Node Description Type RAFProductOfferListIO Based on an integration object that is used for Request Message Description: GetProductOfferStructure For a description of this request message, see Table 864. Response Message Description: GetProductOfferStructure For a description of this response message, see Table 865. Siebel CRM Web Services Reference Version 8.1/8.2 368 both the request and response message. Integration object Table 864. Request Message Description: GetProductOfferStructure Node Description Type RAFProductOfferStructureIO Identifies the objects that will be queried for the product offer ID or name. The input message required is offer ID or offer name Integration object Table 865. Response Message Description: GetProductOfferStructure Node Description Type RAFProductOfferStructureIO The output message has a hierarchy that contains details from the product offer header and all child details of the specified offer. Child objects include: ■ Product Offer E and C ■ Product Offer Recommendations ■ Product Offer Responses ■ Product Offer Actions ■ Product Offer Parameters ■ Product Offer Messages Integration object
- 369. Siebel CRM Primary Web Services ■ Product Offer Request Message Description: GetRecommendedOffers For a description of this request message, see Table 866. Table 866. Request Message Description: GetRecommendedOffers Node Description Type Account Id Required. The account ID of the offer that has been queried. DocId Optional. Values can be Asset ID, Open Order ID or Open Quote ID for the recommended offer that has been queried. Mode Value can be Asset, Order, or Quote. Mode is required when document ID is specified. Response Message Description: GetRecommendedOffers For a description of this response message, see Table 867. Table 867. Response Message Description: GetRecommendedOffers Node Description Type RAFProductOfferRecommend ationsIO The output message contains a list of all the product offers recommended for the Account, or the document details that were part of the request message. The response message contains a hierarchy message which contains details of the product offer. Request Message Description: ApplyOfferToCreateOrder For a description of this request message, see Table 868. String String String Integration object Table 868. Request Message Description: ApplyOfferToCreateOrder Node Description Type Offer Id Required. The offer ID that has to be applied. String Response Required. Values can include, Accept, Reject and so on. You must provide the language independent code String Account Id Required. The account on which the offer will be applied. String Document Id Asset ID or order ID on which the offer will be applied. String Mode The asset, or order. This supports the apply offer operations on an open order. String Siebel CRM Web Services Reference Version 8.1/8.2 369
- 370. Siebel CRM Primary Web Services ■ Product Offer Table 868. Request Message Description: ApplyOfferToCreateOrder Node Description Type SaveInstanceFlag Possible values are Y or N. If set to Y, then the Response Message Description: ApplyOfferToCreateOrder For a description of this response message, see Table 869. Request Message Description: ApplyOfferToCreateQuote For a description of this request message, see Table 870. Siebel CRM Web Services Reference Version 8.1/8.2 370 order is saved to the database. If set to N, then the order persists in memory. The default setting is Y. String ReturnFullInstanceFlag Possible values are Y or N. If set to Y, then the detailed order structure is returned in the response message. If set to N, then only the order is returned. The default setting is Y. String RAFActionListIO Action List is required when the product offer includes user input details. Run-time values that have user input information are provided in the request message. This includes the action details and parameters for that action. Integration object Table 869. Response Message Description: ApplyOfferToCreateOrder Node Description Type PDSOrder The order document structure that has been created. This field is populated when the ReturnFullInstanceFlag is set to Y. Integration object Order Id The order ID after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y. String Order Number The order number after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y. String Table 870. Request Message Description: ApplyOfferToCreateQuote Node Description Type Offer Id Required. The offer ID that has to be applied. String Response Required. Values can include, Accept, Reject and so on. You must provide the language independent code. String
- 371. Siebel CRM Primary Web Services ■ Product Offer Table 870. Request Message Description: ApplyOfferToCreateQuote Node Description Type Account Id Required. The account on which the offer will be applied. Document Id Asset ID or order ID on which the offer will be applied. Mode The asset, or order. This supports the Apply Offer operations on an open order. SaveInstanceFlag Possible values are Y or N. If set to Y, then the order is saved to the database. If set to N, then the order persists in memory. The default setting is Y. ReturnFullInstanceFlag Possible values are Y or N. If set to Y, then the detailed order structure is returned in the response message. If set to N, then only the order is returned. The default setting is Y. RAFActionListIO Action list is required when the product offer includes user input details. Run-time values that have user input information are provided in the request message. This includes the action details and parameters for that action. Response Message Description: ApplyOfferToCreateQuote For a description of this response message, see Table 871. String String String String String Integration object Table 871. Response Message Description: ApplyOfferToCreateQuote Node Description Type PDSQuote The quote document structure that has been created. This field is populated when the ReturnFullInstanceFlag is set to Y. Integration object Quote Id The quote ID after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y. String Quote Number The quote number after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y. String Siebel CRM Web Services Reference Version 8.1/8.2 371
- 372. Siebel CRM Primary Web Services ■ Product Offer Product Offer 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 872. Table 872. Product Offer Service Object Name Boundary Object Type Class GetProductOfferPort: RAF Product Offer Query Service Data Object (Integration Object) For a description of data objects for this Web service, see Table 873. Example Package for Product Offer To view an example of messages 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. Request (ApplyOfferToCreateOrder) See the following file to view the sample code: Siebel CRM Web Services Reference Version 8.1/8.2 372 Business Service CSSEAIDataSyncService GetProductOfferStructurePort: RAF Query Product Offer Structure Workflow Workflow Not applicable GetRecommendedOffersPort Workflow Not applicable ApplyOfferToCreateOrderPort Workflow Not applicable ApplyOfferToCreateQuotePort Workflow Not applicable Table 873. Product Offer Data Object Siebel Repository Name External Name RAFProductOfferListIO RAF Product Offer RAFProductOfferStructureIO RAF Product Offer Structure RAFProductOfferRecommendationIO Product Offer Recommendation RAFActionListIO RAF Action List PDS Quote PDS Simplified Quote PDS Order PDS Simplified Order
- 373. Siebel CRM Primary Web Services ■ Product Offer ...ProductOfferApplyOfferToCreateOrder Response (ApplyOfferToCreateOrder) See the following file to view the sample code: ...ProductOfferApplyOfferToCreateOrder Request (ApplyOfferToCreateOrder_NamedParameter) See the following file to view the sample code: ...ProductOfferApplyOfferToCreateOrder_NamedParameter Response (ApplyOfferToCreateOrder_NamedParameter) See the following file to view the sample code: ...ProductOfferApplyOfferToCreateOrder_NamedParameter Request (ApplyOfferToCreateQuote) See the following file to view the sample code: ...ProductOfferApplyOfferToCreateQuote Response (ApplyOfferToCreateQuote) See the following file to view the sample code: ...ProductOfferApplyOfferToCreateQuote Request (ApplyOfferToCreateQuote_NamedParameter) See the following file to view the sample code: ...ProductOfferApplyOfferToCreateQuote_NamedParameter Response (ApplyOfferToCreateQuote_NamedParameter) See the following file to view the sample code: ...ProductOfferApplyOfferToCreateQuote_NamedParameter Request (GetProductOffer) See the following file to view the sample code: ...ProductOfferGetProductOffer Response (GetProductOffer) See the following file to view the sample code: ...ProductOfferGetProductOffer Siebel CRM Web Services Reference Version 8.1/8.2 373
- 374. Siebel CRM Primary Web Services ■ ProductSearchService Request (GetProductOfferStructure) See the following file to view the sample code: ...ProductOfferGetProductOfferStructure Response (GetProductOfferStructure) See the following file to view the sample code: ...ProductOfferGetProductOfferStructure Request (GetRecommendedProductOffers) See the following file to view the sample code: ...ProductOfferGetRecommendedProductOffers Response (GetRecommendedProductOffers) See the following file to view the sample code: ...ProductOfferGetRecommendedProductOffers Interface Description (WSDL) for Product Offer 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. ...ProductOfferWSDL ProductSearchService Use this business service (Search Product Service) for searching the Product business component and performing an eligibility check. ProductSearchService Operations For a list of operations associated with this Web service, see Table 874. Table 874. ProductSearchService Operations Node Description Type ExecuteSearch Retrieves products based Siebel CRM Web Services Reference Version 8.1/8.2 374 on passed criteria. Input: SearchProductInputSiebelMessage Output: SearchProductResponseSiebelMessage
- 375. Siebel CRM Primary Web Services ■ ProductSearchService Request Message Description: ExecuteSearch For a description of this request message, see Table 875. Table 875. Request Message Description: ExecuteSearch Node Description Type EligibilityMode Eligibility mode. String ABOFlag ABO flag. String AccountContractedProduc Flag designated only products contracted through String tsOnlyFlag a given account. AccountId Account ID. String AccountType Type of Account. String ClassId Class ID. String CurrencyCode Currency code. String DiscountPercent Discount in percent. String DisplayName Display name. String EligibilityDisplayMode Mode of eligibility. String ExchangeDate Date of exchange. String HeaderId Header ID. String Mode Mode. String PriceListId Price List ID. String City City name. String PostalCode Postal code. String State State name. String Country Country name. String BusObjName Name of the business object. String BusCompName Name of the business component. String SignalMode Signal mode. String ContextRowId The context row ID. String ContextMode The context mode. String SearchText Search criteria. String Hits Records to be fetched. String Threshold Threshold value. String Timeout Timeout value. String FromPrice Price range. String Siebel CRM Web Services Reference Version 8.1/8.2 375
- 376. Siebel CRM Primary Web Services ■ ProductSearchService Table 875. Request Message Description: ExecuteSearch Node Description Type ToPrice Price range. String Attribute Attribute name. String Feature Feature. String Response Message Description: ExecuteSearch For a description of this response message, see Table 876. Table 876. Response Message Description: ExecuteSearch Node Description Type TotalRecords Total number of records retrieved. String ProductId Product ID. String ProductSearchService 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 877. Table 877. ProductSearchService Service Object Name Boundary Object Type Class SearchProductService Business Service CSSSrchProductSvc Data Object (Integration Object) For a description of data objects for this Web service, see Table 878. Table 878. ProductSearchService Data Object Siebel Repository Name External Name Context PDS Catalog Context SearchProductInputSiebelMessage SearchProductInputIO SearchProductResponseSiebelMessage SearchProductResponseIO Siebel CRM Web Services Reference Version 8.1/8.2 376
- 377. Siebel CRM Primary Web Services ■ PromotionWebService Example Package for ProductSearchService To view an example of messages 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. Request See the following file to view the sample code: ...ProductSearchServiceProductSearchService_request.xml Response See the following file to view the sample code: ...ProductSearchServiceProductSearchService_response.xml Interface Description (WSDL) for ProductSearchService 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. ...ProductSearchServiceProductSearch.wsdl PromotionWebService NOTE: This version of PromotionWebService is available only for implementations of Siebel CRM from version 8.1 and later. To use PromotionWebService with Siebel CRM version 8.0, see version 8.0 of Siebel CRM Web Services Reference. Use this Web service to get product promotion information, apply product promotion, get promotion commitment information and to upgrade a promotion. PromotionWebService Operations For a list of operations associated with this Web service, see Table 879. Table 879. PromotionWebService Operations Name Description getProductPromotionDefinition Returns promotion detail information. ApplyProductPromotion Add a promotion and all default components to a quote or order. getPromotionCommitments Get promotion commitment information for a given promotion asset. Siebel CRM Web Services Reference Version 8.1/8.2 377
- 378. Siebel CRM Primary Web Services ■ PromotionWebService Table 879. PromotionWebService Operations Name Description UpgradePromotionToQuote Upgrade or migrate a promotion instance to another promotion Request Message Description: GetProductPromotionDefinition For a description of this request message, see Table 880. Response Message Description: GetProductPromotionDefinition For a description of this response message, see Table 881. Siebel CRM Web Services Reference Version 8.1/8.2 378 and generate a quote with the updated assets information. UpgradePromotionToOrder Upgrade or migrate a promotion instance to another promotion and generate an order with the updated assets information. Table 880. Request Message Description: GetProductPromotionDefinition Name Description Type EligibilityMode Optional, default value as 2. Could be 0, 1, 2. Not applicable PricingMode Optional, default value as Y. Y or N. Not applicable LoadAllDomainFlag Required value of Y or N. Not applicable LoadDefaultDomainFlag Required value of Y or N. Not applicable LoadPromDefFlag Required value of Y or N. Not applicable ContextMode Required, Siebel Context or External Context. Not applicable Context Required, in SiebelMessage format of IO 'PDS Catalog Context. Not applicable ProdPromRuleType Optional, Product or Pricing. Not applicable Table 881. Response Message Description: GetProductPromotionDefinition Name Description Type ProdPromDefinition In SiebelMessage format of the integration object ISS Promotion Definition for WS. Not applicable PromDomainProduct In SiebelMessage format of the integration object PDS Product Interface'. Could be either default domain product details or all domain product details depending on input arguments. Not applicable Err_spcCode Error Code if error occurred. Not applicable Err_spcMessage Error Message if error occurred. Not applicable
- 379. Siebel CRM Primary Web Services ■ PromotionWebService Request Message Description: ApplyProductPromotion For a description of this request message, see Table 882. Table 882. Request Message Description: ApplyProductPromotion Name Description Type EligibilityMode Optional. The default value is 2. Could be 0, 1, 2. Not applicable PricingMode Optional. The default value as Y. Possible values are Y Response Message Description: ApplyProductPromotion For a description of this response message, see Table 883. Request Message Description: getPromotionCommitments For a description of this request message, see Table 884. Siebel CRM Web Services Reference Version 8.1/8.2 379 or N. Not applicable ProdPromId Required. Not applicable ProdPromInstanceId Optional, depending on usage scenarios. Not applicable LineItemId Optional, depending on usage scenarios. Not applicable Quantity Optional. The default value is 1. Not applicable SiebelMessage Required, in SiebelMessage format of the integration object PDS Quote. Not applicable Table 883. Response Message Description: ApplyProductPromotion Name Description Type SiebelMessage Required. In SiebelMessage format of the integration object PDS Quote. Not applicable Err_spcCode Error code if one occurred. Not applicable Err_spcMessage Error message if one occurred. Not applicable Table 884. Request Message Description: getPromotionCommitments Name Description Type Asset Integration Id Required. Asset Integration ID of the Promotion Instance Asset. String
- 380. Siebel CRM Primary Web Services ■ PromotionWebService Response Message Description: getPromotionCommitments For a description of this response message, see Table 885. Table 885. Response Message Description: getPromotionCommitments Name Description Type PromotionCommitments An instance of the integration object ISS Request Message Description: UpgradePromotionToQuote For a description of this request message, see Table 886. Response Message Description: UpgradePromotionToQuote For a description of this response message, see Table 887. Siebel CRM Web Services Reference Version 8.1/8.2 380 Promotion Commitments. Integration Object Table 886. Request Message Description: UpgradePromotionToQuote Name Description Type NewPromotionId Required. RowId of new promotion. String AssetNumber Asset number of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. String AssetIntegrationId Asset integration ID of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. String ActiveDocumentId A Document in Siebel Order Management refers to a Quote or an Order. Each Document can have multiple children (Quote Items or Order Line Items). ActiveDocumentId refers to the current active Document that the current process is working on. In this Web service call, it is the Quote ID of the active Quote to which the generated quote item has to be added. This is an optional input. String AccountId Account ID of the account that owns the selected promotion asset being upgraded. String OverridePenaltyAmount Penalty amount for upgrading the promotion, if any. String OverrideProratePlanId If there is a penalty for upgrading the promotion, also pass in the prorate plan used to prorate this penalty, if any. String Table 887. Response Message Description: UpgradePromotionToQuote Name Description Type QuoteIO An instance of the integration object PDS Quote. Integration Object
- 381. Siebel CRM Primary Web Services ■ PromotionWebService Request Message Description: UpgradePromotionToOrder For a description of this request message, see Table 888. Table 888. Request Message Description: UpgradePromotionToOrder Name Description Type NewPromotionId Required. RowId of new promotion. String AssetNumber Asset Number of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. AssetIntegrationId Asset Integration ID of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. ActiveDocumentId A Document in Siebel Order Management refers to a Quote or an Order. Each Document can have multiple children (Quote Items or Order Line Items). ActiveDocumentId refers to the current active Document that the current process is working on. In this Web service call, it is the Order ID of the active Order to which the generated order item has to be added. This is an optional input. AccountId Account ID of the account that owns the selected promotion asset being upgraded. OverridePenaltyAmount Penalty amount for upgrading the promotion, if any. String OverrideProratePlanId If there is a penalty for upgrading the promotion, also pass in the prorate plan used to prorate this penalty, if any. Response Message Description: UpgradePromotionToOrder For a description of this response message, see Table 889. String String String String String Table 889. Response Message Description: UpgradePromotionToOrder Name Description Type OrderIO An instance of the integration object PDS Order. Integration Object PromotionWebService 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. Siebel CRM Web Services Reference Version 8.1/8.2 381
- 382. Siebel CRM Primary Web Services ■ QueryTransportationSalesOrder ItineraryListSiebelReqABCSImpl Web Service Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 890. Table 890. PromotionWebService Service Objects Name Boundary Object Type ISS Promotion WS - GetPromotionCommitments Workflow ISS Promotion WS-Upgrade Promotion-Quote Workflow ISS Promotion WS-Upgrade Promotion-Order Workflow Data Object (Integration Object) For a description of data objects for this Web service, see Table 891. Table 891. PromotionWebService Data Objects Siebel Repository Name External Name ISS Promotion Commitments ISS Promotion Commitments PDS Quote PDS Quote PDS Order PDS Order Example Package for PromotionWebService To view an example of messages 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. Interface Description (WSDL) for PromotionWebService 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. ...PromotionWebServicePromotionWebService.wsdl QueryTransportationSalesOrder ItineraryListSiebelReqABCSImpl Web Service Use this outbound Web service to submit an order to the rating engine and get ratings in response. This Web service submits an order request to the third-party application to get feasible solutions for this transportation order. Siebel CRM Web Services Reference Version 8.1/8.2 382
- 383. Siebel CRM Primary Web Services ■ QueryTransportationSalesOrder ItineraryListSiebelReqABCSImpl Web Service QueryTransportationSalesOrderItineraryListSiebelReqABCSImpl Operations For a list of operations associated with this Web service, see Table 892. Table 892. QueryTransportationSalesOrderItineraryList Operations Name Description QueryTransportationSalesOrderItineraryList Submits the order request Request Message Description: QueryTransportationSalesOrderItineraryList For a description of this request message, see Table 893. Table 893. Request Message Description: QueryTransportationSalesOrderItineraryList Node Description Type CustomHeaderContext Optional Hierarchy QueryTransportationSalesOrderItineraryListReqMsg:Query TransportationSales_1 Optional Integration Response Message Description: QueryTransportationSalesOrderItineraryList For a description of this response message, see Table 894. Object Table 894. Response Message Description: QueryTransportationSalesOrderItineraryList Node Description Type QueryTransportationSalesOrderItineraryListReqMsg:Query TransportationSales_1 Optional Integration Object QueryTransportationSalesOrderItineraryListSiebelReqABCSImplServi ce 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 895. Table 895. QueryTransportationSalesOrderItineraryListSiebelReqABCSImplService Service Object Siebel Repository Name Boundary Object Type Class QueryTransportationSalesOrderItinerary ListSiebelReqABCSImplService Business Service CSSWSOutboundDispatcher Siebel CRM Web Services Reference Version 8.1/8.2 383
- 384. Siebel CRM Primary Web Services ■ QuoteCheckOutWebService This object is called from the virtual business component context. Unlike other Web services, which are generally called by clicking a button or selecting a menu item, this Web service is called when an applet based on the appropriate virtual business component is displayed. Data Objects (Integration Object) For a description of data objects for this Web service, see Table 896. Table 896. QueryTransportationSalesOrderItineraryListSiebelReqABCSImplService Data Objects Siebel Repository Name External Name SWIOrderIO PDS Simplified Order SWIOrderEntry(Sales)IORes Order Entry (Sales) Methods For a description of the methods for this Web service, see Table 897. Table 897. QueryTransportationSalesOrderItineraryListSiebelReqABCSImplService Methods Operation Method SWIOrderIO PDS Simplified Order SWIOrderEntry(Sales)IORes Order Entry (Sales) QuoteCheckOutWebService Use this Web service to perform payment authorizations for quotes. QuoteCheckOutWebService Operations For a list of operations associated with this Web service, see Table 898. Table 898. QuoteCheckOutWebService Operations Node Description QuoteCheckOut Executes payment authorization. If the authorization fails, then the operation Siebel CRM Web Services Reference Version 8.1/8.2 384 stops and returns. Otherwise, the quote is submitted to order.
- 385. Siebel CRM Primary Web Services ■ QuoteCheckOutWebService Request Message Description: QuoteCheckOut For a description of this request message, see Table 899. Table 899. Request Message Description: QuoteCheckOut Node Description Type QuoteCheckOut_Input The request message includes the ID of the quote to be submitted, a flag to indicate whether to do credit card authorization, and a flag to indicate whether to submit the quote to order. Response Message Description: QuoteCheckOut For a description of this response message, see Table 900. ComplexType Table 900. Response Message Description: QuoteCheckOut Node Description Type QuoteCheckOut_Output The response message includes the ID of the order converted from quote. ComplexType Example Package for QuoteCheckOutWebService To view an example of messages 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. Request See the following file to view the sample code: ...QuoteCheckOutWebServiceQuoteCheckOutWebService_request.xml Response See the following file to view the sample code: ...QuoteCheckOutWebServiceQuoteCheckOutWebService_response.xml Interface Description (WSDL) for QuoteCheckOutWebService 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. ...QuoteCheckOutWebServiceQuoteCheckOutWebService.wsdl Siebel CRM Web Services Reference Version 8.1/8.2 385
- 386. Siebel CRM Primary Web Services ■ QuoteDetailWebService QuoteDetailWebService Use this Web service to retrieve, update, insert, or delete details on a quote record. QuoteDetailWebService Operations For a list of operations associated with this Web service, see Table 901. Table 901. QuoteDetailWebService Operations Node Description QuoteDetailGet Requests and retrieves quote detail. QuoteDetailUpdate Updates quote details. QuoteDetailInsert Inserts new quote detail. QuoteDetailDelete Deletes quote details. QuoteDetailInit Quote is initialized from database. Request Message Description: QuoteDetailGet For a description of this request message, see Table 902. Table 902. Request Message Description: QuoteDetailGet Node Description Type QuoteDetailGet_Input Quote object passed to the Web service. Response Message Description: QuoteDetailGet For a description of this response message, see Table 903. Request Message Description: QuoteDetailUpdate For a description of this request message, see Table 904. Siebel CRM Web Services Reference Version 8.1/8.2 386 It includes the search criteria. ComplexType Table 903. Response Message Description: QuoteDetailGet Node Description Type QuoteDetailGet_Output Quote object returned. It includes the detail of the quote header and the payment information. ComplexType Table 904. Request Message Description: QuoteDetailUpdate Node Description Type QuoteDetailUpdate_Input Quote to be updated into database. ComplexType
- 387. Siebel CRM Primary Web Services ■ QuoteDetailWebService Response Message Description: QuoteDetailUpdate For a description of this response message, see Table 905. Table 905. Response Message Description: QuoteDetailUpdate Node Description Type QuoteDetailUpdate_Output Quote returned with updated information. Request Message Description: QuoteDetailInsert For a description of this request message, see Table 906. Table 906. Request Message Description: QuoteDetailInsert Node Description Type QuoteDetailInsert_Input Quote to be inserted into the database. ComplexType Response Message Description: QuoteDetailInsert For a description of this response message, seeTable 907. Table 907. Response Message Description: QuoteDetailInsert Node Description Type QuoteDetailDelete_Output Quote returned from the Web service. Request Message Description: QuoteDetailDelete For a description of this request message, see Table 908. Table 908. Request Message Description: QuoteDetailDelete Node Description Type QuoteDetailDelete_Input Quote to be deleted from database. ComplexType Response Message Description: QuoteDetailDelete For a description of this response message, see Table 909. ComplexType ComplexType Table 909. Response Message Description: QuoteDetailDelete Node Description Type QuoteDetailDelete_Output Quote returned from the Web service. ComplexType Siebel CRM Web Services Reference Version 8.1/8.2 387
- 388. Siebel CRM Primary Web Services ■ QuotingWebService Request Message Description: QuoteDetailInit For a description of this request message, see Table 910. Table 910. Request Message Description: QuoteDetailInit Node Description Type QuoteDetailInit_Input Quote to be initialized from the Response Message Description: QuoteDetailInit For a description of this response message, see Table 911. Example Package for QuoteDetailWebService To view an example of messages 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. Request See the following file to view the sample code: ...QuoteDetailWebServiceQuoteDetailWebService_request.xml Response See the following file to view the sample code: ...QuoteDetailWebServiceQuoteDetailWebService_response.xml Interface Description (WSDL) for QuoteDetailWebService 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. ...QuoteDetailWebServiceQuoteDetailWebService.wsdl QuotingWebService Use this Web service to process quotes and commit them to the database. Siebel CRM Web Services Reference Version 8.1/8.2 388 database. ComplexType Table 911. Response Message Description: QuoteDetailInit Node Description Type QuoteDetailInit_Output Quote returned from the Web service. ComplexType
- 389. Siebel CRM Primary Web Services ■ QuotingWebService QuotingWebService Operations For a list of operations associated with this Web service, see Table 912. Table 912. QuotingWebService Operations Name Description ExecuteQuoting Saves the quote to the database. Checks eligibility, verifies the promotion, or calculates the price, shipping charge and tax based on the pass-in flag. Request Message Description: ExecuteQuoting For a description of this request message, see Table 913. Table 913. Request Message Description: ExecuteQuoting Node Description Type ExecuteQuoting_Input The request message includes the quote to be saved. It also includes the following flags: ■ Flag to indicate whether to check the eligibility. ■ Flag to indicate whether to calculate the price for the quote. ■ Flag to indicate whether to calculate the shipping cost. ■ Flag to indicate whether to calculate the tax. ■ Flag to indicate whether to verify the promotion. ■ Flag to indicate whether to query the quote back from database or just return the quote in memory. Response Message Description: ExecuteQuoting For a description of this response message, see Table 914. ComplexType Table 914. Response Message Description: ExecuteQuoting Node Description Type ExecuteQuoting_Output The response message includes the quote returned from Web service. ComplexType QuotingWebService 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. Siebel CRM Web Services Reference Version 8.1/8.2 389
- 390. Siebel CRM Primary Web Services ■ Response Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 915. Table 915. QuotingWebService Service Object Name Boundary Object Type Web Channel Quoting Workflow Not applicable Data Object (Integration Object) For a description of data objects for this Web service, see Table 916. Table 916. QuotingWebService Data Object Siebel Repository Name External Name PDS Quote PDS Simplified Quote Example Package for QuotingWebService To view an example of messages 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. Request See the following file to view the sample code: ...QuotingWebServiceQuotingWebService_request.xml Response See the following file to view the sample code: ...QuotingWebServiceQuotingWebService_response.xml Interface Description (WSDL) for QuotingWebService 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. ...QuotingWebServiceQuotingWebService.wsdl Response Use this Web service for the basic Marketing operations such as creating and updating responses. Siebel CRM Web Services Reference Version 8.1/8.2 390
- 391. Siebel CRM Primary Web Services ■ Response Response Operations For a list of operations associated with this Web service, see Table 917. Table 917. Response Operations Name Description ResponseCreateResponse Creates a response. ResponseSourceCodeLookup This operation is used to determine the campaign history record. ResponseUpdateResponse Updates a response. Request Message Description: ResponseCreateResponse This method takes in an Integration object called Response IO and returns the Response ID and Success Flag. For a description of this request message, see Table 918. Table 918. Request Message Description: ResponseCreateResponse Node Description Type Response IO Required input parameter. Integration Object Response Message Description: ResponseCreateResponse For a description of this response message, see Table 919. Table 919. Response Message Description: ResponseCreateResponse Node Description Type Response Id Row ID of the new response. String Error Message Error message, if any. String Success Flag Y or N. String Request Message Description: ResponseSourceCodeLookup This method takes in Ids and Codes of Offer, Campaign and Treatment and returns the S_CAMP_CON_ID. For a description of this request message, see Table 920. Table 920. Request Message Description: ResponseSourceCodeLookup Node Description Type Campaign Code Campaign code of response source. String Campaign Id Campaign ID of response source. String Offer Code Offer code for response. String Offer Id Offer ID for response. String Source Code Source code for response. String Siebel CRM Web Services Reference Version 8.1/8.2 391
- 392. Siebel CRM Primary Web Services ■ Response Table 920. Request Message Description: ResponseSourceCodeLookup Node Description Type Treatment Code Treatment code for response. String Treatment Id Treatment ID for response. String Response Message Description: ResponseSourceCodeLookup For a description of this response message, see Table 921. Table 921. Response Message Description: ResponseSourceCodeLookup Node Description Type S_CAMP_CON_ID Row ID of the response. String Error Message Error message, if any. String Success Flag Y or N. String Request Message Description: ResponseUpdateResponse This method updates an existing response. For a description of this request message, see Table 922. Table 922. Request Message Description: ResponseUpdateResponse Node Description Type Response IO Required input parameter. Integration Object Response Message Description: ResponseUpdateResponse For a description of this response message, see Table 923. Table 923. Response Message Description: ResponseUpdateResponse Node Description Type Error Message Error message, if any. String Success Flag Y or N. String Example Package for Response To view an example of messages 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. Request (ResponseCreateResponse) See the following file to view the sample code: ...ResponseResponseCreateResponse_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 392
- 393. Siebel CRM Primary Web Services ■ RetrieveAttachmentService Response (ResponseCreateResponse) See the following file to view the sample code: ...ResponseResponseCreateResponse_response.xml Request (ResponseSourceCodeLookup) See the following file to view the sample code: ...ResponseResponseSourceCodeLookup_request.xml Response (ResponseSourceCodeLookup) See the following file to view the sample code: ...ResponseResponseSourceCodeLookup_response.xml Request (ResponseUpdateResponse) See the following file to view the sample code: ...ResponseResponseUpdateResponse_request.xml Response (ResponseUpdateResponse) See the following file to view the sample code: ...ResponseResponseUpdateResponse_request.xml Interface Description (WSDL) for Response 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. ...ResponseResponse.wsdl RetrieveAttachmentService This Web service has one standard QueryPage method to retrieve attachment documents. Siebel CRM Web Services Reference Version 8.1/8.2 393
- 394. Siebel CRM Primary Web Services ■ RetrieveAttachmentService RetrieveAttachmentService Operations Provides search solution results. Business Service (Search Solution Service) for Searching Solution business component. For a list of operations associated with this Web service, see Table 924. Table 924. RetrieveAttachmentService Operations Name Parameters Description QueryPage Input: Attachment ID Request Message Description: RetrieveAttachmentService This fetches the Attachment content for a given attachment ID. For a description of this request message, see Table 925. Siebel CRM Web Services Reference Version 8.1/8.2 394 Output: AttachmentDocIO (Attachment File Content) This retrieves the attachment content for a given attachment ID. Table 925. Request Message Description: RetrieveAttachmentService Node Description Type Id Document ID String ModId Modification ID String ResFileAutoUpdFlg Y or N String ResFileDate File Date String ResFileDeferFlg Y or N String ResFileDockReqFlg Y or N String ResFileDockStatFlg Y or N String ResFileDockStatus Y or N String ResFileExt File Extension String ResFileName File Name String ResFileRev File ID String ResFileSize File Size String ResFileSrcPath File Source Path String ResFileSrcType File Source Type String ResFileBuffer File Buffer String LOVLanguageMode Language Independent code String ExecutionMode Execution Mode String ViewMode Visibility Access Mode String
- 395. Siebel CRM Primary Web Services ■ RetrieveAttachmentService Response Message Description: RetrieveAttachmentService For a description of this response message, see Table 926. Table 926. Response Message Description: RetrieveAttachmentService Node Description Type Id Document ID String ModId Modification ID String ResFileAutoUpdFlg Y or N String ResFileDate File Date String ResFileDeferFlg Y or N String ResFileDockReqFlg Y or N String ResFileDockStatus Y or N String ResFileExt File Extension String ResFileName File Name String ResFileRev File ID String ResFileSize File Size String ResFileSrcPath File Source Path String ResFileSrcType File Source Type String ResFileBuffer File Buffer String RetrieveAttachmentService 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 927. Table 927. RetrieveAttachmentService Service Object Name Boundary Object Type Class RetrieveAttachmentService Business Service CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 395
- 396. Siebel CRM Primary Web Services ■ SCOAExportWS Data Object (Integration Object) For a description of data objects for this Web service, see Table 928. Table 928. RetrieveAttachmentService Data Object Siebel Repository Name External Name SiebelMessageIn AttachmentDocIO SiebelMessageOut AttachmentDocIO Example Package for RetrieveAttachmentService To view an example of messages 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. Request See the following file to view the sample code: ...RetrieveAttachmentRetrieveAttachment_request.xml Response See the following file to view the sample code: ...RetrieveAttachmentRetrieveAttachment_response.xml Interface Description (WSDL) for RetrieveAttachmentService 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. ...RetrieveAttachmentRetrieveAttachment.wsdl SCOAExportWS Use this outbound Web Service to export an update commerce job to Siebel Commerce Object Aggregator (SCOA). SCOAExportWS Operations For a list of operations associated with this Web service, see Table 929. Table 929. SCOAExportWS Operations Name Description StartExportJob Export a content job to SCOA Siebel CRM Web Services Reference Version 8.1/8.2 396
- 397. Siebel CRM Primary Web Services ■ SCOAExportWS Request Message Description: StartExportJob For a description of this request message, see Table 930. Table 930. Request Message Description: StartExportJob Node Description Type JobId Update Commerce Job Id String Response Message Description: StartExportJob For a description of this response message, see Table 931. Table 931. Response Message Description: StartExportJob Node Description Type Return Return status from SCOA String SCOAExportWS 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 932. Table 932. SCOAExportWS Service Object Name Boundary Object Type Class SCOAExportWS Business Service CSSWSOutboundDispatcher Methods For a description of the methods for this Web service, see Table 933. Table 933. SCOAExportWS Methods Operation Method StartExportJob StartExportJob Example Package for SCOAExportWS To view an example of messages 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. Siebel CRM Web Services Reference Version 8.1/8.2 397
- 398. Siebel CRM Primary Web Services ■ searchSolution Request See the following file to view the sample code: ... SCOAExportSCOAExportRequest.xml Response See the following file to view the sample code: ... SCOAExportSCOAExportResponse.xml Interface Description (WSDL) for SCOAExportWS 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. ...SCOAExportSCOAExportWS.WSDL searchSolution Use this Web service to search for solutions based on user inputs, and retrieve a solution as a search result. searchSolution Operations The operations provide search solution results. The Web service uses the business service called Search Solution Service of Searching Solution business component. For a list of operations associated with this Web service, see Table 934. Table 934. searchSolution Operations Name Parameters Description searchSolution.searchSolution Input: SearchInputsIO (SearchText, Siebel CRM Web Services Reference Version 8.1/8.2 398 SolutionType, To, From). Output: SearchResultsIO (Total Records, Solution ID, Solution Title, Last Update Date). Performs a search on a solution based on specified input. searchSolution.getSolution Input: SolutionId. Output: SolutionResultIO (Solution ID, Solution Title, Last Update Date, FAQ, Resolution Text, Solution Type, SolnAttachmentList (Attachment ID, File Name, Last Updated Date, Type) ). Retrieves solution from search results.
- 399. Siebel CRM Primary Web Services ■ searchSolution Request Message Description: searchSolution Performs a search on a solution based on specified input. For a description of this request message, see Table 935. Table 935. Request Message Description: searchSolution Node Description Type SearchText Text to be searched. String SolutionType Type of Solution. String From Index of Record. String To Index of Record. String Response Message Description: searchSolution For a description of this response message, see Table 936. Table 936. Response Message Description: searchSolution Node Description Type TotalRecords Total number of records fetched. String From Index of the first record returned. String SolutionId Solution ID. String SolutionTitle Solution Title. String LastUpdateDate Last update date of the record. String To Index of the last record fetched. String Request Message Description: getSolution Retrieves solution from search results. For a description of this request message, see Table 937. Table 937. Request Message Description: getSolution Node Description Type SolutionId Solution ID String Response Message Description: getSolution For a description of this response message, see Table 938. Table 938. Response Message Description: getSolution Node Description Type FAQ Frequently Asked Question String LastUpdateDate Last update date of the record String Siebel CRM Web Services Reference Version 8.1/8.2 399
- 400. Siebel CRM Primary Web Services ■ searchSolution Table 938. Response Message Description: getSolution Node Description Type AttachmentId Attachment ID String AttachmentType Type of Attachment String Name Name String ResolutionText Resolution Text message String searchSolution 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 939. Table 939. searchSolution Service Object Name Boundary Object Type Class Search Solution Service Business Service CSSSrchSolutionSvc Data Object (Integration Object) For a description of data objects for this Web service, see Table 940. Table 940. searchSolution Data Object Siebel Repository Name External Name SolutionResultSiebelMessage SolutionResultIO SearchInputsSiebelMessage SearchInputsIO SearchResultsSiebelMessage SearchResultsIO Example Package for searchSolution To view an example of messages 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. Request See the following file to view the sample code: ...searchSolutionsearchSolution_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 400
- 401. Siebel CRM Primary Web Services ■ SelfServiceAccount Response See the following file to view the sample code: ...searchSolutionsearchSolution_response.xml Interface Description (WSDL) for searchSolution 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. ...searchSolutionsearchSolution.wsdl SelfServiceAccount This Web service makes available the EAI UI business service SelfServiceAccount, which provides CRUD and query operations on the integration object SS_Account_IO. This Web service makes available the Execute and Query Methods in the SelfServiceAccount business service as Web service operations. SelfServiceAccount Operations For a list of operations associated with this Web service, see Table 941. Table 941. SelfServiceAccount Operations Name Description SelfServiceAccountExecute Performs CRUD operations on the instance of SS_Account_IO provided as input. This operation is used in Siebel Self-Service for adding, editing and deleting BusinessAddress to an Account. SelfServiceAccountQueryPage Performs Query operation based on the viewCriteria and searchSpec set on the instance of SS_Account_IO provided as input. This operation is used in Siebel Self-Service for querying the details of an Account, inclusive of the Business Addresses associated to the account. Request Message Description: SelfServiceAccountExecute For a description of this request message, see Table 942. Table 942. Request Message Description: SelfServiceAccountExecute Node Description SelfServiceAccountExecute_Input Container element for the Execute Operation request. ListOfSSAccount Corresponds to an instance of SS_Account_IO. Siebel CRM Web Services Reference Version 8.1/8.2 401
- 402. Siebel CRM Primary Web Services ■ SelfServiceAccount Table 942. Request Message Description: SelfServiceAccountExecute Node Description ListOfSSAccount/ Account Set operation accordingly. If account details need to Siebel CRM Web Services Reference Version 8.1/8.2 402 be updated, then set the operation to Update. If the business address needs to be added or updated, then set operation to Skipnode. ListOfSSAccount/ Account /Id Set the ID of the account as a ViewCriteria, if the purpose is to update the account or create and update business address for the given account. ListOfSSAccount/ Account / ListOfAccountBusinessAddress Container element to hold the list of business addresses to be created or updated for the account. ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress Used to create or update the business address of the Account. Set operation appropriately as Insert or Update and enable the IsPrimaryMVG setting, if this address needs to be made the primary address on the Account. ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ Id If the operation is update on AccountBusinessAddress, then set this field to the specific address of the account. ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ StreetAddress (Similarly StreetAddress2, AddressLine3, State, City, County, Country) Set appropriate values for the details of this address. ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ MainAddressFlag Set to TRUE if the address is the main address for the account. ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ BillAddressFlag Set TRUE if the address is the billable address for the account. ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ ShipAddressFlag Set TRUE to fetch if the address is the shippable address for the account. ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ ActiveStatus Set to TRUE, if only the active addresses of the account need to be retrieved. ListOfAccountBusinessAddress/ AccountBusinessAddress/ ModId Set the ModId while updating, so as to make sure that the record is not updated in the interim.
- 403. Siebel CRM Primary Web Services ■ SelfServiceAccount Table 942. Request Message Description: SelfServiceAccountExecute Node Description ExecutionMode For more information, see Business Processes and Rules: Siebel Enterprise Application Integration. LOVLanguageMode For more information, see Business Processes and Rules: Siebel Enterprise Application Integration. ViewMode For more information, see Business Processes and Rules: Siebel Enterprise Application Integration. Response Message Description: SelfServiceAccountExecute For a description of this response message, see Table 943. Table 943. Response Message Description: SelfServiceAccountExecute Node Description SelfServiceAccountExecute_Output Container element for the Execute Operation response. ListOfSSAccount Corresponds to an instance of SS_Account_IO. ListOfSSAccount/ Account Account name. ListOfSSAccount/ Account /Id ID of the account. ListOfSSAccount/ Account / Mod Id Mod ID for the account record. ListOfSSAccount/ Account / Container element for the list of created or updated business address of the account. ListOfBusinessAddress Siebel CRM Web Services Reference Version 8.1/8.2 403 ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress For each created or updated business address of the account. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ Id ID of the address created or updated. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ModId ModId of the address record created or updated.
- 404. Siebel CRM Primary Web Services ■ SelfServiceAccount Request Message Description: SelfServiceAccountQueryPage This operation is used to query the details of the Account or to query the list of business addresses associated with an account. This operation also retrieves the following information for a given account: primary address ID, primary Bill To Address ID, primary Ship To Address ID, as well as determining if each of the retrieved addresses are Billable or Shippable. Siebel Self-Service Applications version 8.1 use LOVLanguageMode as ‘LDC’ and ViewMode as ‘All’ for this Web service. For a description of this request message, see Table 944. Table 944. Request Message Description: SelfServiceAccountQueryPage Node Description SelfServiceAccountQueryPage_Input Container element for the QueryPage Operation Siebel CRM Web Services Reference Version 8.1/8.2 404 request. ListOfSSAccount Corresponds to an instance of SS_Account_IO. ListOfSSAccount/ Account Account name. ListOfSSAccount/ Account /Id Set the ID of the account as a ViewCriteria. ListOfSSAccount/ Account / PrimaryAddressId Empty. Used to fetch the ID of the primary address of the account. ListOfSSAccount/ Account / PrimaryBillToAddressId Empty. Used to fetch the ID of the Primary Bill To address of the account. ListOfSSAccount/ Account / PrimaryShipToAddressId Empty. Used to fetch the ID of the Primary Ship To address of the account. ListOfSSAccount/ Account / ListOfBusinessAddress To fetch the business address of the account. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress Empty. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ Id Empty (Set it to retrieve a specific address of this account). ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ StreetAddress (Similarly StreetAddress2, AddressLine3, State, City, County, Country) Empty. Set appropriate View Criteria for filtering addresses. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ MainAddressFlag Empty. Used to fetch if the address is the main address for the account. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ BillAddressFlag Empty. Used to fetch if the address is the Billable Address for the account.
- 405. Siebel CRM Primary Web Services ■ SelfServiceAccount Table 944. Request Message Description: SelfServiceAccountQueryPage Node Description ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ShipAddressFlag Empty. Used to fetch if the address is the Shippable Address for the account. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ActiveStatus Set to TRUE, only if the active addresses of the account need to be retrieved. ListOfSSAccount/ Account / Empty. ListOfBusinessAddress/ BusinessAddress/ ModId Empty. Used to fetch the ModId to be sent back while updating, so as to make sure that the record is not updated in the interim. ExecutionMode For more information, see Business Processes and Rules: Siebel Enterprise Application Integration. LOVLanguageMode For more information, see Business Processes and Rules: Siebel Enterprise Application Integration. ViewMode For more information, see Business Processes and Rules: Siebel Enterprise Application Integration. Response Message Description: SelfServiceAccountQueryPage For a description of this response message, see Table 945. Table 945. Response Message Description: SelfServiceAccountQueryPage Node Description SelfServiceAccountQueryPage_Output Container element for the QueryPage Operation response. ListOfSSAccount Corresponds to an instance of SS_Account_IO. ListOfSSAccount/ Account ListOfSSAccount/ Account /Id ID of the account. ListOfSSAccount/ Account / PrimaryAddressId Retrieved ID of the Primary Address of the account. Siebel CRM Web Services Reference Version 8.1/8.2 405 ListOfSSAccount/ Account / PrimaryBillToAddressId Retrieved ID of the Primary Bill To address of the account. ListOfSSAccount/ Account / PrimaryShipToAddressId Retrieved ID of the Primary Ship To address of the account. ListOfSSAccount/ Account / ListOfBusinessAddress Container element for the retrieved Business Address of the account.
- 406. Siebel CRM Primary Web Services ■ SelfServiceAccount Table 945. Response Message Description: SelfServiceAccountQueryPage Node Description ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress SelfServiceAccount Application Interface This topic describes the application objects called by this Web service. This Web service makes available the EAI UI business service SelfServiceAccount, which provides CRUD and query operations on the integration object SS_Account_IO. For more information on application implementation, refer to your application development documentation on Oracle Technology Network. Siebel CRM Web Services Reference Version 8.1/8.2 406 For each retrieved business address of the account. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ Id ID of the address. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ StreetAddress (Similarly StreetAddress2, AddressLine3, State, City, County, Country) Details of the business address. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ MainAddressFlag True, if the address is the main Address for the account. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ BillAddressFlag True, if the address is the Billable Address for the account. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ShipAddressFlag True, if the address is the Shippable Address for the account. ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ActiveStatus True, if the address is active. ListOfBusinessAddress/ BusinessAddress/ ModId Empty; to fetch the ModId to be sent back while updating, so as to make sure that the record is not updated in the interim.
- 407. Siebel CRM Primary Web Services ■ SelfServiceAccount Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 946. Table 946. SelfServiceAccount Service Object Name Boundary Object Type Class SelfServiceAccount Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service, see Table 947. Table 947. SelfServiceAccount Data Object Siebel Repository Name External Name SS_Account_IO SS_Account_IO Example Package for SelfServiceAccount To view an example of messages 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. Request (SelfServiceAccountExecute) See the following file to view the sample code: ...SelfServiceAccountSelfServiceAccountExecute_request.xml Response (SelfServiceAccountExecute) See the following file to view the sample code: ...SelfServiceAccountSelfServiceAccountExecute_response.xml Request (SelfServiceAccountQueryPage) See the following file to view the sample code: ...SelfServiceAccountSelfServiceAccountQueryPage_request.xml Response (SelfServiceAccountQueryPage) See the following file to view the sample code: ...SelfServiceAccountSelfServiceAccountQueryPage_response.xml Siebel CRM Web Services Reference Version 8.1/8.2 407
- 408. Siebel CRM Primary Web Services ■ SelfServiceAccountRootPath Interface Description (WSDL) for SelfServiceAccount 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. ...SelfServiceAccountQueryPageSelfServiceAccount.wsdl SelfServiceAccountRootPath This Web service makes available the EAI UI business service SelfServiceAccountRootPath, which provides query operations on integration object SS_AccountRootPath_IO. This Web service makes available the Query Method in the SelfServiceAccount business service as a Web service operation. In Siebel Self-Service Applications, version 8.1, this operation is used in the context of Global Accounts - Account Hierarchy. For a given account, this operation is used for retriving the path to the root account and also to fetch the price lists of the accounts along this path. SelfServiceAccountRootPath Operations For a list of operations associated with this Web service, see Table 948. Table 948. SelfServiceAccountRootPath Operations Name Description SelfServiceAccountRootPathQueryPage Performs a query operation based on the viewCriteria and Request Message Description: SelfServiceAccountRootPathQueryPage For a description of this request message, see Table 949. Siebel CRM Web Services Reference Version 8.1/8.2 408 searchSpec set on the instance of SS_AccountRootPath_IO provided as input. The response contains the list of accounts along the path to the root account and the priceList set for each of these accounts. Table 949. Request Message Description: SelfServiceAccountRootPathQueryPage Node Description SelfServiceAccountRootPathQueryPage_Input Container element for the QueryPage operation request. ListOfSSAccountRootPath Corresponds to an instance of SS_AccountRootPath_IO. ListOfSSAccountRootPath / SSAccountRootPath Container element, which holds the columns to be queried, and the criteria to be used. ListOfSSAccountRootPath / SSAccountRootPath /ParPartyId Empty.
- 409. Siebel CRM Primary Web Services ■ SelfServiceAccountRootPath Table 949. Request Message Description: SelfServiceAccountRootPathQueryPage Node Description Response Message Description: SelfServiceAccountRootPathQueryPage The response contains the details based on the query set on the Payment integration object . For a description of this response message, see Table 950. Siebel CRM Web Services Reference Version 8.1/8.2 409 ListOfSSAccountRootPath / SSAccountRootPath /PartyId Empty. ListOfSSAccountRootPath / SSAccountRootPath /PartyName Empty. ListOfSSAccountRootPath / SSAccountRootPath /PriceListId Empty. ListOfSSAccountRootPath / SSAccountRootPath /RelationTypeCode Empty. ListOfSSAccountRootPath / SSAccountRootPath /Level1PartyId ID of the Account, from which the path to the root Account needs to be identified. ExecutionMode Forward only. LOVLanguageMode LDC. ViewMode All. Table 950. Response Message Description: SelfServiceAccountRootPathQueryPage Node Description SelfServiceAccountRootPathQueryPage_Output Container element for the QueryPage Operation response. ListOfSSAccountRootPath Corresponds to an instance of SS_AccountRootPath_IO. ListOfSSAccountRootPath /SSAccountRootPath Container element, which corresponds to an Account that is present along the path to the root Account. ListOfSSAccountRootPath /SSAccountRootPath / ParPartyId If ParPartyId is null, the retrieved account is deemed as the root account. Otherwise, this account is one of the accounts in the path. ListOfSSAccountRootPath /SSAccountRootPath / PartyId ID of the retrieved account. ListOfSSAccountRootPath /SSAccountRootPath / PartyName Name of the retrieved account. ListOfSSAccountRootPath /SSAccountRootPath / PriceListId PriceListId of the retrieved account.
- 410. Siebel CRM Primary Web Services ■ SelfServiceAccountRootPath Table 950. Response Message Description: SelfServiceAccountRootPathQueryPage Node Description ListOfSSAccountRootPath /SSAccountRootPath / RelationTypeCode SelfServiceAccountRootPath Application Interface This topic describes the application objects called by the SelfServiceAccountRootPath. For more information on application implementation, refer to your application development documentation on Oracle Technology Network. For more information on application implementation, refer to application development documentation. Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 951. Data Object (Integration Object) For a description of data objects for this Web service, see Table 952. Example Package for SelfServiceAccountRootPath To view an example of messages 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. Request See the following file to view the sample code: ...SelfServiceAccountRootPathSelfServiceAccountRootPath_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 410 SELF or DIRECT or INDIRECT. ListOfSSAccountRootPath /SSAccountRootPath / Level1PartyId DIRECT. The Account is the parent the Level1PartyId. Table 951. SelfServiceAccountRootPath Service Object Name Boundary Object Type Class SelfServiceAccountRootPath Business Service CSSEAIUIDataService Table 952. SelfServiceAccountRootPath Data Object Siebel Repository Name External Name SS_AccountRootPath_IO SS_AccountRootPath_IO
- 411. Siebel CRM Primary Web Services ■ SelfServiceAllAccountsList Response See the following file to view the sample code: NOTE: You need to filter out unnecessary SELF relationship records returned in this response. ...SelfServiceAccountRootPathSelfServiceAccountRootPath_response.xml Interface Description (WSDL) for SelfServiceAccountRootPath 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. ...SelfServiceAccountRootPathSelfServiceAccountRootPath.wsdl SelfServiceAllAccountsList This Web service makes available the EAI UI business service SelfServiceAllAccountsList, which provides query operations on the integration object SS_AllAccount_List_IO. This Web service make available the Query Method in the SelfServiceAllAccountsList Business Service as Web service operation. In Siebel Self-Service Applications version 8.1, this operation is used in the context of Global Accounts - Account Hierarchy. For a given root account, this operation is used for retriving all the children accounts that are directly or indirectly related to it, including itself. SelfServiceAllAccountsList Operations For a list of operations associated with this Web service, see Table 953. Table 953. SelfServiceAllAccountsList Operations Name Description SelfServiceAllAccountsListQueryPage Performs Query operation based on the viewCriteria (contains the Root Account ID) on the instance of SS_AllAccount_List_IO provided as input. The response contains the list of accounts that are related to the root account. Request Message Description: SelfServiceAllAccountsListQueryPage For a description of this request message, see Table 954. Table 954. Request Message Description: SelfServiceAllAccountsListQueryPage Node Description Type SelfServiceAllAccountsListQueryPage_Input Container element for the QueryPage Operation request. String ListOfSSAllAccount Corresponds to an instance of SS_AllAccount_List_IO. String Siebel CRM Web Services Reference Version 8.1/8.2 411
- 412. Siebel CRM Primary Web Services ■ SelfServiceAllAccountsList Table 954. Request Message Description: SelfServiceAllAccountsListQueryPage Node Description Type ListOfSSAllAccount /SSAllAccountList Container element, which holds the Siebel CRM Web Services Reference Version 8.1/8.2 412 columns to be queried, and the criteria to be used. String ListOfSSAllAccount /SSAllAccountList Empty. String /ModId Set the Root Account ID as the view criteria. String ListOfSSAllAccount /SSAllAccountList / ParentPartyId Empty. String ListOfSSAllAccount /SSAllAccountList / RelationTypeCode ListOfSSAllAccount /SSAllAccountList / Level1AccountStatus /Level1ApprovalStatus Level1BusinessPhone Level1EmailAddress Level1FaxNumber Level1ParentPartyId Level1PartyLocation Level1PartyName Level1PriceListId Level1PrimaryAddressId Level1PrimaryBillToAddressId Level1PrimaryContactId Level1PrimaryShipToAddressId Level1Type Empty String Level2ParentAccountName Empty (Columns to be retrieved in the response) String ExecutionMode Empty String LOVLanguageMode ForwardOnly String ViewMode LDC String
- 413. Siebel CRM Primary Web Services ■ SelfServiceAllAccountsList Response Message Description: SelfServiceAllAccountsListQueryPage For a description of this response message, see Table 955. Table 955. Response Message Description: SelfServiceAllAccountsListQueryPage Node Description Type SelfServiceAllAccountsListQueryPage_Input Container element for the QueryPage Operation response. String ListOfSSAllAccount Corresponds to an instance of SS_AllAccount_List_IO. String ListOfSSAllAccount /SSAllAccountList /ModId Container element, which holds the columns to be queried, and the criteria to be used. String ListOfSSAllAccount /SSAllAccountList / ParentPartyId Empty. String ListOfSSAllAccount /SSAllAccountList /PartyId AccountId of the child account. String ListOfSSAllAccount /SSAllAccountList / RelationTypeCode Whether the child is directly or indirectly under this root account. Can be SELF, DIRECT or INDIRECT. String ListOfSSAllAccount /SSAllAccountList / Level1AccountStatus, Level1ApprovalStatus, Level1BusinessPhone, Level1EmailAddress, Level1FaxNumber, Level1PartyName, Level1PartyLocation, Level1PriceListId, Level1PrimaryAddressId, Level1PrimaryBillToAddressId, Level1PrimaryContactId, Level1PrimaryShipToAddressId, Level1Type Retrieved details of the child account. String Siebel CRM Web Services Reference Version 8.1/8.2 413
- 414. Siebel CRM Primary Web Services ■ SelfServiceAllAccountsList Table 955. Response Message Description: SelfServiceAllAccountsListQueryPage Node Description Type ListOfSSAllAccount /SSAllAccountList / Level1ParentPartyId SelfServiceAllAccountsList 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 956. Data Object (Integration Object) For a description of data objects for this Web service, see Table 957. Example Package for SelfServiceAllAccountsList To view an example of messages 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. Request See the following file to view the sample code: ...SelfServiceAllAccountsListSelfServiceAllAccountsList_request.xml Response See the following file to view the sample code: Siebel CRM Web Services Reference Version 8.1/8.2 414 Immediate Parent of this child account. For accounts with RelationTypeCode as DIRECT, it matches the root account ID itelsef. String ListOfSSAllAccount /SSAllAccountList / Level2ParentAccountName AccountName of the Immediate Parent of this child account. String Table 956. SelfServiceAllAccountsList Service Object Name Boundary Object Type Class SelfServiceAllAccountsList Business Service CSSEAIUIDataService Table 957. SelfServiceAllAccountsList Service Object Siebel Repository Name External Name SS_AllAccount_List_IO SS_AllAccount_List_IO
- 415. Siebel CRM Primary Web Services ■ SelfServiceContact ...SelfServiceAllAccountsListSelfServiceAllAccountsList_response.xml Interface Description (WSDL) for SelfServiceAllAccountsList 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. ...SelfServiceAllAccountsListSelfServiceAllAccountsList.wsdl SelfServiceContact This Web service makes available the EAI UI business service SelfServiceContact, which provides CRUD and query operations on the integration object SS_Contacts_IO. This Web service makes available the Execute and Query Methods in the SelfServiceContact business service as Web service operations. NOTE: Though most of the contact and account management activities can be performed using SelfServiceContact Web service, Siebel Self-Service Applications version 8.1 use the SelfServiceRegistration Web service, which also accepts an instance of the integration object SS_Contacts_IO. SelfServiceRegistration Web service calls the SelfServiceRegistration workflow, which delegates the integration object to SelfServiceContact business service. So, in Siebel Self-Service Applications version 8.1, SelfServiceContact Web service is mostly used for QueryPage operation. SelfServiceContact Operations For a list of operations associated with this Web service, see Table 958. Table 958. SelfServiceContact Operations Name Description SelfServiceContactExecute Calls a contact record. SelfServiceContactQueryPage Performs a query operation based on the viewCriteria and searchSpec set on the instance of SS_Contacts_IO provided as input. This operation is used in Siebel Self-Service Applications version 8.1 for querying the details of the contact, inclusive of the Personal Addresses associated to the contact. Siebel CRM Web Services Reference Version 8.1/8.2 415
- 416. Siebel CRM Primary Web Services ■ SelfServiceContact Request Message Description: SelfServiceContactExecute For a description of this request message, see Table 959. Table 959. Request Message Description: SelfServiceContactExecute Node Description Type Contact Corresponds to a record in SS_Contacts_IO. Siebel CRM Web Services Reference Version 8.1/8.2 416 Set operation accordingly. If Contact details needs to be updated, or if child elements such as Personal Address are present, the Update operation. Otherwise, set the operation to SkipNode. String Contact /Id ID of the Contact. Set this if the mode on Contact node is Update or SkipNode. String Contact /ListOfAccount Container element for the assigned accounts of this contact. If the mode on Contact is insert, then the accounts specified in this list are inserted and assigned to the newly created contact. If the mode on Contact is skipnode, then accounts specified in this list are made as the only accounts assigned for this contact. All other existing assigned accounts are unassigned by default. String Contact /ListOfAccount/ Account Contact account String Contact /ListOfAccount/ Account/ Details of the assigned account. String Name, PrimaryContactId, Type Contact/ ListOfContactCommunicationAddress Contact address. String Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / AlternateEmailAddress Alternate email address value to be edited or created. String Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / CommunicationAddressId ID of the alternate email address value to be edited; blank for adding new alternate email address. String
- 417. Siebel CRM Primary Web Services ■ SelfServiceContact Response Message Description: SelfServiceContactExecute For a description of this response message, see Table 960. Table 960. Response Message Description: SelfServiceContactExecute Node Description Type SelfServiceContactExecute_Output Container element for the Execute Operation request. ListOfSSContact Corresponds to an instance of SS_Contacts_IO. ListOfSSContact/Contact/Id, ModId ID and ModId of Inserted, or Updated Contact Record. ListOfSSContact/Contact/ListOfAccount/ Account/Id, Mod Id ID and ModId of Inserted, or Updated Account Record. ListOfSSContact/Contact/ ListOfCommunicationAddress/ CommunicationAddress/Id, Mod Id ID and ModId of Inserted, or Updated CommunicationAddress Record. Request Message Description: SelfServiceContactQueryPage For a description of this request message, see Table 961. Complex Type View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentatio n library. String String String Table 961. Request Message Description: SelfServiceContactQueryPage Node Description Type SelfServiceContactQueryPage_Input Container element for the QueryPage Operation request. Complex Type ListOfSSContact Corresponds to an instance of SS_Contacts_IO. View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library. Siebel CRM Web Services Reference Version 8.1/8.2 417
- 418. Siebel CRM Primary Web Services ■ SelfServiceContact Table 961. Request Message Description: SelfServiceContactQueryPage Node Description Type ListOfSSContact/Contact Set contact information. Complex Type Contact/ Id Set the ID of the Contact as a Siebel CRM Web Services Reference Version 8.1/8.2 418 ViewCriteria. View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library. Contact/ ModId Retrieve and pass back while updating, to make sure that Contact record is not updated in the interim. Complex Type Contact/ FirstName, MiddleName, LastName, Status, EmailAddress, CellularPhone, HomePhone, FaxPhone, WorkPhone, TimeZoneId, EmailSRUpdatesFlag, SendPromotions Empty (Columns to be retrieved). View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library. Contact/ LoginName, ApprovalStatus, ChallengeQuestion, ChallengeAnswer Empty (Columns to be retrieved). These columns are related to the username information. String Contact/ PrimaryAccountName, PrimaryAddressId, PrimaryAddressName PrimaryPersonalAddressId Empty (Columns to be retrieved). String Contact/ ListOfContactCommunicationAddress Container element for the AlternateEmailAddress to be retrieved. Contact can have similar subnodes for querying PersonalAddress, Account and AccountBusinessAddress. String
- 419. Siebel CRM Primary Web Services ■ SelfServiceContact Table 961. Request Message Description: SelfServiceContactQueryPage Node Description Type Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress Contact communications address. String Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / AlternateEmailAddress Empty (Columns to be retrieved). Alternate Email Address of the contact. Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / CommunicationAddressId Empty (Columns to be retrieved). ID of the Alternate Email Address of the contact. ExecutionMode ForwardOnly. View the WSDL by LOVLanguageMode LDC. String ViewMode All. Complex Type Response Message Description: SelfServiceContactExecute For a description of this response message, see Table 962. String Complex Type clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library. Table 962. Response Message Description: SelfServiceContactExecute Node Description Type SelfServiceContactQueryPage_Output Container element for the QueryPage Operation response. Complex Type ListOfSSContact Corresponds to an instance of SS_Contacts_IO. View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library. Siebel CRM Web Services Reference Version 8.1/8.2 419
- 420. Siebel CRM Primary Web Services ■ SelfServiceContact Table 962. Response Message Description: SelfServiceContactExecute Node Description Type ListOfSSContact/Contact Set contact information. Complex Type Contact/ Id ID of the Contact being queried. View the WSDL Siebel CRM Web Services Reference Version 8.1/8.2 420 by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library. Contact/ ModId Container element for the QueryPage Operation response. Complex Type Contact/ FirstName, MiddleName, LastName, Status, EmailAddress, CellularPhone, HomePhone, FaxPhone, WorkPhone, TimeZoneId, EmailSRUpdatesFlag, SendPromotions Primitive details of the contact. EmailSRUpdatesFlag and SendPromotions contain the preferences shown in Siebel Self- Service Applications version 8.1 Registration screens. View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library. Contact/ LoginName, ApprovalStatus, ChallengeQuestion, ChallengeAnswer These nodes contain the values for the username information. String Contact/ PrimaryAccountName, PrimaryAddressId, PrimaryAddressName PrimaryPersonalAddressId These nodes contain the values for the PrimaryAccountName, Primary BusinAddressId, Primary BusinessAddressName and PrimaryPersonalAddressId respectively. String Contact/ ListOfContactCommunicationAddress Container element for the AlternateEmailAddress retrieved. String Contact / ListOfContactCommunicationAddress / ContactCommunicationAddress Email address of the contact. String Contact / ListOfContactCommunicationAddress / ContactCommunicationAddress / AlternateEmailAddress Alternate email address of the contact. String
- 421. Siebel CRM Primary Web Services ■ SelfServiceContact Table 962. Response Message Description: SelfServiceContactExecute Node Description Type Contact / ListOfContactCommunicationAddress / ContactCommunicationAddress / CommunicationAddressId ID of the alternate email address of the contact. Complex Type ExecutionMode ForwardOnly. View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library. LOVLanguageMode LDC. String ViewMode All. Complex Type SelfServiceContact 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 963. Table 963. SelfServiceContact Service Object Name Boundary Object Type Class SelfServiceContact BusinessService CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service, see Table 964. Table 964. SelfServiceContact Data Object Siebel Repository Name External Name SS_Contacts_IO SS_Contacts_IO Siebel CRM Web Services Reference Version 8.1/8.2 421
- 422. Siebel CRM Primary Web Services ■ SelfServicePaymentHistory Example Package for SelfServiceContact To view an example of messages 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. Request (SelfServiceContactQueryPage) See the following file to view the sample code: ...SelfServiceContactSelfServiceContactQueryPage_request.xml Response (SelfServiceContactQueryPage) See the following file to view the sample code: ...SelfServiceContactSelfServiceContactQueryPage_request.xml Request (SelfServiceContactExecute) See the following file to view the sample code: ...SelfServiceContactSelfServiceContactExecute_request.xml Response (SelfServiceContactExecute) See the following file to view the sample code: ...SelfServiceContactSelfServiceContactExecute_request.xml Interface Description (WSDL) for SelfServiceContact 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. ...SelfServiceContactSelfServiceContact.wsdl SelfServicePaymentHistory This Web service queries the Payment History details as specified by the search criteria for any contact logged into the application. Payment details like Payment type, Payment profile, transaction amount, type and date for different orders against which the payment was made by a contact can be queried. Siebel CRM Web Services Reference Version 8.1/8.2 422
- 423. Siebel CRM Primary Web Services ■ SelfServicePaymentHistory SelfServicePaymentHistory Operations For a list of operations associated with this Web service, see Table 965. Table 965. SelfServicePaymentHistory Operations Name Description SelfServicePaymentHistoryQueryPage Performs query operations set on the SS_PaymentHistory_IO Integration Object as the input.this method is used for querying the payment details for different orders performed by a contact. Request Message Description: SelfServicePaymentHistoryQueryPage Based on the query criteria set on the integration object, payment related details like the payment profile details, transaction amount, type and date along with the order numbers can be queried. For a description of this request message, see Table 966. Table 966. Request Message Description: SelfServicePaymentHistoryQueryPage Node Description Type SelfServicePaymentHistory QueryPage_Input The method arguments are Payment Integration Object, Language Mode (value is LDC) and viewMode (All). Integration Object Response Message Description: SelfServicePaymentHistoryQueryPage The response contains the details based on the query set on the Payment Integration Object. For a description of this response message, see Table 967. Table 967. Response Message Description: SelfServicePaymentHistoryQueryPage Node Description Type SelfServicePaymentHistoryQueryPage_Output Integration Object The retrieved data for the query performed. SelfServicePaymentHistory Application Interface This Web service makes available the EAI UI business service SelfServicePaymentHistory, which provides update and query operations on the integration object SS_PaymentHistory_IO. For more information on application implementation, refer to your application development documentation on Oracle Technology Network. Siebel CRM Web Services Reference Version 8.1/8.2 423
- 424. Siebel CRM Primary Web Services ■ SelfServicePostLoginProcess Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 968. Table 968. SelfServicePaymentHistory Service Object Name Boundary Object Type Class SelfServicePaymentHistory Integration Object CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service, see Table 969. Table 969. SelfServicePaymentHistory Data Object Siebel Repository Name External Name SS_PaymentHistory_IO Payments Example Package for SelfServicePaymentHistory To view an example of messages 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. Request See the following file to view the sample code: ...SelfServicePaymentHistorySelfServicePaymentHistoryRequest.xml Response See the following file to view the sample code: ...SelfServicePaymentHistorySelfServicePaymentHistoryResponse.xml Interface Description (WSDL) for SelfServicePaymentHistory 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. ...SelfServicePaymentHistorySelfServicePaymentHistory.wsdl SelfServicePostLoginProcess This Web service makes available the SelfServicePostLoginProcess workflow as LoadUserDetails operation. The response of this Web service is determined by the P_Mode request parameter, as displayed in Table 970. Siebel CRM Web Services Reference Version 8.1/8.2 424
- 425. Siebel CRM Primary Web Services ■ SelfServicePostLoginProcess P_Mode Request Parameter For a description of the P_Mode request parameter, see Table 970. Table 970. P_Mode Request Parameter P_Mode Response OnlyLoadResponsibilities Returns only the responsibilities for the given user name. SkipLoadResponsibilities Returns only the contact details for the given user name. LoadEverything Returns both the contact details and responsibilities for the given user name. SelfServicePostLoginProcess Operations For a list of operations associated with this Web service, see Table 971. Table 971. SelfServicePostLoginProcess Operations Name Description LoadUserDetails This operation triggers the SelfServicePostLoginProcess workflow. Request Message Description: LoadUserDetails For a description of this request message, see Table 972. Table 972. Request Message Description: LoadUserDetails Node Description Type P_Mode For a description, see Table 970. String ListOfSSContact An SS_Contact_IO instance, where in ListOfSSContact/Contact/LoginName contains the username of the user for whom the details need to be retrieved. Integration Object P_LoginName Refer to the SelfServiceContact.doc for the details on ListOfContact and its subnodes. String Siebel CRM Web Services Reference Version 8.1/8.2 425
- 426. Siebel CRM Primary Web Services ■ SelfServicePostLoginProcess Table 972. Request Message Description: LoadUserDetails Node Description Type getUserResponsibilitiesResponse Username of the user for whom the details Response Message Description: LoadUserDetails For a description of this response message, see Table 973. Siebel CRM Web Services Reference Version 8.1/8.2 426 need to be retrieved. Complex Type getUserResponsibilitiesResponse / listOfUserResponsibilities/ Container element for Responsibilities. Maps to an instance of getUserResponsibilitiesResponse integration object. View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentati on library. Table 973. Response Message Description: LoadUserDetails Node Description Type LoadUserDetails_Output Container element for the LoadUserDetails operation response. Complex Type ListOfSSContact An SS_Contact_IO instance, where in ListOfSSContact/Contact/Id contains the contactId of the user for whom the details are retrieved. View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documenta tion library. getUserResponsibilitiesResponse Refer to the SelfServiceContact.doc for the other nodes in ListOfContact and its complex subnodes, like Account and PersonalAddress, which will have the retrieved accounts(assigned) and PersonalAddress of the contact respectively. Complex Type
- 427. Siebel CRM Primary Web Services ■ SelfServicePostLoginProcess Table 973. Response Message Description: LoadUserDetails Node Description Type getUserResponsibilitiesResponse / listOfUserResponsibilities/ userResponsibilities/ responsibilityValue Will be blank when mode is SkipLoadResponsibilities. View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documenta tion library. Error_spcCode Name of the Responsibility. Complex Type Error_spcMessage Error Code returned by the Workflow. View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documenta tion library. SelfServicePostLoginProcess 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. Siebel CRM Web Services Reference Version 8.1/8.2 427
- 428. Siebel CRM Primary Web Services ■ SelfServicePostLoginProcess Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 974. Table 974. SelfServicePostLoginProcess Service Object Name Boundary Object Type SelfServicePostLoginProcess Workflow Data Object (Integration Object) For a description of data objects for this Web service, see Table 975. Table 975. SelfServicePostLoginProcess Data Object Siebel Repository Name External Name SelfServiceContact SelfServiceContact getUserResponsibilitiesResponse getUserResponsibilitiesResponse Example Package for SelfServicePostLoginProcess To view an example of messages 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. Request (LoadUserDetails_OnlyLoadResponsibilities) See the following file to view the sample code: ...SelfServicePostLoginProcessLoadUserDetails_OnlyLoadResponsibilities_request.xml Response(LoadUserDetails_OnlyLoadResponsibilities) See the following file to view the sample code: ...SelfServicePostLoginProcessLoadUserDetails_OnlyLoadResponsibilities_response.xml Request (LoadUserDetails_SkipLoadResponsibilities) See the following file to view the sample code: ...SelfServicePostLoginProcessLoadUserDetails_SkipLoadResponsibilities_request.xml Response (LoadUserDetails_SkipLoadResponsibilities) See the following file to view the sample code: ...SelfServicePostLoginProcessLoadUserDetails_SkipLoadResponsibilities_response.xml Siebel CRM Web Services Reference Version 8.1/8.2 428
- 429. Siebel CRM Primary Web Services ■ SelfServiceRegistration Interface Description (WSDL) for SelfServicePostLoginProcess 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. ...SelfServicePostLoginProcessSelfServicePostLoginProcess.wsdl SelfServiceRegistration The Enroll operation of this Web service invokes the SelfServiceRegistration workflow, which internally uses the business services listed below to manage contacts, assigned accounts, assigned personal, or business addresses, create user names, manage assigned responsibilities, send welcome or password update notifications and create Inbox Items to simulate pending registration approvals. Activity of the workflow is determined by the P_mode input parameter passed to this Web service operation. P_Mode Request Parameter For a description of the P_Mode request parameter, see Table 976. Table 976. P_Mode Request Parameter P_Mode Response CreateContact Used for creating a contact without a username. Used in Siebel Self-ServiceSelf-Service Applications version 8.1 for contact creation in the Contacts, Administration screen, and other usages in the Contacts, Profile, and the Contacts, Account views. UpdateContact Used for updating a contact without a username. Used in Siebel Self-Service Applications version 8.1 in the Contacts, Administration screen, and the Contacts, Profile, and Contacts , Account views. Also used for Personal Info updating from Contacts, Profile view. CreateUser Creates a new contact, and a username in the associated LDAP directory, then assigns responsibilities, sends a welcome a notification to the user, and then creates an inbox item for the administrator, if approval is needed. Need to pass the Usertype details (like approval required), notification template, inbox and approval types, when the mode is CreateUser. Used in Siebel Self-Service Applications version 8.1 for making a contact as a user in the Contacts - Administration screen. Also used for all self-service registrations. Siebel CRM Web Services Reference Version 8.1/8.2 429
- 430. Siebel CRM Primary Web Services ■ SelfServiceRegistration Table 976. P_Mode Request Parameter P_Mode Response UpdateUser Used for updating a contact with a username and manage the assigned SelfServiceRegistration Operations For a list of operations associated with this Web service, see Table 977. Business Services Called by Enroll Operation The following business services are called by the Enroll operation: ■ EAITransactionService Business Service on page 431 ■ SelfServiceContact Business Service on page 431 ■ PRM ANI Utility Service Business Service on page 433 ■ PRM ANI Utility Service Business Service on page 433 ■ SiebelWebRegistrationService Business Service on page 434 ■ Self-Service User Business Service on page 435 ■ EAITransactionService Business Service on page 436 ■ ISS Approval Bus Service Business Service on page 437 ■ Outbound Communications Manager Business Service on page 438 ■ SessionAccessService Business Service on page 438 Siebel CRM Web Services Reference Version 8.1/8.2 430 accounts and responsibilities. Used in Siebel Self-Service Applications version 8.1 in the Contacts - Administration screen to update user information. ResetPasswordOnly Used for resetting the password of the currently logged in user of the Siebel application session or in the anonymous session. Also used in Forgot Password Flow (for an anonymous session). Table 977. SelfServiceRegistration Operations Name Description Enroll Internally calls the business services listed below.
- 431. Siebel CRM Primary Web Services ■ SelfServiceRegistration EAITransactionService Business Service For a description of this business service, see Table 978. Table 978. EAITransactionService Business Service EAITransactionService Business Service Begin Transaction Step SelfServiceContact Business Service For a description of this business service, see Table 979. Siebel CRM Web Services Reference Version 8.1/8.2 431 Business Service Name EAITransactionService Business Service Method Begin Transaction Description This step is used to initiate a transaction. BeginTransaction will not take any parameters as input. Table 979. Self-ServiceSelf-Service Contact Business Service SelfServiceContact Business Service Step Create, and update contact and account records Business Service Name SelfServiceContact Business Service Method Execute Input Arguments Argument Name Type Property Name SiebelMessageIn Process Property P_ContactIO(SS_Contacts_IO) ViewMode Process Property All LanguageMode Process Property LDC ExecutionMode Process Property BiDirectional Output Arguments Argument Name Type Property Name
- 432. Siebel CRM Primary Web Services ■ SelfServiceRegistration Table 979. Self-ServiceSelf-Service Contact Business Service SelfServiceContact SiebelMessageOut Output Argument P_ContactIO(SS_Contacts_IO) Description This step is used to create or update Contact, Account, Contact Address, Siebel CRM Web Services Reference Version 8.1/8.2 432 Contact_Account relationships and Alternate Communication Address. The Contact integration object with appropriate action specified at the request elements is prepared in the java layer and passed as a Process Property to the workflow. This step executes an EAIUI Service to execute the operations specified at each step in the integration object and returns a ContactIO with the ids specified for each step. Sample SOAP request portions of SS_Contacts_IO are shown below.
- 433. Siebel CRM Primary Web Services ■ SelfServiceRegistration PRM ANI Utility Service Business Service For a description of this business service, see Table 980. Table 980. PRM ANI Utility Service Business Service PRM ANI Utility Service Business Service Retrieve Contact ID Step PRM ANI Utility Service Business Service For a description of this business service, seeTable 981. Siebel CRM Web Services Reference Version 8.1/8.2 433 Business Service Name PRM ANI Utility Service Business Service Method GetProperty Input Arguments Argument Name Type Property Name Hierarchy Path: Literal Contact Property Name Literal ID SiebelMessage Hierarchy P_ContactIO(SS_Contacts_IO) Output Arguments Argument Name Type Property Name Property Value Output Argument P_ContactId Description This step is used to retrieve the contact ID, given the contact IO. In Siebel Self-Service Applications version 8.1, this step is only applicable during the Register your company flow to retrieve the ID of the newly created corporate account, which is then sent to Trigger Approval, and established as the root account. Hence, the caller (java API that calls the proxy) shall ignore the errors reported by this step. Table 981. PRM ANI Utility Service Business Service PRM ANI Utility Service Business Service Step Retrieve Account ID (called only when accountId Process Property is null) Business Service Name PRM ANI Utility Service Business Service Method GetProperty
- 434. Siebel CRM Primary Web Services ■ SelfServiceRegistration Table 981. PRM ANI Utility Service Business Service PRM ANI Utility Service SiebelWebRegistrationService Business Service For a description of this business service, see Table 982. Siebel CRM Web Services Reference Version 8.1/8.2 434 Input Arguments Argument Name Type Property Name Hierarchy Path: Literal Contact Property Name Literal Account ID SiebelMessage Hierarchy P_ContactIO (SS_Contacts_IO) Output Arguments Argument Name Type Property Name Property Value Output Argument AccountId Description This step is used to retrieve the account ID, given the contact IO. In Siebel Self-Service Applications version 8.1, this step is only applicable during the Register your company flow to retrieve the ID of the newly created corporate account, which is then sent to Trigger Approval, and established as the root account. Hence, the caller (java API that calls the proxy) shall ignore the errors reported by this step. Table 982. SiebelWebRegistrationService Business Service SiebelWebRegistrationService Business Service Create User Step Business Service Name SiebelWebRegistrationService Business Service Method Promote Input Arguments Argument Name Type Property Name Contactid Process Property P_ContactId Type Process Property P_Usertype Proxy User Process Property P_ProxyEmpLoginName LoginName Process Property P_LoginName Password Process Property P_NewPassword securityQuestion Process Property P_ChallengeQuestion
- 435. Siebel CRM Primary Web Services ■ SelfServiceRegistration Table 982. SiebelWebRegistrationService Business Service SiebelWebRegistrationService securityAnswer Process Property P_ChallengeAnswer Output Arguments Argument Name Type Property Name SuccessCode Output Argument P_CreateUserStatus ErrorMessage Output Argument Error Message Description This step executes the SiebelWebRegistrationService business service to create a Web_User for the given contactid. The business service needs to create Web Channel User of Web User Type, LDAP user record, S_USER record and also update the security question and answer. Self-Service User Business Service For a description of this business service, see Table 983. Table 983. Self-Service User Business Service Self-Service User Business Service Step Assign Responsibilities Siebel CRM Web Services Reference Version 8.1/8.2 435 Business Service Name SelfServiceUser Business Service Method Execute Input Arguments Argument Name Type Property Name SiebelMessageIn Process Property P_UserIO ViewMode Process Property All LanguageMode Process Property LDC Output Arguments Argument Name Type Property Name SiebelMessageOut Output Argument P_UserIO Description This step is used to create the responsibilities in the Siebel database. It uses a new EAIUI Service named SelfServiceUser that creates the S_PER_RESP records for the given user ID and the responsibility ID.
- 436. Siebel CRM Primary Web Services ■ SelfServiceRegistration EAITransactionService Business Service For a description of this business service, see Table 984. Table 984. EAITransactionService Business Service EAITransactionService Business Service Step Siebel CRM Web Services Reference Version 8.1/8.2 436 Commit Transaction Business Service Name EAITransactionService Business Service Method EndTransaction Input Arguments Argument Name Type Property Name Is Abort Literal False Description This step uses EAITransactionService. EndTransaction to commit the transaction. The parameter Is Abort need be set to False to commit the transaction.
- 437. Siebel CRM Primary Web Services ■ SelfServiceRegistration ISS Approval Bus Service Business Service For a description of this business service, see Table 985. Table 985. ISS Approval Bus Service Business Service ISS Approval Bus Service Business Service Trigger Approval Step Siebel CRM Web Services Reference Version 8.1/8.2 437 Business Service Name ISS Approval Bus Service Business Service Method CreateNewApprovalTasks Input Arguments Argument Name Type Property Name RequestingBusComp Literal Value = Contact Approval Item ID Process Property P_ContactId Approval Level Name Process Property P_UsertypeApprovalType Inbox Type Process Property P_UsertypeInboxType Approval Level Context Process Property P_AccountId Description This step uses ISS Approval Bus Service. CreateNewApprovalTasks business service method to create new Inbox Items based on the Inbox Type and Approval Types specified. This step is executed only if approval is required by the user type, based on the P_UsertypeApprovalRequd process property. Note that P_AccountId contains the root account of the corporate account under which the contact, or user is being created. Hence, for newly created corporate account (Register your company flow), P_AccountId is set to the ID of the newly created account. For more information, see Siebel Self-Service Application Developer’s Guide.
- 438. Siebel CRM Primary Web Services ■ SelfServiceRegistration Outbound Communications Manager Business Service For a description of this business service, see Table 986. Table 986. Outbound Communications Manager Business Service Outbound Communications Manager Business Service Step SessionAccessService Business Service For a description of this business service, see Table 987. Siebel CRM Web Services Reference Version 8.1/8.2 438 Trigger Notification Business Service Name Outbound Communications Manager Business Service Method CreateRequest Input Arguments Argument Name Type Property Name RecipientBusComp Literal Not applicable SourceIdList Process Property P_ContactId PackageNameList Process Property P_NotificationTemplateName RequestLanguageCode Process Property P_Language RequestLocaleCode Process Property P_Locale ProcessMode Literal Not applicable RequestName Literal Not applicable RecipientGroup Process Property Not applicable Description This step is used to trigger the notification based on the notification template specified, using the Outbound Communications Manager. CreateRequest. This business service method substitutes the necessary values from the Contact business component which is loaded for the ID specified. For more information, see Siebel Self-Service Application Developer’s Guide. Table 987. SessionAccessService Business Service SessionAccessService Business Service Step Set new password in Siebel session Business Service Name SessionAccessService
- 439. Siebel CRM Primary Web Services ■ SelfServiceRegistration Table 987. SessionAccessService Business Service SessionAccessService Response Message Description: CreateContact For a description of this business service, see Table 988. Siebel CRM Web Services Reference Version 8.1/8.2 439 Business Service Method SetProfileAttr Input Arguments Argument Name Type Property Name Name Literal Not applicable Value Process Property P_NewPassword PackageNameList Process Property P_NotificationTemplateName RequestLanguageCode Process Property P_Language RequestLocaleCode Process Property P_Locale ProcessMode Literal Not applicable RequestName Literal Not applicable RecipientGroup Process Property Not applicable Description This step is used to set the password in a Siebel CRM session. For more information, see Siebel Self-Service Application Developer’s Guide. Table 988. Response Message Description: CreateContact Node Description Type Process_spcInstance_spcId Not of consequence in response. String Object_spcId Not of consequence in response. String Siebel_spcOperation_spcObject_spcId Not of consequence in response. String Error_spcCode Not of consequence in response. String Error_spcMessage Not of consequence in response. String ListOfSSContact Contains an instance of the output integration object SS_Contacts_IO that holds the ID and ModId of the contact, and or account that is created or updated. See “SelfServiceContact” on page 415 for more information on the Structure and subnodes of ListOfSSContact. Maps to the P_ContactIO process property in the workflow. Integration Object P_ContactId Not of consequence in response. String
- 440. Siebel CRM Primary Web Services ■ SelfServiceRegistration Table 988. Response Message Description: CreateContact Node Description Type P_AccountId Derived Root Account ID Siebel CRM Web Services Reference Version 8.1/8.2 440 For more information, see Siebel Self- Service Application Developer’s Guide on the Siebel Bookshelf. String P_DefaultOrgId Not of consequence in response. String P_Mode Not of consequence in response. String P_Usertype Not of consequence in response. String P_LoginName Username created String P_DefaultProxyEmployee Not of consequence in response. String P_LoginId Value returned by SiebelWebRegistration business service. String P_CreateUserStatus The status set on the newly created user. Inactive, for pending users. String P_Password Not of consequence in response. String P_NewPassword Not of consequence in response. String P_ChallengeQuestion Not of consequence in response. String P_ChallengeAnswer Not of consequence in response. String ListOfSSUser Contains an instance of the input integration object Users that holds the ID and Mode ID of the user-responsibility mapping for the updated responsibility assignments. See “SelfServiceUser” on page 452 for more information on the structure and subnodes of ListOfSSUser. Maps to the P_UserIO process property in the workflow. Integration Object P_UsertypeApprovalRequd Not of consequence in response. String P_UsertypeApprovalType Not of consequence in response. String P_UsertypeInboxType Not of consequence in response. String P_UsertypeNotifTemplateName Not of consequence in response. String P_RecipientGroup Not of consequence in response. String P_Language Not of consequence in response. String P_Locale Not of consequence in response. String
- 441. Siebel CRM Primary Web Services ■ SelfServiceRegistration Self-Service Registration 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 989. Table 989. Self-Service Registration Service Object Name Boundary Object Type SelfServiceRegistration Workflow Data Object (Integration Object) For a description of data objects for this Web service, see Table 990. Table 990. Self-Service Registration Data Object Siebel Repository Name External Name SelfServiceContact SelfServiceContact Users Users Example Package for SelfServiceRegistration To view an example of messages 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. Request and Response Samples are provided for the following scenarios: 1 Create a B2C contact and a user name and trigger notification. 2 Create a B2B contact as Inactive and create a user name and trigger notification and create Inbox Siebel CRM Web Services Reference Version 8.1/8.2 441 Items for approval. 3 Update Personal addresses of an existing Contact. 4 Update Contact details, Account Assignments, Responsibility Assignments, Password resetting for an existing contact. Request Create a B2C contact and user name and trigger notification. See the following file to view the sample code: ...SelfServiceRegistrationSelfServiceRegistration_1_request.xml
- 442. Siebel CRM Primary Web Services ■ SelfServiceRegistration Response Create a B2C contact and user name and trigger notification. See the following file to view the sample code: ...SelfServiceRegistrationSelfServiceRegistration_1_request.xml Request Create a B2B contact as Inactive and create a user name and trigger notification and create Inbox Items for approval. See the following file to view the sample code: ...SelfServiceRegistrationSelfServiceRegistration_2_request.xml Response Create a B2B contact as Inactive and create a user name and trigger notification and create Inbox Items for approval. See the following file to view the sample code: ...SelfServiceRegistrationSelfServiceRegistration_2_response.xml Request Update Personal Addresses of an existing contact. See the following file to view the sample code: ...SelfServiceRegistrationSelfServiceRegistration_3_request.xml Response Update Personal Addresses of an existing contact. See the following file to view the sample code: ...SelfServiceRegistrationSelfServiceRegistration_3_response.xml Request Update Contact Details, Account Assignment, Responsibility Assignment, Password resetting for an existing contact. See the following file to view the sample code: ...SelfServiceRegistrationSelfServiceRegistration_4_request.xml Response Update Contact Details, Account Assignment, Responsibility Assignment, Password resetting for an existing contact See the following file to view the sample code: Siebel CRM Web Services Reference Version 8.1/8.2 442
- 443. Siebel CRM Primary Web Services ■ SelfServiceResponsibility ...SelfServiceRegistrationSelfServiceRegistration_4_response.xml Interface Description (WSDL) for SelfServiceRegistration 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. ...SelfServiceRegistrationSelfServiceRegistration.wsdl SelfServiceResponsibility This Web service makes available the EAI UI business service SelfServiceResponsibility, which provides a query operation on the integration object SS_Responsibility_IO. Additionally, this Web service makes available the Query Method in the SelfServiceResponsibility business service as a Web service operation. SelfServiceResponsibility Operations For a list of operations associated with this Web service, see Table 991. Table 991. SelfServiceResponsibility Operations Name Description SelfServiceResponsibilityQueryPage Performs Query operation based on the view criteria and search specification set on the instance of SS_Responsibility_IO provided as input. This operation is used in Siebel Self-Service Applications version 8.1 for retrieving the ID and Name of Web Enabled Responsibilities. Request Message Description: SelfServiceResponsibilityQueryPage For a description of this request message, see Table 992. Table 992. Request Message Description: SelfServiceResponsibilityQueryPage Node Description SelfServiceResponsibilityQuery Page_Input Container element for SelfServiceResponsibility Web service input for QueryPage operation. ListOfSSResponsibility Container element for the list of SS_Responsibility_IO. Corresponds to an SS_Responsibility_IO integration object. Siebel CRM Web Services Reference Version 8.1/8.2 443 ListOfSSResponsibility/ Responsibility Corresponds to the primary integration component Responsibility. ListOfSSResponsibility/ Responsibility/AccessType Set to Yes, for retrieving only Web Enabled Responsibilities.
- 444. Siebel CRM Primary Web Services ■ SelfServiceResponsibility Table 992. Request Message Description: SelfServiceResponsibilityQueryPage Node Description ListOfSSResponsibility/ Responsibility/Id Response Message Description: SelfServiceResponsibilityQueryPage For a description of this response message, see Table 993. SelfServiceResponsibility 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 994. Siebel CRM Web Services Reference Version 8.1/8.2 444 Empty; Placeholder for the ID of the responsibility to be retrieved. ListOfSSResponsibility/ Responsibility/Name Empty; Placeholder for the name of the responsibility to be retrieved. Table 993. Response Message Description: SelfServiceResponsibilityQueryPage Node Description SelfServiceResponsibilityQueryPage_Output Container element for SelfServiceResponsibility Web service output for QueryPage operation. ListOfSSResponsibility Container element for the list of SS_Responsibility_IO. Corresponds to an SS_Responsibility_IO integration object. ListOfSSResponsibility/Responsibility Corresponds to the primary Integration component Responsibility. ListOfSSResponsibility/Responsibility/ AccessType Yes for Web Enabled Responsibility. ListOfSSResponsibility/Responsibility/Id Retrieved ID of the responsibility. ListOfSSResponsibility/Responsibility/Name Retrieved name of the responsibility. Table 994. SelfServiceResponsibility Service Object Name Boundary Object Type Class SelfServiceResponsibility Business Service CSSEAIUIDataService
- 445. Siebel CRM Primary Web Services ■ SelfServiceSmtpEmail Data Object (Integration Object) For a description of data objects for this Web service, see Table 995. Table 995. SelfServiceResponsibility Data Object Siebel Repository Name External Name SS_Responsibility_IO SS_Responsibility_IO Example Package for SelfServiceResponsibility To view an example of messages 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. Request See the following file to view the sample code: ...SelfServiceResponsibilitySelfServiceResponsibility_request.xml Response See the following file to view the sample code: ...SelfServiceResponsibilitySelfServiceResponsibility_response.xml Interface Description (WSDL) for SelfServiceResponsibility 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. ...SelfServiceResponsibilitySelfServiceResponsibility.wsdl SelfServiceSmtpEmail The SendSmtpEmail operation of this Web service invokes the SelfServiceSmtpEmail workflow, which internally uses the Outbound Communications Manager business service for sending non-template based SMTP email. SelfServiceSmtpEmail Operations For a list of operations associated with this Web service, see Table 996. Table 996. SelfServiceSmtpEmail Operations Name Description SendSmtpEmail Invokes the SelfServiceSmtpEmail workflow. Siebel CRM Web Services Reference Version 8.1/8.2 445
- 446. Siebel CRM Primary Web Services ■ SelfServiceSmtpEmail Request Message Description: SendSmtpEmail For a description of this request message, see Table 997. Table 997. Request Message Description: SendSmtpEmail Node Description Type FromAddress Email address of the sender. String MessageToList Semicolon-separated list of email addresses for the TO line. String MessageCCList Semicolon-separated list of email addresses for the CC line. String MessageBCCList Semicolon-separated list of email addresses for the BCC Response Message Description: SendSmtpEmail For a description of this response message, see Table 998. Siebel CRM Web Services Reference Version 8.1/8.2 446 line. String MessageSubject Descriptive subject line for the message. String MessageBody Message content in plain-text. String MessageHTMLBody Message content in HTML. This parameter when specified would override the parameter MessageBody. String Error Code Error code, if any. String Error Message Error message, if any. String Object Id Object ID. String Process Instance Id ID of process instance. String Siebel Operation Object Id ID of Siebel operation. String Table 998. Response Message Description: SendSmtpEmail Node Description Type FromAddress Not of consequence in response. String MessageToList Not of consequence in response. String MessageCCList Not of consequence in response. String MessageBCCList Not of consequence in response. String MessageSubject Not of consequence in response. String MessageBody Not of consequence in response. String MessageHTMLBody Not of consequence in response. String Error Code Error code, if any, for exceptions raised while submitting the request. This is automatically set from the workflow. String Error Message Error details, if any, for exceptions raised while submitting the request. This is automatically set from the workflow. String
- 447. Siebel CRM Primary Web Services ■ SelfServiceSmtpEmail Table 998. Response Message Description: SendSmtpEmail Node Description Type Object Id Standard WF Output. String Process Instance Id Standard WF Output. String Siebel Operation Standard WF Output. String Object Id SelfServiceSmtpEmail 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 999. Table 999. SelfServiceSmtpEmail Service Object Name Boundary Object Type SelfServiceSmtpEmail Workflow Process Example Package for SelfServiceSmtpEmail To view an example of messages 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. Request See the following file to view the sample code: ...SelfServiceSmtpEmailSelfServiceSmtpEmail_request.xml Response See the following file to view the sample code: ...SelfServiceSmtpEmailSelfServiceSmtpEmail_response.xml Interface Description (WSDL) for SelfServiceSmtpEmail 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. ...SelfServiceSmtpEmailSelfServiceSmtpEmail.wsdl Siebel CRM Web Services Reference Version 8.1/8.2 447
- 448. Siebel CRM Primary Web Services ■ SelfServiceTemplateEmail SelfServiceTemplateEmail The SendTemplateEmail operation of this Web Service invokes the SelfServiceTemplateEmail workflow, which internally uses the Outbound Communications Manager business service for sending template based SMTP email. SelfServiceTemplateEmail Operations For a list of operations associated with this Web service, see Table 1000. Table 1000.SelfServiceTemplateEmail Operations Name Description SendTemplateEmail Invokes the SelfServiceTemplateEmail workflow. Request Message Description: SendTemplateEmail For a description of this request message, see Table 1001. Table 1001.Request Message Description: SendTemplateEmail Node Description Type TemplateName The communication template name to be used in the Siebel CRM Web Services Reference Version 8.1/8.2 448 request. String SourceRecipientGroupName The source recipient group name. Either the name of Siebel-seeded recipient group or a custom one. String SourceObjectID ROW_ID of the source object component of the recipient group. This would determine the data retrieved for processing the template and recipient address for the email. String TemplateLanguageCode Language code the template. A template must exist with the name and language combination specified. Defaulting is not recommended. String TemplateLocaleCode Locale code the template. A template must exist with the name and locale combination specified. Defaulting is not recommended. String RequestName An optional string that would help trace the outbound communication requests at the server side. String RequestStatus Status code for the outbound request placed. String Error Code None String Error Message None String Object Id None String
- 449. Siebel CRM Primary Web Services ■ SelfServiceTemplateEmail Table 1001.Request Message Description: SendTemplateEmail Node Description Type Process Instance Id None String Siebel Operation Object Id None String Response Message Description: SendTemplateEmail For a description of this response message, see Table 1002. Table 1002.Response Message Description: SendTemplateEmail Node Description Type TemplateName Not of consequence in response. String SourceRecipientGroupName Not of consequence in response. String SourceObjectID Not of consequence in response. String TemplateLanguageCode Not of consequence in response. String TemplateLocaleCode Not of consequence in response. String RequestName Not of consequence in response. String RequestStatus Not of consequence in response. String Error Code Error code, if any, for exceptions raised while submitting the request. This is automatically set from the workflow. String Error Message Error details, if any, for exceptions raised while submitting the request. This is automatically set from the workflow. String Object Id Standard WF Output. String Process Instance Id Standard WF Output. String Siebel Operation Object Id Standard WF Output. String SelfServiceTemplateEmail 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. Siebel CRM Web Services Reference Version 8.1/8.2 449
- 450. Siebel CRM Primary Web Services ■ SelfServiceTimeZone Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 1003. Table 1003.SelfServiceTemplateEmail Service Object Name Boundary Object Type SelfServiceTemplateEmail Workflow Process Data Object (Integration Object) For a description of data objects for this Web service, see Table 1004. Table 1004.SelfServiceTemplateEmail Data Object Siebel Repository Name External Name Not applicable Not applicable Example Package for SelfServiceTemplateEmail To view an example of messages 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. Request See the following file to view the sample code: ...SelfServiceTemplateEmailSelfServiceTemplateEmail_request.xml Response See the following file to view the sample code: ...SelfServiceTemplateEmailSelfServiceTemplateEmail_response.xml Interface Description (WSDL) for SelfServiceTemplateEmail 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. ...SelfServiceTemplateEmailSelfServiceTemplateEmail.wsdl SelfServiceTimeZone Use this Web service to retrieve all the Siebel time zone values. These values are retrieved in the session language if it is a locale that is supported by Siebel CRM. If not, the values are retrieved in the base language. The language is set using the search specification. Siebel CRM Web Services Reference Version 8.1/8.2 450
- 451. Siebel CRM Primary Web Services ■ SelfServiceTimeZone SelfServiceTimeZone Operations For a list of operations associated with this Web service, see Table 1005. Table 1005.SelfServiceTimeZone Operations Name Description SelfServiceTimeZoneQueryPage Performs query operations based on the search specification set on the language as input. This operation is used to get the Siebel time zone values based on the language which is set in the search specification. Request Message Description:SelfServiceTimeZoneQueryPage For a description of this request message, see Table 1006. Table 1006.Request Message Description:SelfServiceTimeZoneQueryPage Node Description Type SelfServiceTimeZoneQueryPage_Input The method arguments are the TimeZone integration object with query parameters set, Language Mode as LDC and viewMode (All). Response Message Description: SelfServiceTimeZoneQueryPage For a description of this response message, see Table 1007. Integration Object Table 1007.Response Message Description: SelfServiceTimeZoneQueryPage Node Description Type SelfServiceTimeZoneQueryPage_Output The list of the time zone values that are returned in the language that is set in the search specification. Integration Object SelfServiceTimeZone Application Interface This topic describes the application objects called by the SelfServiceTimeZone. This Web service makes available the business service SelfServiceTimeZone which provides query operation on the integration object SS_TimeZone_IO. Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 1008. Table 1008.SelfServiceTimeZone Service Object Name Boundary Object Type Class SelfServiceTimeZone Integration Object CSSEAIUIDataService Siebel CRM Web Services Reference Version 8.1/8.2 451
- 452. Siebel CRM Primary Web Services ■ SelfServiceUser Data Object (Integration Object) For a description of data objects for this Web service, see Table 1009. Table 1009.SelfServiceTimeZone Data Object Siebel Repository Name External Name SS_TimeZone_IO Time Zone Example Package for SelfServiceTimeZone To view an example of messages 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. Request See the following file to view the sample code: ...SelfServiceTimeZoneSelfServiceTimeZone_request.xml Response See the following file to view the sample code: ...SelfServiceTimeZoneSelfServiceTimeZone_response.xml Interface Description (WSDL) for SelfServiceTimeZone 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. ...SelfServiceTimeZoneSelfServiceTimeZone.wsdl SelfServiceUser This Web service makes available the EAI UI business service SelfServiceUser, which provides CRUD and query operations on the integration object Users. Additionally, this Web service makes available the Execute and Query methods in the SelfServiceUser business service as Web service operations. Siebel CRM Web Services Reference Version 8.1/8.2 452
- 453. Siebel CRM Primary Web Services ■ SelfServiceUser SelfServiceUser Operations For a list of operations associated with this Web service, see Table 1010. Table 1010.SelfServiceUser Operations Name Description SelfServiceUserExecute Performs CRUD operations on the instance of the Users integration object provided as input. Though Siebel Self-Service Applications, version 8.1 do not use this Web service operation for managing responsibilities of a user, the SelfServiceRegistration Workflow used instead, uses the same business service (SelfServiceUser) internally. SelfServiceUserQueryPage Performs Query operation based on the view criteria and search specifcations set on the instance of Users integration object provided as input. This operation is used in Siebel Self-Service Applications, version 8.1 for retrieving the responsibilities of the users in delegated administration. Request Message Description:SelfServiceUserExecute For a description of this request message, see Table 1011. Table 1011.Request Message Description:SelfServiceUserExecute Node Description SelfServiceUserExecute_Input Container element for SelfServiceUser Web service input for Execute operation. ListOfSSUser Container element for the list of users. Corresponds to a User integration object. ListOfSSUser/User Corresponds to the primary integration component User. Set the mode as skipnode for adding, or removing responsibilities of the user. ListOfSSUser/User/LoginName Set the user name for which the associated responsibilities need to be reset. Siebel CRM Web Services Reference Version 8.1/8.2 453 ListOfSSUser/User/ ListOfSSUserResponsibility Container element for User_Responsibility integration component. ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility Corresponds to the User_Responsibility integration component. Represents a responsibility association, for each responsibility to be added and or retained with the user. Earlier assigned responsibilities that are not listed here are deleted by default. ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id Set the ID of the responsibility to be assigned and or retained to the user.
- 454. Siebel CRM Primary Web Services ■ SelfServiceUser Response Message Description: SelfServiceUserExecute For a description of this response message, see Table 1012. Table 1012.Response Message Description: SelfServiceUserExecute Node Description SelfServiceUserExecute_Output Container element for SelfServiceUser Web service output for Request Message Description: SelfServiceUserQueryPage For a description of this request message, see Table 1013. Siebel CRM Web Services Reference Version 8.1/8.2 454 Execute operation. ListOfSSUser Container element for the list of Users. Corresponds to a Users integration object. ListOfSSUser/User Corresponds to the primary integration component User. ListOfSSUser/User/LoginName User name for which the assigned responsibilities are updated. ListOfSSUser/User/ ListOfSSUserResponsibility Container element for User_Responsibility integration component. ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility Corresponds to the User_Responsibility integration component. Each entry represents a responsibility assigned to the user. ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id ID of the responsibility assigned to the user. Table 1013.Request Message Description: SelfServiceUserQueryPage Node Description SelfServiceUserQueryPage_Input Container element for SelfServiceUser Web service input for QueryPage operation. ListOfSSUser Container element for the list of Users. Corresponds to a Users integration object. ListOfSSUser/User Corresponds to the primary integration component User. ListOfSSUser/User/LoginName Set the Username for which the associated responsibilities needs to be loaded. ListOfSSUser/User/ ListOfSSUserResponsibility Container element for User_Responsibility integration component. ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility Corresponds to the User_Responsibility integration component. Represents a responsibility associated to the user.
- 455. Siebel CRM Primary Web Services ■ SelfServiceUser Table 1013.Request Message Description: SelfServiceUserQueryPage Node Description Response Message Description: SelfServiceUserQueryPage For a description of this response message, see Table 1014. SelfServiceUser 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. Siebel CRM Web Services Reference Version 8.1/8.2 455 ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id Empty; to query the ID of the responsibility assigned to the user. ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Responsibility Empty; to query the Name of the responsibility assigned to the user. Table 1014.Response Message Description: SelfServiceUserQueryPage Node Description SelfServiceUserQueryPage_Output Container element for SelfServiceUser Web service output for QueryPage operation. ListOfSSUser Container element for the list of Users. Corresponds to a Users integration object. ListOfSSUser/User Corresponds to the primary integration component User. ListOfSSUser/User/LoginName User name for which the assigned responsibilities are retrieved. ListOfSSUser/User/ ListOfSSUserResponsibility Container element for User_Responsibility integration component. ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility Corresponds to the User_Responsibility integration component. Each entry represents a responsibility assigned to the user. ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id ID of the responsibility assigned to the user. ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Responsibility Name of the responsibility assigned to the user.
- 456. Siebel CRM Primary Web Services ■ SelfServiceWebSite Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 1015. Table 1015.SelfServiceUser Service Object Name Boundary Object Type Class SelfServiceUser BusinessService CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service, see Table 1016. Table 1016.SelfServiceUser Data Object Siebel Repository Name External Name Users Users Example Package for SelfServiceUser To view an example of messages 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. Request See the following file to view the sample code: ...SelfServiceUserSelfServiceUser_request.xml Response See the following file to view the sample code: ...SelfServiceUserSelfServiceUser_response.xml Interface Description (WSDL) for SelfServiceUser 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. ...SelfServiceUserSelfServiceUser.wsdl SelfServiceWebSite This Web service is used for creating, retrieving, updating, and deleting sites. It makes available two methods, Query and the Execute methods in its business service SelfServiceWebSite as Webservice operations. Siebel CRM Web Services Reference Version 8.1/8.2 456
- 457. Siebel CRM Primary Web Services ■ SelfServiceWebSite SelfServiceWebSite Operations For a list of operations associated with this Web service, see Table 1017. Table 1017.SelfServiceWebSite Operations Name Description SelfServiceWebSiteExecute Perform various operations such as creating, updating, or deleting of sites with SelfServiceWebSite integration object as the input. SelfServiceWebSiteQueryPage Performs query operations based on the querycriteria. set on SelfServiceWebSite integration object as the input. This operation is used to query for the site details. Request Message Description:SelfServiceWebSiteExecute Creating, updating, or deleting operations on a site can be performed based on the query criteria that is set. For a description of this request message, see Table 1018. Table 1018.Request Message Description:SelfServiceWebSiteExecute Node Description Type SelfServiceWebSiteExecute_Input The method arguments are the Site integration object, Language Mode (value is LDC) and viewMode (All). Integration Object Response Message Description: SelfServiceWebSiteExecute The response contains the details based on the query set on the Site integration object. For a description of this response message, see Table 1019. Table 1019.Response Message Description: SelfServiceWebSiteExecute Node Description Type SelfServiceWebSiteExecute_Output The data retrieved based on the query set. Integration Object Request Message Description:SelfServiceWebSiteQueryPage Based on the querycriteria set on the integration object, site related details are queried. For a description of this request message, see Table 1020. Table 1020.Request Message Description:SelfServiceWebSiteQueryPage Node Description Type SelfServiceWebSiteQueryPage_Input The method arguments are Site integration object with query parameters set, Language Mode as LDC and viewMode (All). Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 457
- 458. Siebel CRM Primary Web Services ■ SelfServiceWebSite Response Message Description: SelfServiceWebSiteQueryPage The response contains the details based on the update query set on the Site integration object. For a description of this response message, see Table 1021. Table 1021.Response Message Description: SelfServiceWebSiteQueryPage Node Description Type SelfServiceTimeZoneQueryPage_Output The list of the time zone values that are SelfServiceWebSite Application Interface This topic describes the application objects called by the SelfServiceWebSite Web service. This Web service makes available the business service SelfServiceWebSite, which provides execute and query operations on the integration object SS_WebSite_IO. 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 1022. Data Object (Integration Object) For a description of data objects for this Web service, see Table 1023. Example Package for SelfServiceWebSite To view an example of messages 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. Request (SelfServiceWebSiteExecute) See the following file to view the sample code: ...SelfServiceWebSiteSelfServiceWebSiteExecute_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 458 returned in the language that is set in the search specification. Integration Object Table 1022.SelfServiceWebSite Service Object Name Boundary Object Type Class SelfServiceWebSite Integration Object CSSEAIUIDataService Table 1023.SelfServiceWebSite Data Object Siebel Repository Name External Name SS_WebSite_IO SS_WebSite_BO
- 459. Siebel CRM Primary Web Services ■ ServiceRequest Response (SelfServiceWebSiteExecute) See the following file to view the sample code: ...SelfServiceWebSiteSelfServiceWebSiteExecute_response.xml Request (SelfServiceWebSiteQuery) See the following file to view the sample code: ...SelfServiceWebSiteSelfServiceWebSiteQuery_request.xml Response (SelfServiceWebSiteQuery) See the following file to view the sample code: ...SelfServiceWebSiteSelfServiceWebSiteQuery_response.xml Interface Description (WSDL) for SelfServiceWebSite 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. ...SelfServiceWebSiteQuerySelfServiceWebSite.wsdl ServiceRequest Use this Web service to create, read, update the Service Request and to create, read, update, and delete the child objects like Activities, Attachments, Solutions and Service Request Agreements. ServiceRequest Operations For a list of operations associated with this Web service, see Table 1024. Table 1024.ServiceRequest Operations Name Description ServiceReqInsert_Input Used to create the service request. ServiceReqUpdate_Input Used to update the service request. ServiceReqExecute_Input Used to create and update the service request. Also this is used to create and Update child objects such as Activities, Attachment, Solution, Service Request Agreement. ServiceReqQueryPage_Input Used to query the service request and its child objects such as Activities, Attachment, Solution, Service Request Agreement. ServiceReqInit_Input Used to get the default values for the service request. ServiceReqDelete_Input Used to delete the child objects such as Activities, Attachment, Solution, Service Request Agreement. Siebel CRM Web Services Reference Version 8.1/8.2 459
- 460. Siebel CRM Primary Web Services ■ ServiceRequest Request Message Description: ServiceReqInsert_Input For a description of this request message, see Table 1025. Table 1025.Request Message Description: ServiceReqInsert_Input Node Description Abstract Abstract of the service request. Response Message Description: ServiceReqInsert_Input For a description of this response message, see Table 1026. Table 1026.Response Message Description: ServiceReqInsert_Input Node Description Id Returns the Row_Id of the service request. Mod_Id Returns the Mod_Id of the service request. Request Message Description: ServiceReqUpdate_Input For a description of this request message, see Table 1027. Table 1027.Request Message Description: ServiceReqUpdate_Input Node Description Id Row ID of the service request is required. Response Message Description: ServiceReqUpdate_Input For a description of this response message, see Table 1028. Table 1028.Response Message Description: ServiceReqUpdate_Input Node Description Id Returns the Row_Id of the service request. Mod_Id Returns the Mod_Id of the service request. Request Message Description: ServiceReqExecute_Input Request For a description of this request message, see Table 1029. Table 1029.Request Message Description: ServiceReqExecute_Input Request Node Description Service Request Id Row ID of the service request. Abstract Abstract of the service request is required. Siebel CRM Web Services Reference Version 8.1/8.2 460
- 461. Siebel CRM Primary Web Services ■ ServiceRequest Table 1029.Request Message Description: ServiceReqExecute_Input Request Node Description Activities Id Row ID of the Aactivity. Type Type is required. Description2 Description of the activity. Attachment Id Row ID of the attachment. ActivityId Activity ID of the attachment. In this case the Service Request ID. ActivityComments Comments for the attachment. ActivityFileAutoUpdFlg File Auto flag for the attachment. ActivityFileDeferFlg File Defer flag for the attachment. ActivityFileDockReqFlg File Dock Required flag for the attachment. ActivityFileDockStatFlg File Dock Status flag for the attachment. ActivityFileSrcType Type of the Attachment. Valid values are File or URL. ActivityFileSrcPath Location of the file or URL for the attachment. ActivityFileName File name for the attachment, in case of attachment type File. ActivityFileRev File Revision for the attachment, in case of attachment type File. ActivityFileSize File Size for the attachment, in case of attachment type File. ActivityFileExt File extension for the attachment, in case of attachment type File. ActivityFileBuffer Contents to be attached. ActivityFileBuffer Contents to be attached. Solution Id Row ID of the solution is required Name Name of the solution. Agreement Id Row ID of the agreement is required. AgreementName Siebel CRM Web Services Reference Version 8.1/8.2 461
- 462. Siebel CRM Primary Web Services ■ ServiceRequest Response Message Description: ServiceReqExecute_Input Request For a description of this response message, see Table 1030. Table 1030.Response Message Description: ServiceReqExecute_Input Request Node Description Id Returns the Row_Id of the service request. The child object’s Row ID is also Request Message Description: ServiceReqQueryPage_Input For a description of this request message, see Table 1031. Response Message Description: ServiceReqQueryPage_Input For a description of this response message, see Table 1032. Request Message Description: ServiceReqInit_Input For a description of this request message, see Table 1033. Response Message Description: ServiceReqInit_Input For a description of this response message, see Table 1034. Siebel CRM Web Services Reference Version 8.1/8.2 462 returned. Mod_Id Returns the Mod_Id of the service request. The child object’s Mod_Id is also returned. Table 1031.Request Message Description: ServiceReqQueryPage_Input Node Description Id Row ID of the service request. Table 1032.Response Message Description: ServiceReqQueryPage_Input Node Description Service Request Returns all the information of the service request. Child Objects Returns all the child information for that service request. Table 1033.Request Message Description: ServiceReqInit_Input Node Description Service Request Passes the service request attributes. Table 1034.Response Message Description: ServiceReqInit_Input Node Description Service Request Returns default information of the service request.
- 463. Siebel CRM Primary Web Services ■ ServiceRequest Request Message Description: ServiceReqDelete_Input For a description of this request message, see Table 1035. Table 1035.Request Message Description: ServiceReqDelete_Input Node Description Id Row ID of the service request. Id Row ID of the activity. Id Row ID of the attachment. Id Row ID of the solution. Id Row ID of the service request agreement. Response Message Description: ServiceReqDelete_Input For a description of this response message, see Table 1036. Table 1036.Response Message Description: ServiceReqDelete_Input Node Description Id Returns the Ro_ Id of the service request. Also returns the Row ID of the child ServiceRequest 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 1037. Data Object (Integration Object) For a description of data objects for this Web service, see Table 1038. Siebel CRM Web Services Reference Version 8.1/8.2 463 object. Mod_Id Returns the Mod_Id of the service request. Also returns the Mod ID. Table 1037.ServiceRequest Service Object Name Boundary Object Type Class ServiceReq Business Service CSSEAIUIDataService Table 1038.ServiceRequest Data Object Siebel Repository Name External Name ServiceReqIO Service Request (SelfService)
- 464. Siebel CRM Primary Web Services ■ SessionAccessWS Example Package for ServiceRequest To view an example of messages 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. Request See the following file to view the sample code: ...ServiceRequestServiceRequest_request.xml Response See the following file to view the sample code: ...ServiceReqWSServiceRequest_response.xml Interface Description (WSDL) for ServiceRequest 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. ...ServiceRequestServiceRequest.wsdl SessionAccessWS This Web service call is used to terminate the Siebel CRM session. This Web service makes available the business service SessionAccessService which provides the business service method Ping which is used to set a message to terminate the Siebel CRM session. SessionAccessWS Operations For a list of operations associated with this Web service, see Table 1039. Table 1039.SessionAccessWS Operations Name Description sessionAccessPing This is used for setting a message as an input. Siebel CRM Web Services Reference Version 8.1/8.2 464
- 465. Siebel CRM Primary Web Services ■ SessionAccessWS Request Message Description:sessionAccessPing For a description of this request message, see Table 1040. Table 1040.Request Message Description:sessionAccessPing Node Description Type SessionAccessPing_Input Container element. Not applicable SessionAccessPing_Input/msgIn Set as Self-Service Logout Request. String Response Message Description: sessionAccessPing For a description of this response message, see Table 1041. Table 1041.Response Message Description: sessionAccessPing Node Description Type SessionAccessPing_Output Container element. Not applicable SessionAccessPing_Input/msgOut Sent as the number 1 which indicates successful termination of the session. String SessionAccessWS Application Interface This topic describes the application objects called by the SessionAccessWS. This Web service makes available the business service SessionAccessService which provides the method Ping which is used to set a message to terminate the Siebel CRM session. 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 1042. Table 1042.SessionAccessWS Service Object Name Boundary Object Type Class SessionAccessService Business Service CSSUIFSessionAccessService Example Package for SessionAccessWS To view an example of messages 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. Request See the following file to view the sample code: ...SessionAccessWSSessionAccess_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 465
- 466. Siebel CRM Primary Web Services ■ SFA_Activity_BS Response See the following file to view the sample code: ...SessionAccessWSSessionAccess_response.xml Interface Description (WSDL) for SessionAccessWS 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. ...SessionAccessWSSessionAccessWS.wsdl SFA_Activity_BS Use this Web service to insert an activity which is associated to a selected list of contacts into the Siebel database. SFA_Activity_BS Operations These operations are presented as a WSDL to the clients accessing it. For a list of operations associated with this Web service, see Table 1043. Table 1043.SFA_Activity_BS operations Name Description SFAInsertActivity Creates an activity record in the database and associates a contact Response Message Description: SFAInsertActivity For a description of this request message, see Table 1044. Response Message Description: SFAInsertActivity For a description of this response message, see Table 1045. Siebel CRM Web Services Reference Version 8.1/8.2 466 record to it. Table 1044.Response Message Description: SFAInsertActivity Node Description SFA_Activity_IO Required. An instance of the integration object SFA_Activity. Table 1045.Response Message Description: SFAInsertActivity Node Description SFA_Activity_IO Required. An instance of the integration object SFA_Activity.
- 467. Siebel CRM Primary Web Services ■ SFA_Activity_BS SFA_Activity_BS 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 1046. Table 1046.SFA_Activity_BS Service Object Name Boundary Object Type Class (if BusService) SFAActivity_BS Business Service CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service, see Table 1047. Table 1047.SFA_Activity_BS Data Object Siebel Repository Name Boundary Object Type External Name SFA_Activity_IO Siebel Business Object Action Methods For a description of methods for Web service, see Table 1048. Table 1048.SFA_Activity_BS Method Operation Method Insert Insert Example Package for SFA_Activity_BS To view an example of messages 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. Request See the following file to view the sample code: ...SFA_Activity_BSSFA_Activity_BS_request.xml Response See the following file to view the sample code: ...SFA_Activity_BSSFA_Activity_BS_response.xml Siebel CRM Web Services Reference Version 8.1/8.2 467
- 468. Siebel CRM Primary Web Services ■ SWIAdjustmentStatusUpdate Interface Description (WSDL) for SFA_Activity_BS 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. ...SFA_Activity_BSSFA_Activity_BS.wsdl SWIAdjustmentStatusUpdate Use this Web service to update the Status, Sub Status, and Status Description fields of an adjustment record. SWIAdjustmentStatusUpdate Operations For a list of operations associated with this Web service, see Table 1049. Table 1049.SWIAdjustmentStatusUpdate Operations Name Description SWIAdjustmentStatusUpdate Updates the Status, Sub Status, and Status Description fields of Calls Workflow SWIAdjustmentStatusUpdate This Web service can be used either to call a business service or to call a workflow. This Web service calls the SWIAdjustmentStatusUpdate workflow, which extracts information about the Status, Sub Status, and Status Description fields and updates the Siebel database accordingly for that adjustment record. SWIAdjustmentStatusUpdate 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 1050. Siebel CRM Web Services Reference Version 8.1/8.2 468 the adjustment record. Table 1050.SWIAdjustmentStatusUpdate Service Object Name Boundary Object Type Class SWIAdjustmentStatusUpdate Workflow Not Applicable
- 469. Siebel CRM Primary Web Services ■ SWIAdminISSAttributeDefnIO Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1051. Table 1051.SWIAdjustmentStatusUpdate Data Object Siebel Repository Name External Name SWISIAAdjustmentIO SIA Adjustment Methods For a description of the methods for this Web service, see Table 1052. Table 1052.SWIAdjustmentStatusUpdate Method Operation Method SWIAdjustmentStatusUpdate SWIAdjustmentStatusUpdate Example Package for SWIAdjustmentStatusUpdate To view an example of messages 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. Request from Oracle Application Integration Architecture See the following file to view the sample code: ...SWIAdjustmentStatusUpdateSWIAdjustmentStatusUpdate_request.xml Interface Description (WSDL) for SWIAdjustmentStatusUpdate 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. ...SWIAdjustmentStatusUpdateSWIAdjustmentStatusUpdate.wsdl SWIAdminISSAttributeDefnIO Use this Web service to perform query operations on product attribute definitions. Siebel CRM Web Services Reference Version 8.1/8.2 469
- 470. Siebel CRM Primary Web Services ■ SWIAdminISSAttributeDefnIO SWIAdminISSAttributeDefnIO Operations For a list of operations associated with this Web service, see Table 1053. Table 1053.SWIAdminISSAttributeDefnIO Operations Name Description AttributeDefinitionQueryById Queries by using the attribute ID AttributeDefinitionQueryByExample Queries by name, ID, or any valid input Request Message Description: AttributeDefinitionQueryById For a description of this request message, see Table 1054. Table 1054.Request Message Description: AttributeDefinitionQueryById Node Description Type PrimaryRowId Required String Response Message Description: AttributeDefinitionQueryById For a description of this response message, see Table 1055. Table 1055.Response Message Description: AttributeDefinitionQueryById Node Description Type SiebelMessage Required Integration Object Request Message Description: AttributeDefinitionQueryByExample For a description of this request message, see Table 1056. Table 1056.Request Message Description: AttributeDefinitionQueryByExample Node Description Type SiebelMessage Required Integration Object Response Message Description: AttributeDefinitionQueryByExample For a description of this response message, see Table 1057. Table 1057.Response Message Description: AttributeDefinitionQueryByExample Node Description Type SiebelMessage Required Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 470
- 471. Siebel CRM Primary Web Services ■ SWIAdminISSClassDefinitionIO SWIAdminISSAttributeDefnIO 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 1058. Table 1058.SWIAdminISSAttributeDefnIO Service Object Name Boundary Object Type Class SWI Product Attributes Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1059. Table 1059.SWIAdminISSAttributeDefnIO Data Object Siebel Repository Name External Name SWIAdminISSAttributeDefnIO SWI Admin Attribute VOD Definition Methods For a description of the methods for this Web service, see Table 1060. Table 1060.SWIAdminISSAttributeDefnIO Methods Operation Method AttributeDefinitionQueryById QueryById AttributeDefinitionQueryByExample QueryByExample SWIAdminISSClassDefinitionIO Use this Web service to perform query operations on product class definitions. SWIAdminISSClassDefinitionIO Operations For a list of operations associated with this Web service, see Table 1061. Table 1061.SWIAdminISSClassDefinitionIO Operations Name Description ProductClassQueryById Queries by using the class ID ProductClassQueryByExample Queries by name, ID, or any valid input Siebel CRM Web Services Reference Version 8.1/8.2 471
- 472. Siebel CRM Primary Web Services ■ SWIAdminISSClassDefinitionIO Request Message Description: ProductClassQueryById For a description of this request message, see Table 1062. Table 1062.Request Message Description: ProductClassQueryById Node Description Type PrimaryRowId Required String Response Message Description: ProductClassQueryById For a description of this response message, see Table 1063. Table 1063.Response Message Description: ProductClassQueryById Node Description Type SiebelMessage Required Integration Object Request Message Description: ProductClassQueryByExample For a description of this request message, see Table 1064. Table 1064.Request Message Description: ProductClassQueryByExample Node Description Type SiebelMessage Required Integration Object Response Message Description: ProductClassQueryByExample For a description of this response message, see Table 1065. Table 1065.Response Message Description: ProductClassQueryByExample Node Description Type SiebelMessage Required Integration Object SWIAdminISSClassDefinitionIO 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 1066. Table 1066.SWIAdminISSClassDefinitionIO Service Object Name Boundary Object Type Class SWI Product Class Hierarchy Business Service CSSCMUProdClassWebSvc Siebel CRM Web Services Reference Version 8.1/8.2 472
- 473. Siebel CRM Primary Web Services ■ SWIAssetManagement Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1067. Table 1067.SWIAdminISSClassDefinitionIO Data Object Siebel Repository Name External Name SWIAdminISSClassDefinitionIO SWI Admin ISS Class Definition Methods For a description of the methods for this Web service, see Table 1068. Table 1068.SWIAdminISSClassDefinitionIO Methods Operation Method ProductClassQueryById QueryById ProductClassQueryByExample QueryByExample SWIAssetManagement Use this inbound Web service to start Siebel Configurator. SWIAssetManagement Operations For a list of operations associated with this Web service, see Table 1069. Table 1069.SWIAssetManagement Operations Operation Description SWIAssetManagementInsert Inserts SWIAssetManagementUpdate Updates SWIAssetManagementSynchronize Synchronizes Request Message Description: SWIAssetManagementInsert For a description of this request message, see Table 1070. Table 1070.Request Message Description: SWIAssetManagementInsert Node Description Type SiebelMessage Required. Integration Object UTCCanonical A value of Y means that all date-type fields in the payload are in UTC standard format. String Siebel CRM Web Services Reference Version 8.1/8.2 473
- 474. Siebel CRM Primary Web Services ■ SWIAssetManagement Response Message Description: SWIAssetManagementInsert For a description of this response message, see Table 1071. Table 1071.Response Message Description: SWIAssetManagementInsert Node Description Type SiebelMessage Required Integration Object Request Message Description: SWIAssetManagementUpdate For a description of this request message, see Table 1072. Table 1072.Request Message Description: SWIAssetManagementUpdate Node Description Type SiebelMessage Required Integration Object UTCCanonical A value of Y means that all date-type fields in the Response Message Description: SWIAssetManagementUpdate For a description of this response message, see Table 1073. Request Message Description: SWIAssetManagementSynchronize For a description of this request message, see Table 1074. Response Message Description: SWIAssetManagementSynchronize For a description of this response message, see Table 1075. Siebel CRM Web Services Reference Version 8.1/8.2 474 payload are in UTC standard format. String Table 1073.Response Message Description: SWIAssetManagementUpdate Node Description Type SiebelMessage Required Integration Object Table 1074.Request Message Description: SWIAssetManagementSynchronize Node Description Type SiebelMessage Required Integration Object UTCCanonical A value of Y means that all date-type fields in the payload are in UTC standard format. String Table 1075.Response Message Description: SWIAssetManagementSynchronize Node Description Type SiebelMessage Required Integration Object
- 475. Siebel CRM Primary Web Services ■ SWIAssetManagement SWIAssetManagement 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 1076. Table 1076.SWIAssetManagement Service Object Siebel Repository Name Boundary Object Type Class SWI Asset Management Service Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of data objects for this Web service, see Table 1077. Table 1077.SWIAssetManagement Data Object Siebel Repository Name External Name SWIAssetManagementIO SWI Asset Management Methods For a description of the methods for this Web service, see Table 1078. Table 1078.SWIAssetManagement Methods Operation Method SWIAssetManagementInsert Inserts SWIAssetManagementUpdate Updates SWIAssetManagementSynchronize Synchronizes Interface Description (WSDL) for SWISWIAssetManagment 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. WSDL ...WSDLSWIAssetManagment.wsdl Siebel CRM Web Services Reference Version 8.1/8.2 475
- 476. Siebel CRM Primary Web Services ■ SWIContactServices SWIContactServices Use this inbound Web service to support Query, Upsert and Synchronize operations for Contact records and contact child details. SWIContactServices Operations For a list of operations associated with this Web service, see Table 1079. Table 1079.SWIContactServices Operations Name Description SWIContactServicesInsertOrUpdate Calls Insert or Update method used for inserting a new Request Message Description: SWIContactServicesInsertOrUpdate Inserts a new contact along with the child details in to the Siebel database. If the contact is already present in the Siebel database then the contact record is updated with any new details contained in the request message. For a description of this request message, see Table 1080. Siebel CRM Web Services Reference Version 8.1/8.2 476 contact along with the child details into the Siebel database. If the contact is already present in the Siebel database, then the contact will be updated with the details from the request message. SWIContactServicesQueryByExample Calls the Query by Example method to Query Contact details along with the child details from the Siebel database. SWIContactServicesSynchronize Calls the Synchronize method to synchronize the contact in the request message with the contact details in the Siebel database. If the child details that are part of the request message are not present in the Siebel database, then they are inserted. If any additional child is present in the database and not part of request message, then it is deleted from the database. Table 1080.Request Message Description: SWIContactServicesInsertOrUpdate Node Description Type Alias Alias of the contact record. String CellularPhone Mobile phone number of the contact. String ContactPersonTitle Contact’s title. String CurrencyCode Contact’s account currency code. String DateofBirth Contact’s birth date. String
- 477. Siebel CRM Primary Web Services ■ SWIContactServices Table 1080.Request Message Description: SWIContactServicesInsertOrUpdate Node Description Type EmailAddress Contact’s email address. String FaxPhone Contact’s fax number. String FirstName Contact’s first name. String Gender Contact’s gender. String HomePhone Contact’s home phone number. String JobTitle Contact’s job title. String LastName Contact’s last name. String MM Mr. or Mrs. String MaritalStatus Contact’s marital status. String MiddleName Contact’s middle name. String RowId Row ID of Siebel Contact record String SocialSecurityNumber Contact’s social security number. String Status Contact record’s status. String WorkPhone Contact’s work phone number. String AIAIntegrationId ID value used for mapping the request message and response message contact details. String ListofOrganization Container for Organization String PersonalAddress Contact’s home address. String Id Siebel row ID of the Contact record. String AddressName Contact’s address name. String City Contact’s city of residence. String Country Contact’s country of residence. String PostalCode Contact’s postal code. String Province Contact’s province, if applicable. String State Contact’s state of residence. String StreetAddress1 Line 1 details for the contact. String StreetAddress2 Line 2 details for the contact. String AIAIntegrationId ID value used for mapping the request and response message. String Siebel CRM Web Services Reference Version 8.1/8.2 477
- 478. Siebel CRM Primary Web Services ■ SWIContactServices Response Message Description: SWIContactServicesInsertOrUpdate For a description of this response message, see Table 1081. Table 1081.Response Message Description: SWIContactServicesInsertOrUpdate Node Description Type Alias Alias of contact record. String CellularPhone Contact’s mobile phone number. String ContactPersonTitle Contact’s title. String CurrencyCode Contact account currency code. String DateofBirth Contact’s birth date. String EmailAddress Contact’s email address. String FaxPhone Contact’s fax number. String FirstName Contact’s first name. String Gender Contact’s gender. String HomePhone Contact’s home phone number. String JobTitle Contact’s job title. String LastName Contact’s last name. String MM Mr. or Mrs. String MaritalStatus Contact’s marital status. String MiddleName Contact’s middle name. String RowId Row ID of Siebel Contact record String SocialSecurityNumber Contact’s social security number. String Status Contact status. String WorkPhone Contact’s work phone number. String AIAIntegrationId ID value used for mapping the request message Siebel CRM Web Services Reference Version 8.1/8.2 478 and response message contact details. String ListofOrganization Container for organization record. String PersonalAddress Contact’s home address. String Id Row ID of the Contact record In the Siebel database String AddressName Address name String City Contact’s city. String Country Contact’s country. String PostalCode Contact’s postal code. String Province Contact’s province (if applicable). String
- 479. Siebel CRM Primary Web Services ■ SWIContactServices Table 1081.Response Message Description: SWIContactServicesInsertOrUpdate Node Description Type State Contact’s state. String StreetAddress1 Line 1 details for the contact. String StreetAddress2 Line 2 details for the contact. String AIAIntegrationId ID value used for mapping the request and response message. Request Message Description: SWIContactServicesQueryByExample For a description of this request message, see Table 1082. Table 1082.Request Message Description: SWIContactServicesQueryByExample Node Description Type RowId Row ID of Siebel Contact record String ListOfAccount List of Account records. String ListofPersonalAddress List of personal address records of contact. String PersonalAddress Contact’s personal address. String Response Message Description: SWIContactServicesQueryByExample For a description of this response message, see Table 1083. String Table 1083.Response Message Description: SWIContactServicesQueryByExample Node Description Type Id Row ID. String Alias Alias of contact record. String CellularPhone Contact’s mobile phone number. String ContactPersonTitle Contact’s title. String CurrencyCode Contact account currency code. String DateofBirth Contact’s birth date. String EmailAddress Contact’s email address. String FaxPhone Contact’s fax number. String FirstName Contact’s first name. String Gender Contact’s gender. String HomePhone Contact’s home phone number. String JobTitle Contact’s job title. String Siebel CRM Web Services Reference Version 8.1/8.2 479
- 480. Siebel CRM Primary Web Services ■ SWIContactServices Table 1083.Response Message Description: SWIContactServicesQueryByExample Node Description Type LastName Contact’s last name. String MM Mr. or Mrs. String MaritalStatus Contact’s marital status. String MiddleName Contact’s middle name. String MotherMaidenName Contact’s mother’s maiden name. String PrimaryOrganizationId Primary organization for contact. String RowId Row ID in Siebel data table. String SocialSecurityNumber Contact’s social security number. String Status Status of contact record. String WorkPhone Contact’s work telephone number. String ListofAccount Container for Account. Integration Request Message Description: SWIContactServicesSynchronize For a description of this request message, see Table 1084. Siebel CRM Web Services Reference Version 8.1/8.2 480 Component ListofComInvoiceProfile Container for invoice profile. Integration Component ListofOrganization Container for Organization. Integration Component ListofPersonalAddress Container for personal address records. Integration Component PersonalAddress Contact’s personal address. String ListofUCMContactPrivacy Privacy details for Contact record. Integration Component Table 1084.Request Message Description: SWIContactServicesSynchronize Node Description Type Id Row ID. String Alias Alias of contact record. String CellularPhone Contact’s mobile phone number. String ContactPersonTitle Contact’s title. String CurrencyCode Contact’s account currency code. String DateofBirth Contact’s birth date. String EmailAddress Contact’s email address. String
- 481. Siebel CRM Primary Web Services ■ SWIContactServices Table 1084.Request Message Description: SWIContactServicesSynchronize Node Description Type FaxPhone Contact’s fax number. String FirstName Contact’s first name. String Gender Contact’s gender. String HomePhone Contact’s home phone number. String JobTitle Contact’s job title. String LastName Contact’s last name. String MM Mr. or Mrs. String MaritalStatus Contact’s marital status. String MiddleName Contact’s middle name. String MotherMaidenName Contact’s mother’s maiden name. String PrimaryOrganizationId Primary organization for contact. String RowId Row ID in Siebel data table. String SocialSecurityNumber Contact’s social security number. String Status Status of contact record. String WorkPhone Contact’s work telephone number. String AIAIntegrationId ID value used for mapping the request message and response message contact details. ListofOrganization Container for Organization. Integration ListofPersonalAddress Container for personal address records. Integration Response Message Description: SWIContactServicesSynchronize For a description of this response message, see Table 1085. String Component Component Table 1085.Response Message Description: SWIContactServicesSynchronize Node Description Type Id Row ID. String Alias Alias of contact record. String CellularPhone Contact’s mobile phone number. String ContactPersonTitle Contact’s title. String CurrencyCode Contact’s account currency code. String Siebel CRM Web Services Reference Version 8.1/8.2 481
- 482. Siebel CRM Primary Web Services ■ SWIContactServices Table 1085.Response Message Description: SWIContactServicesSynchronize Node Description Type DateofBirth Contact’s birth date. String EmailAddress Contact’s email address. String FaxPhone Contact’s fax number. String FirstName Contact’s first name. String Gender Contact’s gender. String HomePhone Contact’s home phone number. String JobTitle Contact’s job title. String LastName Contact’s last name. String MM Mr. or Mrs. String MaritalStatus Contact’s marital status. String MiddleName Contact’s middle name. String MotherMaidenName Contact’s mother’s maiden name. String PrimaryOrganizationId Primary organization for contact. String RowId Row ID in Siebel data table. String SocialSecurityNumber Contact’s social security number. String Status Status of contact record. String WorkPhone Contact’s work telephone number. String AIAIntegrationId ID value used for mapping the request message SWIContactServices 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. Siebel CRM Web Services Reference Version 8.1/8.2 482 and response message contact details. String ListofOrganization Container for Organization. Integration Component ListofPersonalAddress Container for personal address records. Integration Component
- 483. Siebel CRM Primary Web Services ■ SWICreateAdjustment Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 1086. Table 1086.SWIContactServices Service Object Siebel Repository Name Boundary Object Type Class SWI Contact Service Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of data objects for this Web service, see Table 1087. Table 1087.SWIContactServices Data Object Siebel Repository Name External Name SWIContactIO SWI Contact Methods For a description of the methods for this Web service, see Table 1088. Table 1088.SWIContactServices Methods Operation Method SWIContactServicesInsertOrUpdate InsertOrUpdate SWIContactServicesQueryByExample QueryByExample SWIContactServicesSynchronize Synchronize SWICreateAdjustment Use this Web service to create adjustments in the external Oracle Communications Billing and Revenue Management application by submitting a request to the Oracle Communications Billing and Revenue Management Advanced Queue (AQ) facility. SWICreateAdjustment Operations For a list of operations associated with this Web service, see Table 1089. Table 1089.SWICreateAdjustment Operations Name Description CreateAdjustment Creates adjustments in the external Oracle Communications Billing and Revenue Management application. Siebel CRM Web Services Reference Version 8.1/8.2 483
- 484. Siebel CRM Primary Web Services ■ SWICreateAdjustment Request Message Description: CreateAdjustment For a description of this request message, see Table 1090. Table 1090.Request Message Description: CreateAdjustment Node Description Type CustomHeaderContext Optional Hierarchy SWICreateAdjustmentReqMsg:ListOfCmuRequestAdjustmentIo Optional Integration Response Message Description There is no response message. The request is being posted to the Oracle Communications Billing and Revenue Management facility. SWICreateAdjustment 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 1091. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1092. Methods For a description of the methods for this Web service, see Table 1093. Siebel CRM Web Services Reference Version 8.1/8.2 484 Object Table 1091.SWICreateAdjustment Service Object Name Boundary Object Type Class SWICreateAdjustment Business Service CSSWSOutboundDispatcher Table 1092.SWICreateAdjustment Data Object Siebel Repository Name External Name CMU Request Adjustment IO Account Table 1093.SWICreateAdjustment Method Operation Method CreateAdjustment CreateAdjustment
- 485. Siebel CRM Primary Web Services ■ SWICustomerParty SWICustomerParty Use this inbound Web service to support Query, Upsert and Synchronize operations for contact records and contact child details. SWICustomerParty Operations For a list of operations associated with this Web service, see Table 1094. Table 1094.SWICustomerParty Operations Name Description SWICustomerPartyInsertOrUpdate Calls the Insert or Update method used for inserting a new account along with the child details into the Siebel database. If the account is already present in the Siebel database, then the account will be updated with any new details contained in the request message. SWICustomerPartyQueryByExample Calls the Query by Example method to query the Siebel database for account details along with any child details. SWICustomerPartySynchronize Calls Synchronize method to synchronize the account record contained in the request message with the account details in Siebel database. If the child details that are part of request message are not present in the Siebel database, then the details are inserted. If any additional child are present in the Siebel database and are not part of request message, then those details are deleted from the database. Request Message Description: SWICustomerPartyInsertOrUpdate Inserts a new account along with the child details into the Siebel database. If the account is already present in the Siebel database, then the Account record is updated with the details contained in the request message. For a description of this request message, see Table 1095. Table 1095.Request Message Description: SWICustomerPartyInsertOrUpdate Node Description Type ListofSWIcustomerpartyIO An instance of the integration object ListofSWIcustomerpartyIO. Integration Object The following nodes apply to SWIcustomerpartyIO Account Account name. String AccountStatus Status of account record. String Siebel CRM Web Services Reference Version 8.1/8.2 485
- 486. Siebel CRM Primary Web Services ■ SWICustomerParty Table 1095.Request Message Description: SWICustomerPartyInsertOrUpdate Node Description Type DUNSNumber Dun and Bradstreet data universal Siebel CRM Web Services Reference Version 8.1/8.2 486 numbering system number. String MainFaxNumber Main fax number of account. String MainPhoneNumber Main phone number of account. String Name Account name. String HomePage Account’s home page address. String AIAIntegrationId ID value used for mapping the request message and response message account details. String Location Account’s location. String RowId Row ID of Siebel Account record. String ListofCutAddress Optional. Business address. Integration Component ListofContact Contact details Integration Component ListofInternalDivision Internal division details. Integration Component City City where account is located. String Country Country where account is located. String County County where account is located. String PostalCode Postal code of account. String Province Province (if applicable) where account is located. String AIAIntegrationId Contact’s social security number. String Status Contact status. String WorkPhone Contact’s work phone number. String AIAIntegrationId ID value used for mapping the request message and response message contact details. String ListofOrganization Container for organization record. String PersonalAddress Contact’s home address. String Id Row ID of the Contact record in Siebel data table. String AddressName Address name String
- 487. Siebel CRM Primary Web Services ■ SWICustomerParty Table 1095.Request Message Description: SWICustomerPartyInsertOrUpdate Node Description Type City Contact’s city. String Country Contact’s country. String PostalCode Contact’s postal code. String Province Contact’s province (if applicable). String State Contact’s state. String StreetAddress1 Line 1 details for the contact. String StreetAddress2 Line 2 details for the contact. String AIAIntegrationId ID value used for mapping the request and response message. Response Message Description: SWICustomerPartyInsertOrUpdate For a description of this response message, see Table 1096. String Table 1096.Response Message Description: SWICustomerPartyInsertOrUpdate Node Description Type ListofSWIcustomerpartyIO An instance of the integration object ListofSWIcustomerpartyIO. Integration Object The following nodes apply to SWIcustomerpartyIO Account Account name. String AccountStatus Status of account record. String DUNSNumber Dun and Bradstreet data universal numbering system number. String HomePage Account’s home page address. String Location Account’s location. String MainFaxNumber Account’s main fax number. String MainPhoneNumber Account’s main phone number. String Name Account name. String AIAIntegrationId ID value used for mapping the request message and response message account details. String ListofCutAddress Optional. Business address. Integration Component Siebel CRM Web Services Reference Version 8.1/8.2 487
- 488. Siebel CRM Primary Web Services ■ SWICustomerParty Table 1096.Response Message Description: SWICustomerPartyInsertOrUpdate Node Description Type ListofContact Contact details. Integration Request Message Description: SWICustomerPartyQueryByExample For a description of this request message, see Table 1097. Response Message Description: SWICustomerPartyQueryByExample For a description of this response message, see Table 1098. Siebel CRM Web Services Reference Version 8.1/8.2 488 Component ListOfInternalDivision Internal division details. Integration Component Table 1097.Request Message Description: SWICustomerPartyQueryByExample Node Description Type ListofSWIcustomerpartyIO An instance of the integration object ListofSWIcustomerpartyIO. Integration Object The following nodes apply to SWIcustomerpartyIO RowId Row ID of account in Siebel data table. String ListofCutAddress Optional. Business address. Integration Component Table 1098.Response Message Description: SWIContactServicesQueryByExample Node Description Type ListofSWIcustomerpartyIO An instance of the integration object ListofSWIcustomerpartyIO. Integration Object The following nodes apply to SWIcustomerpartyIO Account Account name. String AccountStatus Status of account record. String AccountTypeCode Dun and Bradstreet data universal numbering system number. String CurrencyCode Account’s currency code. String DUNSNumber Dun and Bradstreet data universal numbering system number. String HomePage Homepage of account String IntegrationId Integration ID. String Location Account location. String
- 489. Siebel CRM Primary Web Services ■ SWICustomerParty Table 1098.Response Message Description: SWIContactServicesQueryByExample Node Description Type MainFaxNumber Main fax number of account. String MainPhoneNumber Main phone number of account. String Name Account name. String ParentAccountId Account ID of parent account. String PrimaryAddressId Primary address of account. String PrimaryBillToAddressId Primary billing address of account. String PrimaryContactId Primary Contact ID for the account. String PrimaryOrganizationId Primary Organization ID for the account. String PrimaryShipToAddress Primary shipping address for the account. String RowId Row ID in Siebel data table. String Type Account type. String ListofCutAddress Optional. Business address. Integration ListofContact Contact details. Integration ListofInternalDivision Internal division details. Integration Request Message Description: SWICustomerPartySynchronize For a description of this request message, see Table 1099. Component Component Component Table 1099.Request Message Description: SWICustomerPartySynchronize Node Description Type ListofSWIcustomerpartyIO An instance of the integration object ListofSWIcustomerpartyIO. Integration Object The following nodes apply to SWIcustomerpartyIO Account Account name. String AccountStatus Status of account record. String DUNSNumber Dun and Bradstreet data universal numbering system number. String MainFaxNumber Main fax number of account. String MainPhoneNumber Main phone number of account. String Name Account name. String HomePage Account’s home page address. String Siebel CRM Web Services Reference Version 8.1/8.2 489
- 490. Siebel CRM Primary Web Services ■ SWICustomerParty Table 1099.Request Message Description: SWICustomerPartySynchronize Node Description Type AIAIntegrationId ID value used for mapping the request Siebel CRM Web Services Reference Version 8.1/8.2 490 message and response message account details. String Location Account’s location. String RowId Row ID of Siebel Account record. String ListofCutAddress Optional. Business address. Integration Component ListofContact Contact details. Integration Component ListofInternalDivision Internal division details. Integration Component City City where account is located. String Country Country where account is located. String County County where account is located. String PostalCode Postal code of account. String Province Province (if applicable) where account is located. String AIAIntegrationId Contact’s social security number. String Status Contact status. String WorkPhone Contact’s work phone number. String AIAIntegrationId ID value used for mapping the request message and response message contact details. String ListofOrganization Container for organization record. String PersonalAddress Contact’s home address. String Id Row ID of the Contact record in Siebel data table. String AddressName Address name String City Contact’s city. String Country Contact’s country. String PostalCode Contact’s postal code. String Province Contact’s province (if applicable). String State Contact’s state. String StreetAddress1 Line 1 details for the contact. String
- 491. Siebel CRM Primary Web Services ■ SWICustomerParty Table 1099.Request Message Description: SWICustomerPartySynchronize Node Description Type StreetAddress2 Line 2 details for the contact. String AIAIntegrationId ID value used for mapping the request and response message. Response Message Description: SWICustomerPartySynchronize For a description of this response message, see Table 1100. String Table 1100.Response Message Description: SWICustomerPartySynchronize Node Description Type ListofSWIcustomerpartyIO An instance of the integration object ListofSWIcustomerpartyIO. Integration Object The following nodes apply to SWIcustomerpartyIO Account Account name. String AccountStatus Status of account record. String DUNSNumber Dun and Bradstreet data universal numbering system number. String HomePage Account’s home page address. String Location Account’s location. String MainFaxNumber Account’s main fax number. String MainPhoneNumber Account’s main phone number. String Name Account name. String AIAIntegrationId ID value used for mapping the request message and response message account details. String ListofCutAddress Optional. Business address. Integration Component ListofContact Contact details. Integration Component ListOfInternalDivision Internal division details. Integration Component SWICustomerParty 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. Siebel CRM Web Services Reference Version 8.1/8.2 491
- 492. Siebel CRM Primary Web Services ■ SWILocationServices Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 1101. Table 1101. Service Object Siebel Repository Name Boundary Object Type Class SWI Customer Party Service Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of data objects for this Web service, see Table 1102. Table 1102. Data Object Siebel Repository Name External Name SWICustomerPartyIO Account SWILocationServices Use this Web service to perform the following basic operations on locations: ■ Back up location ■ Query location SWILocationServices Operations For a list of operations associated with this Web service, see Table 1103. Table 1103.SWILocationServices Operations Name Description SWILocationQuery Queries the location information in the Siebel business Request Message Description: SWILocationQuery For a description of this request message, see Table 1104. Siebel CRM Web Services Reference Version 8.1/8.2 492 application as requested by the third-party application SWILocationSynchronize Synchronizes the location information in the Siebel business application with the location information in the third-party application Table 1104.Request Message Description: SWILocationQuery Node Description Type PrimaryRowId Required String
- 493. Siebel CRM Primary Web Services ■ SWILocationServices Response Message Description: SWILocationQuery For a description of this response message, see Table 1105. Table 1105.Response Message Description: SWILocationQuery Node Description Type SiebelMessage Required Integration Object Request Message Description: SWILocationSynchronize For a description of this request message, see Table 1106. Table 1106.Request Message Description: SWILocationSynchronize Node Description Type SiebelMessage Required Integration Object StatusObject Optional String Response Message Description: SWILocationSynchronize For a description of this response message, see Table 1107. Table 1107.Response Message Description: SWILocationSynchronize Node Description Type SiebelMessage Required Integration Object SWILocationServices 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 1108. Table 1108.SWILocationServices Service Object Siebel Repository Name Boundary Object Type Class SWI Location Adapter Business Service CSSEAIDataSyncService Siebel CRM Web Services Reference Version 8.1/8.2 493
- 494. Siebel CRM Primary Web Services ■ SWILocationSync Data Object (Integration Object) For a description of data objects for this Web service, see Table 1109. Table 1109.SWILocationServices Data Object Siebel Repository Name External Name SWIFMLocationIOFM Location Methods For a description of the methods for this Web service, see Table 1110. Table 1110.SWILocationServices Methods Operation Method SWILocationQuery QueryById SWILocationSynchronize Synchronize SWILocationSync Use this outbound Web service to submit an order into the order queue. SWILocationSync Operations For a list of operations associated with this Web service, see Table 1111. Table 1111.SWILocationSync Operations Name Description SyncTransportationStopList Submits the location request in the Siebel business application Request Message Description: SyncTransportationStopList For a description of this request message, see Table 1112. Response Message Description: SyncTransportationStopList Not applicable. Siebel CRM Web Services Reference Version 8.1/8.2 494 into the asynchronous queue of the third-party application Table 1112.Request Message Description: SyncTransportationStopList Node Description Type CustomHeaderContext Optional Hierarchy SWILocationSyncReqMsg:SyncTransportationStopList Optional Integration Object
- 495. Siebel CRM Primary Web Services ■ SWILSClinicalActivityTemplate SWILocationSync 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 1113. Table 1113.SWILocationSync Service Object Siebel Repository Name Boundary Object Type Class SWILocationSync Business Service CSSWSOutboundDispatcher SWISendLocation Workflow Not applicable Data Object (Integration Object) For a description of the data object for this Web service, see Table 1114. Table 1114.SWILocationSync Data Object Siebel Repository Name External Name SWIFMLocationIOFM Location Method For a description of the method for this Web service, see Table 1115. Table 1115.SWILocationSync Method Operation Method SyncTransportationStopList SyncTransportationStopList SWILSClinicalActivityTemplate Use this Web service to send activity template values for a given template type from the Siebel CRM application. An external application can invoke this Web service using valid Siebel application user credentials for authentication. Siebel CRM Web Services Reference Version 8.1/8.2 495
- 496. Siebel CRM Primary Web Services ■ SWILSClinicalActivityTemplate SWILSClinicalActivityTemplate Operations For a list of operations associated with this Web service, see Table 1116. Table 1116.SWILSClinicalActivityTemplate Operations Operation Name Description TemplateQueryByExample Used to send Activity template values for a given Request Message Description: TemplateQueryByExample This Web service can be invoked with the Type value so that only related activity templates are returned. If you do not provide input, then all activity templates are returned. For a description of this request message, see Table 1117. Response Message Description: TemplateQueryByExample For a description of this request message, see Table 1118. Siebel CRM Web Services Reference Version 8.1/8.2 496 template type. Table 1117.Request Message Description: TemplateQueryByExample Node Description Type Id Optional. Row Id. Character data Searchspec Optional. Search specification. Character data AutoTrigger Optional. Auto Trigger flag. Boolean Description Optional. Activity template description. Character data Name Optional. The name of the Activity template. Character data ParentTemplateId Optional. The parent template ID. Character data ProtocolId Optional. Protocol ID. Character data ProtocolTitle Optional. Protocol title. Character data Public Optional. Public flag. Boolean TemplateType Optional. The template type. Character data Type Optional. Type. Character data Table 1118.Response Message Description: TemplateQueryByExample Node Description Type Id Row ID of the Activity template record. Character data AutoTrigger Auto Trigger flag. Values are Y or N. Boolean Description Activity template description. Character data Name Activity template name. Character data
- 497. Siebel CRM Primary Web Services ■ SWILSClinicalActivityTemplate Table 1118.Response Message Description: TemplateQueryByExample Node Description Type ParentTemplateId Parent template ID. Character data ProtocolId Protocol ID. Character data ProtocolTitle Protocol title. Character data Public Public flag. Values are Y or N. Boolean TemplateType Template type, such as document, activity, and SWILSClinicalActivityTemplate 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 1119. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1120. Example Package for SWILSClinicalActivityTemplate To view an example of messages 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. Request See the following file to view the sample code: ...SWILSClinicalActivityTemplateSWILSClinicalActivityTemplate-QueryByExample-request. Siebel CRM Web Services Reference Version 8.1/8.2 497 xml so on Character data Type Activity template type. Character data Table 1119.SWILSClinicalActivityTemplate Service Object Name Boundary Object Type Class LS Clinical Activity Template Service Business Service CSSEAIDataSyncService Table 1120.SWILSClinicalActivityTemplate Data Object Siebel Repository Name External Name LS Clinical Activity Template Activity Template
- 498. Siebel CRM Primary Web Services ■ SWILSClinicalCreateSiteVisitGeo Location Interface Description (WSDL) for SWILSClinicalActivityTemplate 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. ...SWILSClinicalActivityTemplateSWILSClinicalActivityTemplate.WSDL SWILSClinicalCreateSiteVisitGeo Location Monitoring visits are required by Federal regulations. Siebel Clinical users, also known as monitors, are often working from the field and perform site visits based on protocol requirements and objectives. Often, monitors are required to conduct unplanned visits and will have to adjust existing plans for planned site visits. Monitors may carry mobile devices which capture a site’s GPS information. A third-party application allows the user to select the Site Visit record, check in site location details, and then send them to Siebel Life Sciences. If more than one monitor checks in location details from a third party application to Siebel Life Sciences for the same site visit, then multiple Geo Location Records are created in Siebel Life Sciences. Similarly if the same user checks in at a different time, multiple Geo Location Records are created. SWILSClinicalCreateSiteVisitGeoLocation Operations For a list of operations associated with this Web service, see Table 1121. Table 1121.SWILSClinicalCreateSiteVisitGeoLocation Operations Name Description insert Reads the input parameters for the site visit Request Message Description: insert For a description of this request message, see Table 1122. Siebel CRM Web Services Reference Version 8.1/8.2 498 and saves the information in Siebel Life Sciences. Table 1122.Request Message Description: insert Node Description Type SiteVisitId Required. Site visit ID (Siebel database row ID). Character data UserId Required. Siebel database row ID for the Siebel Clinical visit team member. Character data VisitDate Required. Site visit date time for CRA. Date and time
- 499. Siebel CRM Primary Web Services ■ SWILSClinicalCreateSiteVisitGeo Location Table 1122.Request Message Description: insert Node Description Type Latitude Optional. Site location latitude. Number Longitude Optional. Site location longitude. Number Comments Optional. Any comments provided by the monitor. Character data Response Message Description: insert There is no response message for the insert operation. In the event of an error, an error message will be delivered. SWILSClinicalCreateSiteVisitGeoLocation 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 (Workflow) For a description of the service objects for this Web service, see Table 1123. Table 1123.SWILSClinicalCreateSiteVisitGeoLocation Service Object Name Boundary Object Type Class SWI LS Clinical Create Site Visit Geo Location Workflow Not applicable. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1124. Table 1124.SWILSClinicalCreateSiteVisitGeoLocation Data Object Siebel Repository Name External Name LS Clinical Site Visits Geo Loc IO LS Clinical Site Visits Geo Location Example Package for SWILSClinicalCreateSiteVisitGeoLocation To view an example of messages 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. Request See the following file to view the sample code: Siebel CRM Web Services Reference Version 8.1/8.2 499
- 500. Siebel CRM Primary Web Services ■ SWILSClinicalGetEmployees ...SWILSClinicalCreateSiteVisitGeoLocationSWILSClinicalCreateSiteVisitGeo Location_request.xml Response See the following file to view the sample code: ...SWILSClinicalCreateSiteVisitGeoLocationSWILSClinicalCreateSiteVisitGeo Location_response.xml Interface Description (WSDL) for SWILSClinicalCreateSiteVisitGeoLocation 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. ...SWILSClinicalCreateSiteVisitGeoLocationSWILSClinicalCreateSiteVisitGeo Location.wsdl SWILSClinicalGetEmployees Use this Web service to retrieve employee information. An external application can invoke this Web service using valid Siebel application user credentials for authentication. Additionally, consider the following: ■ If no input is provided for any tags in the LSClinicalGetEmployeesQueryByExample operation, then the Web service returns all employee records. If the returned number of records is more than the predefined maximum size, then the Web service returns an error message prompting the user to refine the search. ■ When using the LSClinicalGetEmployeesQueryPage operation, this Web service returns an error message if the page size field is left blank. ■ This Web service is used to return all employees from an organization or sub-organization to which an authenticated user is associated. SWILSClinicalGetEmployees Operations For a list of operations associated with this Web service, see Table 1125. Table 1125.SWILSClinicalGetEmployees Operations Operation Name Description LSClinicalGetEmployeesQueryByExample Used to return employees in a single Siebel CRM Web Services Reference Version 8.1/8.2 500 result set. LSClinicalGetEmployeesQueryById Used to return employees based on given primary row ID. LSClinicalGetEmployeesQueryPage Used to return employees in pages.
- 501. Siebel CRM Primary Web Services ■ SWILSClinicalGetEmployees Request Message Description: LSClinicalGetEmployeesQueryByExample This operation can be invoked with either the employee ID or login name. This ensures that only the corresponding employee details are returned. Other fields can also be used to refine the search criteria. If no input is provided, then all the employees are returned. For a description of this request message, see Table 1126. Table 1126.Request Message Description: LSClinicalGetEmployeesQueryByExample Node Description Type Employee.Id Optional. Row ID of employee. Character data Employee.EMailAddr Optional. Email address. Character data Employee.FirstName Optional. First name. Character data Employee.JobTitle Optional. Job title. Character data Employee.LastName Optional. Last name. Character data Employee.LoginName Optional. User ID. Character data Employee.Phone Optional. Phone number Number RelatedPosition.Division Optional. Employee division. Character data RelatedResponsibility.Responsibility Optional. Employee responsibility. Character data Request Message Description: LSClinicalGetEmployeesQueryPage This operation can be invoked with either the employee ID or login name. This ensures that only employee details are returned. You can use other fields to refine the search criteria. If all employee details are required, then pass an asterisk (*) for all nodes. The result set will be in pages with page size. For a description of this request message, see Table 1127. Table 1127.Request Message Description: LSClinicalGetEmployeesQueryPage Node Description Type Employee.Id Required. Row ID of the employee record. Can be either an asterisk (*), or a valid Row ID. Character data Employee.FirstName Required. Employee’s first name. Can be either an asterisk (*), or the employee’s first name. Character data Employee.LastName Required. Employee’s last name. Can be either an asterisk (*), or the employee’s last name. Character data Employee.LoginName Required. User ID. Can be either an asterisk (*), or the employee’s user ID. Character data Siebel CRM Web Services Reference Version 8.1/8.2 501
- 502. Siebel CRM Primary Web Services ■ SWILSClinicalGetEmployees Table 1127.Request Message Description: LSClinicalGetEmployeesQueryPage Node Description Type RelatedPosition. Division Required. Employee division. Can Request Message Description: LSClinicalGetEmployeesQueryById This operation can be invoked with the employee row ID so that only corresponding employee details are returned. For a description of this request message, see Table 1128. Response Message Description: LSClinicalGetEmployeesQueryById, LSClinicalGetEmployeesQueryByExample and LSClinicalGetEmployeesQueryPage Each of these operations uses the same response message. For a description of the response message, see Table 1129. Siebel CRM Web Services Reference Version 8.1/8.2 502 be either an asterisk (*), or the employee division. Character data RelatedResponsibility. Responsibility Required. Employee responsibility. Can be either an asterisk (*), or employee responsibility. Character data Table 1128.Request Message Description: LSClinicalGetEmployeesQueryById Node Description Type PrimaryRowId Required. The row ID of the employee. Character data Table 1129.Response Message Description: LSClinicalGetEmployeesQueryById, LSClinicalGetEmployeesQueryByExample and LSClinicalGetEmployeesQueryPage Node Description Type Employee.Id Row ID of the employee. Character data Employee.EMailAddr Email address. Character data Employee.FirstName First name. Character data Employee.JobTitle Job title. Character data Employee.LastName Last name. Character data Employee.LoginName User ID. Character data Employee.Phone Phone number. Number RelatedPosition.Division Employee division. Character data RelatedResponsibility.Responsibility Employee responsibility. Character data
- 503. Siebel CRM Primary Web Services ■ SWILSClinicalGetEmployees SWILSClinicalGetEmployees 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 1130. Table 1130.SWILSClinicalGetEmployees Service Object Name Boundary Object Type Class LS Clinical Get Employees Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1131. Table 1131.SWILSClinicalGetEmployees Data Object Siebel Repository Name External Name LS Clinical Employee Interface Employee Example Package for SWILSClinicalGetEmployees To view an example of messages 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. Request See the following file to view the sample code: ...SWILSClinicalGetEmployeesSWILSClinicalGetEmployees-QueryByExample-request.xml ...SWILSClinicalGetEmployeesSWILSClinicalGetEmployees-QueryPage-request.xml ...SWILSClinicalGetEmployeesSWILSClinicalGetEmployees-QueryById-request.xml Interface Description (WSDL) for SWILSClinicalGetEmployees 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. ...SWILSClinicalGetEmployeesSWILSClinicalGetEmployees-QueryByExample.WSDL ...SWILSClinicalGetEmployeesSWILSClinicalGetEmployees-QueryPage.WSDL ...SWILSClinicalGetEmployeesSWILSClinicalGetEmployees-QueryById.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 503
- 504. Siebel CRM Primary Web Services ■ SWILSClinicalGetSiteContacts SWILSClinicalGetSiteContacts Use this Web service to retrieve all protocol site contacts. An external application can invoke this Web service using valid Siebel application user credentials for authentication. Additionally, consider the following: ■ If the page size field is left blank in the LSClinicalGetSiteContactsQueryPage operation, then the Web service returns an error message. Only provided tags can be used with this operation. ■ The LSClinicalGetSiteContactsQueryById operation supports only one instance of a Siebel message. ■ The mobile application user may want to add a new contact to the ‘Attendees’ list in clinical trip report. ■ In this case, the mobile user must have all contacts of that site in the mobile server side, so that one can add more contacts to attendees in clinical trip report. This Web service helps by returning all those site contacts to external application. SWILSClinicalGetSiteContacts Operations For a list of operations associated with this Web service, see Table 1132. Table 1132.SWILSClinicalGetSiteContacts Operations Operation Name Description LSClinicalGetSiteContactsQueryById Used to send contacts of a site given the Site Request Message Description: LSClinicalGetSiteContactsQueryById Use this operation if the external application requires the contacts associated with a particular site. The operation passes the site row ID that corresponds to each requested contact. For a description of this request message, see Table 1133. Siebel CRM Web Services Reference Version 8.1/8.2 504 Row ID. LSClinicalGetSiteContactsQueryPage Used to send contacts of multiple sites in pages. LSClinicalGetSiteContactsQueryByExample Used to send contacts of multiple sites as a single result set. Table 1133.Request Message Description: LSClinicalGetSiteContactsQueryById Node Description Type PrimaryRowId Required. Protocol site row ID. Character data
- 505. Siebel CRM Primary Web Services ■ SWILSClinicalGetSiteContacts Request Message Description: LSClinicalGetSiteContactsQueryByExample Use this operation to query contacts from a limited number of sites. Different search criteria can be used. For a description of this request message, see Table 1134. Table 1134.Request Message Description: LSClinicalGetSiteContactsQueryByExample Node Description Type ClinicalProtocolSite.Id Optional. Row ID of protocol site. Character data ClinicalProtocolSite. Searchspec Optional. Search specification. Character data ClinicalProtocolSite. SiteNumber Optional. Site number. Character data ClinicalProtocolSite. SiteUId Optional. Site ID. Character data ClinicalAccountInvestigatorRole.Id Optional. Row ID of the site contact. Character data ClinicalAccountInvestigatorRole. ConflictId Optional. Conflict ID. Character data ClinicalAccountInvestigatorRole. Searchspec Optional. Search specification. Character data ClinicalAccountInvestigatorRole. City Optional. Contact’s city. Character data ClinicalAccountInvestigatorRole. ContactId Optional. Row ID of contact. Character data ClinicalAccountInvestigatorRole. Country Optional. Contact’s country. Character data ClinicalAccountInvestigatorRole. EmailAddress Optional. Contact’s email address. Character data ClinicalAccountInvestigatorRole. FaxPhone Optional. Contact’s fax and phone number. Character data ClinicalAccountInvestigatorRole. FirstName Optional. Contact’s first name. Character data ClinicalAccountInvestigatorRole. LastName Optional. Contact’s last name. Character data ClinicalAccountInvestigatorRole. MiddleName Optional. Contact’s middle name. Character data ClinicalAccountInvestigatorRole. PostalCode Optional. Postal code. Character data ClinicalAccountInvestigatorRole. Optional. Primary address Character data PrimaryPersonalAddressId ID. ClinicalAccountInvestigatorRole. PrimarySpecialty Optional. Primary medical specialty. Character data ClinicalAccountInvestigatorRole. Region Optional. Region. Character data ClinicalAccountInvestigatorRole. Role Optional. Role. Character data ClinicalAccountInvestigatorRole. State Optional. State. Character data Siebel CRM Web Services Reference Version 8.1/8.2 505
- 506. Siebel CRM Primary Web Services ■ SWILSClinicalGetSiteContacts ClinicalAccountInvestigatorRole. StreetAddress Request Message Description: LSClinicalGetSiteContactsQueryPage Use this operation to query the contacts from all, or a large number of sites. For a description of this request message, see Table 1135. Response Message Description: LSClinicalGetSiteContactsQueryPage, LSClinicalGetSiteContactsQueryById and LSClinicalGetSiteContactsQueryByExample For a description of the response messages, see Table 1136. Siebel CRM Web Services Reference Version 8.1/8.2 506 Optional. Street address. Character data ClinicalAccountInvestigatorRole. WorkPhone Optional. Work phone. Character data Table 1135.Request Message Description: LSClinicalGetSiteContactsQueryPage Node Description Type ClinicalProtocolSite.Id Required. Can be either an asterisk (*), or the row ID of the protocol site. Character data ClinicalProtocolSite. SiteUId Required. Can be either an asterisk (*), or the site ID. Character data ClinicalAccountInvestigatorRole.Id Required. Can be either an asterisk (*), or the row ID the site contact. Character data ClinicalAccountInvestigatorRole. ContactId Required. Can be either an asterisk (*), or the row ID of the contact. Character data ClinicalAccountInvestigatorRole. FirstName Required. Can be either an asterisk (*), or the contact’s first name. Character data ClinicalAccountInvestigatorRole. LastName Required. Can be either an asterisk (*), or the contact’s last name. Character data Table 1136.Response Message Description: LSClinicalGetSiteContactsQueryPage, LSClinicalGetSiteContactsQueryById and LSClinicalGetSiteContactsQueryByExample Node Description Type ClinicalProtocolSite. SiteNumber Site Number. Character data ClinicalProtocolSite. SiteUId Site ID. Character data Table 1134.Request Message Description: LSClinicalGetSiteContactsQueryByExample Node Description Type
- 507. Siebel CRM Primary Web Services ■ SWILSClinicalGetSiteContacts Table 1136.Response Message Description: LSClinicalGetSiteContactsQueryPage, LSClinicalGetSiteContactsQueryById and LSClinicalGetSiteContactsQueryByExample Node Description Type ClinicalAccountInvestigatorRole.Id Row ID of the site contact. Character data ClinicalAccountInvestigatorRole. City Contact’s city. Character data ClinicalAccountInvestigatorRole. ContactId Row ID of the contact. Character data ClinicalAccountInvestigatorRole. Country Contact’s country. Character data ClinicalAccountInvestigatorRole. EmailAddress Contact’s email. Character data ClinicalAccountInvestigatorRole. FaxPhone Contact’s fax, and phone number. Character data ClinicalAccountInvestigatorRole. FirstName Contact’s first name. Character data ClinicalAccountInvestigatorRole. LastName Contact’s last name. Character data ClinicalAccountInvestigatorRole. MiddleName Contact’s middle name Character data ClinicalAccountInvestigatorRole. PostalCode Postal code. Character data ClinicalAccountInvestigatorRole. PrimaryPersonalAddressId Primary address ID. Character data ClinicalAccountInvestigatorRole. PrimarySpecialty Primary medical specialty. Character data ClinicalAccountInvestigatorRole. Region Region. Character data ClinicalAccountInvestigatorRole. Role Role. Character data ClinicalAccountInvestigatorRole. State State. Character data ClinicalAccountInvestigatorRole. StreetAddress Street address. Character data ClinicalAccountInvestigatorRole. WorkPhone Work phone. Character data Siebel CRM Web Services Reference Version 8.1/8.2 507
- 508. Siebel CRM Primary Web Services ■ SWILSClinicalGetSiteContacts SWILSClinicalGetSiteContacts 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 1137. Table 1137.SWILSClinicalGetSiteContacts Service Object Name Boundary Object Type Class LS Clinical GetSiteContacts Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1138. Table 1138.SWILSClinicalGetSiteContacts Data Object Siebel Repository Name External Name LS Clinical Protocol Site_Clinical Account Investigator Role Clinical Protocol Site Example Package for SWILSClinicalGetSiteContacts To view an example of messages 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. Request See the following file to view the sample code: ...SWILSClinicalGetSiteContactsSWILSClinicalGetSiteContacts-QueryById-request.xml ...SWILSClinicalGetSiteContactsSWILSClinicalGetSiteContacts-QueryByExample-request. Siebel CRM Web Services Reference Version 8.1/8.2 508 xml ...SWILSClinicalGetSiteContactsSWILSClinicalGetSiteContacts-QueryPage-request.xml Interface Description (WSDL) for SWILSClinicalGetSiteContacts 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. ...SWILSClinicalGetSiteContactsSWILSClinicalGetSiteContacts-QueryByExample.WSDL ...SWILSClinicalGetSiteContactsSWILSClinicalGetSiteContacts-QueryPage.WSDL ...SWILSClinicalGetSiteContactsSWILSClinicalGetSiteContacts-QueryById.WSDL
- 509. Siebel CRM Primary Web Services ■ SWILSClinicalGetStateModelService SWILSClinicalGetStateModelService Use this Web service to send the state transitions for a given state model name. An external application can invoke this Web service using any valid Siebel application user credentials for authentication. Additionally, consider the following: ■ If no input is provided for any tags in the LSClinicalGetStateModelServiceQueryByExample operation, then the Web service returns all state transitions for all state models in the Clinical Trial Management System application. An error message might result if the result set is large in number, then the user is prompted to refine the search. ■ An external application can invoke this Web service with either operation depending on the Table 1139.SWILSClinicalGetStateModelService Operations Operation Name Description LSClinicalGetStateModelServiceQueryPage Returns state model transitions in pages. LSClinicalGetStateModelServiceQueryByExample Returns state model transitions as one result set. Siebel CRM Web Services Reference Version 8.1/8.2 509 scenario. ■ If the page size field is left blank in the LSClinicalGetStateModelServiceQueryPage operation, then the Web service returns an error message. ■ The mobile application user may want to update the trip report status from one state to the next valid state. The user must know the valid To Status value from the current status. In this case, the mobile user must have all valid states for a given state model name. ■ Use this Web service to return all valid state transitions for a given state model name. SWILSClinicalGetStateModelService Operations For a list of operations associated with this Web service, see Table 1139. Request Message Description: LSClinicalGetStateModelServiceQueryByExample You can invoke this operation in this Web service with a state model name value so that only related state model transitions are returned. If you provide no input, then all the state model transition values are returned. For a description of this request message, see Table 1140. Table 1140.Request Message Description: LSClinicalGetStateModelServiceQueryByExample Node Description Type StateModel.Id Optional. Row ID of state model name. Character data StateModel. Searchspec Optional. Search specification. Character data StateModel.Name Optional. State model name. Character data
- 510. Siebel CRM Primary Web Services ■ SWILSClinicalGetStateModelService Table 1140.Request Message Description: LSClinicalGetStateModelServiceQueryByExample Node Description Type StateModel-Transition.Id Optional. Row ID of the transition Request Message Description: LSClinicalGetStateModelServiceQueryPage You can invoke this operation with the state model name value so that only related state model transitions are returned. If all state model transition values are required, then pass an asterisk (*) for all nodes. The result set will be in pages with a page size. For a description of this request message, see Table 1141. Siebel CRM Web Services Reference Version 8.1/8.2 510 record. Character data StateModel-Transition. FromStateName Optional. From state name. Character data StateModel-Transition. PublicFlag Optional. Public flag. Values are Y or N. Boolean StateModel-Transition. RuleExpression Optional. Rule expression. Character data StateModel-Transition. RuleFieldName Optional. Rule field name. Character data StateModel-Transition. RuleOperator Optional. Rule operator. Character data StateModel-Transition. RuleValue Optional. Rule value. Character data StateModel-Transition. ToStateName Optional. To state name. A user can change the status drop down value from one state to another state. Character data Table 1141.Request Message Description: LSClinicalGetStateModelServiceQueryPage Node Description Type StateModel.Id Required. The row ID of the state model name. Can be either an asterisk (*), or a valid row ID. Character data StateModel.Name Required. State model name. Can be either an asterisk (*), or a valid state model name. Character data StateModel-Transition.Id Required. Row ID of transition record. Can be either an asterisk (*), or the row ID of the transition state. Character data StateModel-Transition. FromStateName Required. From state name. Can be either an asterisk (*), or From State name. Character data
- 511. Siebel CRM Primary Web Services ■ SWILSClinicalGetStateModelService Table 1141.Request Message Description: LSClinicalGetStateModelServiceQueryPage Node Description Type StateModel-Transition. PublicFlag Required. Public flag. Possible values are Y or N. Can be either an asterisk (*), or public flag. Boolean StateModel-Transition. ToStateName Required. To state name. Can be either an asterisk (*), or To State name. Character data Response Message Description: LSClinicalGetStateModelServiceQueryByExample and LSClinicalGetStateModelServiceQueryPage For a description of this request message, see Table 1142. Table 1142.Response Message Description: LSClinicalGetStateModelServiceQueryByExample and LSClinicalGetStateModelServiceQueryPage Node Description Type StateModel.Id Row ID of the state model name. Character data StateModel.Name State model name. Character data StateModel-Transition. From State name. Character data FromStateName StateModel-Transition. PublicFlag Public flag. Possible values are Y or N. Boolean SWILSClinicalGetStateModelService 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. Siebel CRM Web Services Reference Version 8.1/8.2 511 StateModel-Transition. RuleExpression Rule expression. Character data StateModel-Transition. RuleFieldName Rule field name. Character data StateModel-Transition. RuleOperator Rule operator. Character data StateModel-Transition. RuleValue Rule value. Character data StateModel-Transition. ToStateName To State name. Character data
- 512. Siebel CRM Primary Web Services ■ SWILSClinicalGetStateModelService Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 1143. Table 1143.SWILSClinicalGetStateModelService Service Object Name Boundary Object Type Class LS Clinical Get State Model Service Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1144. Table 1144.SWILSClinicalGetStateModelService Data Object Siebel Repository Name External Name LS Clinical State Model - Interface IO State Model Example Package for SWILSClinicalGetStateModelService To view an example of messages 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. Request See the following file to view the sample code: ...SWILSClinicalGetStateModelServiceSWILSClinicalGetStateModelService- QueryByExample-request.xml ...SWILSClinicalGetStateModelServiceSWILSClinicalGetStateModelService-QueryPage-request. Siebel CRM Web Services Reference Version 8.1/8.2 512 xml Interface Description (WSDL) for SWILSClinicalGetStateModelService 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. ...SWILSClinicalGetStateModelServiceSWILSClinicalGetStateModelService- QueryByExample.WSDL ...SWILSClinicalGetStateModelServiceSWILSClinicalGetStateModelService-QueryPage.WSDL
- 513. Siebel CRM Primary Web Services ■ SWILSClinicalGetSubjectVisitDetails SWILSClinicalGetSubjectVisitDetails Use this Web service to send all subject visit details from a particular protocol site. An external application can invoke this Web service using any valid Siebel application user credentials for authentication. Additionally, consider the following: ■ If no input is provided for any tags in LSClinicalGetSubjectVisitDetailsQueryByExample operation, then the Web service returns all subject visit details. An error message might result if the result set is larger than the predefined maximum size, and then the user is prompted to refine the search. ■ An external application can invoke this Web service with any methods depends on the scenario. ■ This Web service will return an error message if the page size is left blank on the QueryPage Siebel CRM Web Services Reference Version 8.1/8.2 513 method. ■ Only provided tags need to be used with the QueryPage method. ■ The mobile application user might want to add or update a new Case Report form record to a trip report. Is so, then the user must have all the available subject visit details for a particular protocol site at the target host. ■ The external user can use this Web service to get all subject visit details for a given search criteria. SWILSClinicalGetSubjectVisitDetails Operations For a list of operations associated with this Web service, see Table 1145. Table 1145.SWILSClinicalGetSubjectVisitDetails Operations Operation Name Description LSClinicalGetSubjectVisitDetailsQueryById Returns subject visit details for a given protocol site ID. LSClinicalGetSubjectVisitDetailsQueryPage Returns subject visit details in pages. LSClinicalGetSubjectVisitDetailsQueryByExample Returns subject visit details in a single result set based on a given search criteria.
- 514. Siebel CRM Primary Web Services ■ SWILSClinicalGetSubjectVisitDetails Request Message Description: LSClinicalGetSubjectVisitDetailsQueryByExample You can invoke this operation with the protocol site ID to ensure that only the corresponding site related to subject visits is returned. If no input is provided, then all the subject visits from all sites are returned. For a description of this request message, see Table 1146. Table 1146.Request Message Description: LSClinicalGetSubjectVisitDetailsQueryByExample Node Description Type Id Optional. Row ID of subject visit Siebel CRM Web Services Reference Version 8.1/8.2 514 record. Character data Searchspec Optional. Search specification. Character data CRFPages Optional. Number of Case Report form pages. Integer ActivityUID Optional. Activity ID. Character data Category Optional. Category, such as Visit. Character data ParentActivityId Optional. Parent activity ID. Character data ParentTemplateVersionId Optional. Parent template version. Character data ProtocolSiteId Optional. Protocol site ID. Character data Screen Optional. Subject screen number. Character data SubjectDOB Optional. Date of birth. Date and time SubjectId Optional. Subject row ID. Character data SubjectInitial Optional. Subject initials. Character data Template Optional. Template. Character data TemplateFlag Optional. Template flag. Character data TemplateId Optional. Template ID. Character data TemplateVersion Optional. Template version. Character data Type Optional. Visit type. Character data
- 515. Siebel CRM Primary Web Services ■ SWILSClinicalGetSubjectVisitDetails Request Message Description: LSClinicalGetSubjectVisitDetailsQueryPage Invoke this method by passing an asterisk (*) to all of the tags to return all subject visit details from all sites. The result set is returned in pages with page size. For a description of this request message, see Table 1147. Table 1147.Request Message Description: LSClinicalGetSubjectVisitDetailsQueryPage Node Description Type Id Required. Row ID of a subject visit record. Can be either an asterisk (*), or a valid row ID. Character data ActivityUID Required. Activity ID. Can be either an asterisk (*), or a valid activity ID. Character data Category Required. A category such as Visit, and so on. Can be either an asterisk (*), or a valid category value. Character data ParentTemplateVersionId Required. Parent template version. Can be either an asterisk (*), or a valid parent template version ID. Character data ProtocolSiteId Required. Protocol site ID. Can be either an asterisk (*), or a valid protocol site ID. Character data Screen Required. Subject screen number. Can be either an asterisk (*), or a valid screen value. Character data SubjectId Required. Subject row ID. Can be either an asterisk (*), or a valid subject ID. Character data SubjectInitial Required. Subject initial. Can be either an asterisk (*), or a valid subject initial value. Character data Template Required. Template. Can be either an asterisk (*), or a valid template value. Character data TemplateFlag Required. Template flag. Can be either an asterisk (*), or a valid template flag. Values are Y or N. Character data TemplateId Required. Template ID. Can be either an asterisk (*), or a valid template ID. Character data TemplateVersion Required. Template version. Can be either an asterisk (*), or a valid template version. Character data Type Required. Visit type. Can be either an asterisk (*), or a valid type value. Character data Siebel CRM Web Services Reference Version 8.1/8.2 515
- 516. Siebel CRM Primary Web Services ■ SWILSClinicalGetSubjectVisitDetails Request Message Description: LSClinicalGetSubjectVisitDetailsQueryById One can invoke this method in this Web service by passing the exact Row Id of a particular subject visit record. For a description of this request message, see Table 1148. Table 1148.Request Message Description: LSClinicalGetSubjectVisitDetailsQueryById Node Description Type PrimaryRowId Required. The primary row ID of the Response Message Description: LSClinicalGetSubjectVisitDetailsQueryByExample, LSClinicalGetSubjectVisitDetailsQueryPage and LSClinicalGetSubjectVisitDetailsQueryById For a description of this request message, see Table 1149. Siebel CRM Web Services Reference Version 8.1/8.2 516 subject visit record. Character data Table 1149.Response Message Description: LSClinicalGetSubjectVisitDetailsQueryByExample, LSClinicalGetSubjectVisitDetailsQueryPage and LSClinicalGetSubjectVisitDetailsQueryById Node Description Type Id Row ID of the subject visit record. Character data CRFPages The number of case report form pages Integer ActivityUID Activity ID. Character data Category Category, such as visit, and so on. Character data ParentActivityId Parent activity ID. Character data ParentTemplateVersionId Parent template version. Character data ProtocolSiteId Protocol site ID. Character data Screen Subject screen number. Character data SubjectDOB Date of birth. Date Time SubjectId Subject row ID. Character data SubjectInitial Subject initial. Character data Template Template. Character data TemplateFlag Template flag. Character data TemplateId Template ID. Character data TemplateVersion Template version. Character data Type Visit type. Character data
- 517. Siebel CRM Primary Web Services ■ SWILSClinicalGetSubjectVisitDetails SWILSClinicalGetSubjectVisitDetails 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 1150. Table 1150.SWILSClinicalGetSubjectVisitDetails Service Object Name Boundary Object Type Class LS Clinical GetSubjectVisitDetails Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1151. Table 1151.SWILSClinicalGetSubjectVisitDetails Data Object Siebel Repository Name External Name LS Clinical Subject Visit Plan LS Clinical Visit Plan Example Package for SWILSClinicalGetSubjectVisitDetails To view an example of messages 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. Request See the following file to view the sample code: ...SWILSClinicalGetSubjectVisitDetailsSWILSClinicalGetSubjectVisitDetails- QueryByExample-request.xml ...SWILSClinicalGetSubjectVisitDetailsSWILSClinicalGetSubjectVisitDetails-QueryById-request. Siebel CRM Web Services Reference Version 8.1/8.2 517 xml ...SWILSClinicalGetSubjectVisitDetailsSWILSClinicalGetSubjectVisitDetails-QueryPage-request. xml Interface Description (WSDL) for SWILSClinicalGetSubjectVisitDetails 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. ...SWILSClinicalGetSubjectVisitDetailsSWILSClinicalGetSubjectVisitDetails- QueryByExample.WSDL
- 518. Siebel CRM Primary Web Services ■ SWILSClinicalInsertEmployees ...SWILSClinicalGetSubjectVisitDetailsSWILSClinicalGetSubjectVisitDetails- QueryPage.WSDL ...SWILSClinicalGetSubjectVisitDetailsSWILSClinicalGetSubjectVisitDetails- QueryById.WSDL SWILSClinicalInsertEmployees Use this Web service to insert employees into the Assigned To MVG for check list items, followup items, all followup items, and site visit team. You can also use this Web service to remove employees from Assigned To MVG for check list items, followup items, all followup items, and site visit team. The external application can invoke this Web service using any valid Siebel application user credentials for authentication. Additionally, consider the following: ■ If no input is provided for any tags in both operations, then an error message is generated. ■ An external application can invoke this Web service with any operation depending on the scenario. ■ Mobile application users can assign or delete employees to or from the Assigned To fields in check list items, individual followup items, all followup items, and site visit teams. SWILSClinicalInsertEmployees Operations For a list of operations associated with this Web service, see Table 1152. Table 1152.SWILSClinicalInsertEmployees Operations Operation Name Description LSClinicalInsertEmployeesInsert Used to insert employees into the Assigned To field for Request Message Description: LSClinicalInsertEmployeesInsert This operation can be invoked to insert employees either into a site visit team or into the Assigned To field in check list items, followup items, or all followup items. For a description of this request message, see Table 1153. Siebel CRM Web Services Reference Version 8.1/8.2 518 different item types. LSClinicalInsertEmployeesDelete Used to delete employees from the Assigned To field in different item types. Table 1153.Request Message Description: LSClinicalInsertEmployeesInsert Node Description Type ActivityId Required. Activity ID. Character data. EmpId Required. Employee ID. Character data.
- 519. Siebel CRM Primary Web Services ■ SWILSClinicalInsertEmployees Request Message Description: LSClinicalInsertEmployeesDelete Invoke this operation to delete employees either from a site visit team or from the Assigned To field in check list items, followup items, or all followup items. For a description of this request message, see Table 1154. Table 1154.Request Message Description: LSClinicalInsertEmployeesDelete Node Description Type ActivityId Required. Activity ID. Character data. EmpId Required. Employee ID. Character data. SWILSClinicalInsertEmployees 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 1155. Table 1155.SWILSClinicalInsertEmployees Service Object Name Boundary Object Type Class LS Clinical Insert Employees Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1156. Table 1156.SWILSClinicalInsertEmployees Data Object Siebel Repository Name External Name LS Clinical Checklist Assignee LS Clinical Checklist Assignee Example Package for SWILSClinicalInsertEmployees To view an example of messages 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. Request See the following file to view the sample code: ...SWILSClinicalInsertEmployeesSWILSClinicalInsertEmployees-Insert-request.xml ...SWILSClinicalInsertEmployeesSWILSClinicalInsertEmployees-Delete-request.xml Siebel CRM Web Services Reference Version 8.1/8.2 519
- 520. Siebel CRM Primary Web Services ■ SWILSClinicalListOfValues Interface Description (WSDL) for SWILSClinicalInsertEmployees 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. ...SWILSClinicalInsertEmployeesSWILSClinicalInsertEmployees-Insert.WSDL ...SWILSClinicalInsertEmployeesSWILSClinicalInsertEmployees-Delete.WSDL SWILSClinicalListOfValues Use this Web service to send the LOV details for a given LOV type from a Siebel CRM application. The third-party application can invoke this Web service using any valid Siebel CRM user ID as authentication. ■ An external application can invoke this Web service with either operation depending on the scenario. ■ This Web service returns an error message when the LOVQueryPage operation is used with blank page size. ■ If no input is provided for the tags in the LOVQueryByExample operation, then the Web service will attempt to return all the available records from the Siebel database. If this result set exceeds the predefined maximum size, then the Web service returns an error which instructs the user to refine the search criteria. ■ Use only provided tags with the LOVQueryPage operation. ■ Mobile users have all available LOV values on the mobile server to allow them to choose values for clinical trip reports. SWILSClinicalListOfValues Operations For a list of operations associated with this Web service, see Table 1157. Table 1157.SWILSClinicalListOfValues Operations Operation Name Description LOVQueryPage Used to send LOV details for a given LOV type. LOVQueryByExample Used to send LOV details for a given LOV type. Siebel CRM Web Services Reference Version 8.1/8.2 520
- 521. Siebel CRM Primary Web Services ■ SWILSClinicalListOfValues Request Message Description: LOVQueryPage Use this operation when the given search specification retrieves a large number of records at the root component. To avoid returning one large Siebel message, you can specify the number of records to be returned using the PageSize argument. For a description of this request message, see Table 1158. Table 1158.Request Message Description: LOVQueryPage Node Description Type Language Required. A valid language code such as ENU. Can be either an asterisk (*), or a valid Language code. Character data LanguageName Required. The name of the language which can be either an asterisk (*), or a valid language name such as English-American. Character data Modifiable Required. Modifiable flag which can be either an asterisk (*), or a valid Boolean flag such as Y or N. Boolean Multilingual Required. Multilingual flag which can be either an asterisk (*), or a valid Boolean flag such as Y or N. Boolean Name Required. Language independent code (LIC) which can be either an asterisk (*), or a valid LIC code. Character data ReplicationLevel Required. Replication level which can be either an asterisk (*), or a valid replication level. Character data Translate Required. The Translate flag which can be either an asterisk (*), or a valid Boolean flag such as Y or N. Boolean Type Required. LOV Type. Can be either an asterisk (*), or a valid LOV type. Character data Value Required. Display value Can be either an asterisk (*), or a valid display value. Character data Request Message Description: LOVQueryByExample Use this operation if the external application requires only a limited number of LOV type values. For example, to get all LOV type values for all LOVs whose name starts with AAG, then you can call this method with Type value set as follows: Siebel CRM Web Services Reference Version 8.1/8.2 521 AAG* If this operation is invoked with no input for any fields, then the Web service attempts to return all the LOV records as one Siebel message. If the number of LOV records is more than the predefined maximum page size, then the Web service returns an error message prompting the user to refine the search criteria. This operation requires the use of some criteria such as Type, Language, Order By, and so on.
- 522. Siebel CRM Primary Web Services ■ SWILSClinicalListOfValues For a description of this request message, see Table 1159. Table 1159.Request Message Description: LOVQueryByExample Node Description Type Id Optional. Row ID of LOV type value. Character data Searchspec Optional. Search specification. Character data Active Optional. Active or inactive flag. Boolean Bitmap Optional. Bit map. Character data BitmapId Optional. Bit map ID. Character data ClassCode Optional. Class code. Character data Description Optional. Description of the LOV type Siebel CRM Web Services Reference Version 8.1/8.2 522 value. Character data High Optional. High value range. Character data Language Optional. Language code. Character data LanguageName Optional. Name of the language. Character data Low Optional. Low value range. Character data Modifiable Optional. Modifiable flag. Boolean Multilingual Optional. Multilingual flag. Boolean Name Optional. Language independent code. Character data OrderBy Optional. Order by value. Number OrganizationId Optional. Organization ID. Character data Parent Optional. Parent LIC Code. Character data ParentId Optional. Parent LIC code row ID. Character data ReplicationLevel Optional. Replication level. Character data SubType Optional. Name of parent LIC. Character data TargetHigh Optional. Target high value in a range. Number TargetLow Optional. Target low value in a range. Number Translate Optional. Translate flag. Boolean Type Optional. LOV type. Character data Value Optional. Display value. Character data WeightingFactor Optional. Weighting factor. Number
- 523. Siebel CRM Primary Web Services ■ SWILSClinicalListOfValues Response Message Description: LOVQueryByExample and LOVQueryPage For a description of this response message, see Table 1160. Table 1160.Response Message Description: LOVQueryByExample and LOVQueryPage Node Description Type Id Row Id of LOV type value. Character data Active Active or Inactive Flag. Boolean Bitmap Bit map. Character data BitmapId Bit map ID. Character data ClassCode Class code. Character data Description Description of LOV type value. Character data High High value in a range. Character data Language Language code. Character data LanguageName Name of the language. Character data Low Low value in a range. Character data Modifiable Modifiable flag. Boolean Multilingual Multilingual flag. Boolean Name Language independent code. Character data OrderBy Order by value. Number OrganizationId Organization ID. Character data Parent Parent LIC code. Character data ParentId Parent LIC code row ID. Character data ReplicationLevel Replication level. Character data SubType Name of parent LIC. Character data TargetHigh Target high value in a range. Number TargetLow Target low value in a range. Number Translate Translate flag. Boolean Type LOV type. Character data Value Display value. Character data WeightingFactor Weighting factor. Number SWILSClinicalListOfValues 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. Siebel CRM Web Services Reference Version 8.1/8.2 523
- 524. Siebel CRM Primary Web Services ■ SWILSClinicalListOfValues Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 1161. Table 1161.SWILSClinicalListOfValues Service Object Name Boundary Object Type Class LS Clinical List Of Value Service Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1162. Example Package for SWILSClinicalListOfValues To view an example of messages 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. Request See the following file to view the sample code: ...SWILSClinicalListOfValuesSWILSClinicalListOfValues-QueryPage-request.xml ...SWILSClinicalListOfValuesSWILSClinicalListOfValues-QueryByExample-request.xml Interface Description (WSDL) for SWILSClinicalListOfValues 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. ...SWILSClinicalListOfValuesSWILSClinicalListOfValues-QueryByExample.WSDL ...SWILSClinicalListOfValuesSWILSClinicalListOfValues-QueryPage.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 524 Business Service CSSEAIDataSyncService Table 1162.SWILSClinicalListOfValues Data Objects Siebel Repository Name External Name LS Clinical List Of Values List Of Values
- 525. Siebel CRM Primary Web Services ■ SWILSClinicalProtocolSiteGetSites SWILSClinicalProtocolSiteGetSites Use this Web service to populate the My Sites view for a user based on provided login credentials. An external application can invoke this Web service by passing valid Siebel application user credentials for authentication. If a user tries to access another user's sites, then the Web service can be called with the user’s login credentials and the other user’s login name. In this case, the sites that are common to both users are returned. For example, if the user SADMIN wants to access his sites, then the Web service is called with SADMIN login credentials for Siebel authentication and the login name of the SADMIN user. If the SADMIN user wants to access sites assigned to CWALKER, then the Web service is called with the SADMIN login credentials for Siebel authentication and the login name of CWALKER. The result set will include only the sites that are common to SADMIN and CWALKER. Additionally, consider the following: ■ A PageSize variable with a value greater than 0 is required. ■ This Web service supports sort specification (SortSpec) which is used to sort the output based Table 1163.SWILSClinicalProtocolSiteGetSites Operations Operation Name Description QuerySites Used to send sites belongs to the given user. Table 1164.Request Message Description: QuerySites Node Description Type Login Required. The login name of a user such as SADMIN, CWALKER, and so on. Siebel CRM Web Services Reference Version 8.1/8.2 525 on provided sort criteria. SWILSClinicalProtocolSiteGetSites Operations For a list of operations associated with this Web service, see Table 1163. Request Message Description: QuerySites For a description of this request message, see Table 1164. Response Message Description: QuerySites For a description of this request message, see Table 1165. Character data Table 1165.Response Message Description: QuerySites Parent Node Field Type ClinicalProtocolSiteForMobileIntegration Id Character data ClinicalProtocolSiteForMobileIntegration AddressId Character data ClinicalProtocolSiteForMobileIntegration AmountCurrencyCode Character data ClinicalProtocolSiteForMobileIntegration AmountExchangeDate Date
- 526. Siebel CRM Primary Web Services ■ SWILSClinicalProtocolSiteGetSites Table 1165.Response Message Description: QuerySites Parent Node Field Type ClinicalProtocolSiteForMobileIntegration City Character data ClinicalProtocolSiteForMobileIntegration ClinicalProgramName Character data ClinicalProtocolSiteForMobileIntegration Country Character data ClinicalProtocolSiteForMobileIntegration Email Character data ClinicalProtocolSiteForMobileIntegration FaxNumber Character data ClinicalProtocolSiteForMobileIntegration InitiationCompletedDate Date ClinicalProtocolSiteForMobileIntegration InvestigatorFirstName Character data ClinicalProtocolSiteForMobileIntegration InvestigatorFullName Character data ClinicalProtocolSiteForMobileIntegration InvestigatorLastName Character data ClinicalProtocolSiteForMobileIntegration PhoneNumber Character data ClinicalProtocolSiteForMobileIntegration PrimaryInvestigatorId Character data ClinicalProtocolSiteForMobileIntegration ProtocolId Character data ClinicalProtocolSiteForMobileIntegration ProtocolNumber Character data ClinicalProtocolSiteForMobileIntegration ProtocolSiteId Character data ClinicalProtocolSiteForMobileIntegration ProtocolTitle Character data ClinicalProtocolSiteForMobileIntegration Region Character data ClinicalProtocolSiteForMobileIntegration SiteId Character data ClinicalProtocolSiteForMobileIntegration SiteName Character data ClinicalProtocolSiteForMobileIntegration SiteNumber Character data ClinicalProtocolSiteForMobileIntegration SiteType Character data ClinicalProtocolSiteForMobileIntegration State Character data ClinicalProtocolSiteForMobileIntegration StreetAddress Character data ClinicalProtocolSiteForMobileIntegration TerminatedDate Date ClinicalProtocolSiteForMobileIntegration TotalContractAmount Number ClinicalProtocolSiteForMobileIntegration WithholdingAmount Number ClinicalProtocolSiteForMobileIntegration WithholdingPercentage Number ClinicalProtocolSiteForMobileIntegration Zip Character data ClinicalProtocolSiteForMobileIntegration PrimarySiteAddress Character data ClinicalProtocolSiteForMobileIntegration AddressType Character data ClinicalProtocolSiteForMobileIntegration PrimarySiteAddressId Character data Siebel CRM Web Services Reference Version 8.1/8.2 526
- 527. Siebel CRM Primary Web Services ■ SWILSClinicalProtocolSiteGetSites Table 1165.Response Message Description: QuerySites Parent Node Field Type ClinicalProtocolSiteforMobileIntegration_Subject Template IRBApprovalDate Date ClinicalProtocolSiteforMobileIntegration_Subject Template Version Character data ClinicalAccountInvestigatorRole Id Character data ClinicalAccountInvestigatorRole City Character data ClinicalAccountInvestigatorRole Country Character data ClinicalAccountInvestigatorRole EmailAddress Character data ClinicalAccountInvestigatorRole FaxPhone Character data ClinicalAccountInvestigatorRole FirstName Character data ClinicalAccountInvestigatorRole LastName Character data ClinicalAccountInvestigatorRole PostalCode Character data ClinicalAccountInvestigatorRole PrimarySpecialty Character data ClinicalAccountInvestigatorRole Region Character data ClinicalAccountInvestigatorRole Role Character data ClinicalAccountInvestigatorRole State Character data ClinicalAccountInvestigatorRole StreetAddress Character data ClinicalAccountInvestigatorRole WorkPhone Character data LsClinicalAccountAddress Id Character data LsClinicalAccountAddress AccountId Character data LsClinicalAccountAddress AccountLoc Character data LsClinicalAccountAddress AccountName Character data LsClinicalAccountAddress ActiveStatus Character data LsClinicalAccountAddress AddressId Character data LsClinicalAccountAddress AddressName Character data LsClinicalAccountAddress AddressType Character data LsClinicalAccountAddress Altitude Number LsClinicalAccountAddress CLLI Character data LsClinicalAccountAddress City Character data LsClinicalAccountAddress Country Character data LsClinicalAccountAddress DisableDataCleansing Character data Siebel CRM Web Services Reference Version 8.1/8.2 527
- 528. Siebel CRM Primary Web Services ■ SWILSClinicalProtocolSiteGetSites Table 1165.Response Message Description: QuerySites Parent Node Field Type LsClinicalAccountAddress EndDate Date LsClinicalAccountAddress FaxNumber Character data LsClinicalAccountAddress LATA Character data LsClinicalAccountAddress Latitude Number LsClinicalAccountAddress LocalOperatingCompany Character data LsClinicalAccountAddress LocalOperatingCompany Siebel CRM Web Services Reference Version 8.1/8.2 528 Site Character data LsClinicalAccountAddress LocationFlag Boolean LsClinicalAccountAddress LocationType Character data LsClinicalAccountAddress Longitude Number LsClinicalAccountAddress ParentAddress Character data LsClinicalAccountAddress PhoneNumber Character data LsClinicalAccountAddress PostalCode Character data LsClinicalAccountAddress Prefix Character data LsClinicalAccountAddress IsPrimaryAddress Boolean LsClinicalAccountAddress RateCenter Character data LsClinicalAccountAddress StartDate Date LsClinicalAccountAddress State Character data LsClinicalAccountAddress StreetAddress Character data LsClinicalAccountAddress StreetAddress2 Character data LsClinicalAccountAddress Type Character data LsClinicalAccountAddress UTMEasting Character data LsClinicalAccountAddress UTMNorthing Character data ClinicalProtocolSiteAddressBc Id Character data ClinicalProtocolSiteAddressBc AddressLine1 Character data ClinicalProtocolSiteAddressBc AddressLine2 Character data ClinicalProtocolSiteAddressBc AddressType Character data ClinicalProtocolSiteAddressBc City Character data ClinicalProtocolSiteAddressBc Country Character data ClinicalProtocolSiteAddressBc Description Character data ClinicalProtocolSiteAddressBc Email Character data
- 529. Siebel CRM Primary Web Services ■ SWILSClinicalProtocolSiteGetSites Table 1165.Response Message Description: QuerySites Parent Node Field Type ClinicalProtocolSiteAddressBc Fax Character data ClinicalProtocolSiteAddressBc ParentAddress Character data ClinicalProtocolSiteAddressBc Phone Character data ClinicalProtocolSiteAddressBc State Character data ClinicalProtocolSiteAddressBc Zip Character data LsClinicalContactAddress Id Character data LsClinicalContactAddress ActiveFlag Boolean LsClinicalContactAddress AddressId Character data LsClinicalContactAddress AlignmentFlag Boolean LsClinicalContactAddress City Character data LsClinicalContactAddress Country Character data LsClinicalContactAddress DEAExpr Date LsClinicalContactAddress DEA Character data LsClinicalContactAddress EndDate Date Time LsClinicalContactAddress Fax Character data LsClinicalContactAddress Phone Character data LsClinicalContactAddress PostalCode Character data LsClinicalContactAddress ProfessionalId Character data LsClinicalContactAddress StartDate Date Time LsClinicalContactAddress State Character data LsClinicalContactAddress StreetAddress Character data LsClinicalContactAddress Type Character data Contact Id Character data Contact CellularPhone Character data Contact CompanyIdentifier Character data Contact EmailAddress Character data Contact FirstName Character data Contact JobTitle Character data Contact LastName Character data Contact PersonUId Character data Contact Type Character data Siebel CRM Web Services Reference Version 8.1/8.2 529
- 530. Siebel CRM Primary Web Services ■ SWILSClinicalProtocolSiteGetSites Table 1165.Response Message Description: QuerySites Parent Node Field Type Contact WorkPhone Character data Contact_Position EmployeeFirstName Character data Contact_Position EmployeeLastName Character data Contact_Position Position Character data Contact_Position PositionId Character data Contact_Position PositionPrimaryAddressId Character data Contact_Position Login Character data SWILSClinicalProtocolSiteGetSites 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 1166. Table 1166.SWILSClinicalProtocolSiteGetSites Service Object Name Boundary Object Type Class LS Clinical Protocol Site Get Sites Workflow Not applicable LS Clinical Protocol Site Get User Position Workflow Not applicable Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1167. Table 1167.SWILSClinicalProtocolSiteGetSites Data Objects Siebel Repository Name External Name LS Clinical Protocol Site Get Sites Input IO Clinical Protocol Site for Mobile Siebel CRM Web Services Reference Version 8.1/8.2 530 Integration LS Clinical Protocol Site Get Sites Intermediate IO Clinical Protocol Site for Mobile Integration LS Clinical Protocol Site Get Sites Output IO Clinical Protocol Site for Mobile Integration
- 531. Siebel CRM Primary Web Services ■ SWILSClinicalQueryProtocolSite_ SiteVisits Example Package for SWILSClinicalProtocolSiteGetSites To view an example of messages 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. Request See the following file to view the sample code: ...SWILSClinicalProtocolSiteGetSitesSWILSClinicalProtocolSiteGetSites_request.xml Interface Description (WSDL) for SWILSClinicalProtocolSiteGetSites 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. ...SWILSClinicalProtocolSiteGetSitesSWILSClinicalProtocolSiteGetSites.WSDL SWILSClinicalQueryProtocolSite_ SiteVisits Use Siebel Life Sciences as the master system for the objects in the Study hierarchy, such as the protocol, site, and site visits. In a biotechnology or pharmaceutical company, after Protocols and Sites are created in the Siebel database, the information might be required in other downstream third-party applications used to study of protocol. Siebel Life Sciences can provide information on protocols, based on input parameters that are contained in the Web service request messages provided by third-party applications. Requests can be limited by the User ID or by the protocol number, or both. When the input parameters of the Protocol Number field and User ID (Site Visit Team Member) are provided, the Web service returns only the information from the related sites and site visits. There is no output for users, protocols, or users who are not associated with the protocol. SWILSClinicalQueryProtocolSite_SiteVisits Operations For a list of operations associated with this Web service, see Table 1168. Table 1168.SWILSClinicalQueryProtocolSite_SiteVisits Operations Name Description query Queries the Clinical Trial Management System application to retrieve protocol, site, and site visit information. Siebel CRM Web Services Reference Version 8.1/8.2 531
- 532. Siebel CRM Primary Web Services ■ SWILSClinicalQueryProtocolSite_ SiteVisits Request Message Description: query For a description of this request message, see Table 1169. Table 1169.Request Message Description: query Node Description Type UserId Required. Passes a valid site visit Siebel CRM Web Services Reference Version 8.1/8.2 532 team member login ID to get the corresponding user's site visits or passes (*) to get site visit details of all users. Character data Protocol Number Required. Passes a valid protocol number to get a user's site visits in the given protocol or passes (*) to get site visits of a user in all protocols. Character data PageSize Required. Number of protocol sites the user wants to view in a single page. The number must be greater than zero. Number
- 533. Siebel CRM Primary Web Services ■ SWILSClinicalQueryProtocolSite_ SiteVisits Table 1169.Request Message Description: query Node Description Type StartRowNum Optional. First record you want to start with. Number Sort Spec Used to sort the clinical protocol site records based on the given sort specifications. The Clinical Research Associate can query and prioritize site visits based on fields such as status, Site ID and so on. Other fields include: ■ Account Main Phone Number ■ Account Status ■ Address Id ■ Primary Investigator Id ■ Protocol Id ■ Protocol Number ■ Protocol Site Id ■ Protocol Title ■ Region ■ Region Id ■ Site Id ■ Site Number ■ Status ■ Investigator First Name ■ Investigator Last Name Comma-separated list of Clinical Protocol Site for Mobile Integration business component fields made available in the integration. Siebel CRM Web Services Reference Version 8.1/8.2 533
- 534. Siebel CRM Primary Web Services ■ SWILSClinicalQueryProtocolSite_ SiteVisits Response Message Description: query For a description of this request message, see Table 1170 Table 1170.Response Message Description: query Parent Node Field Type Description ClinicalProtocolSite ProtocolNumber Character data Display protocol and Siebel CRM Web Services Reference Version 8.1/8.2 534 site details. ClinicalProtocolSite ProtocolId Character data ClinicalProtocolSite ProtocolSiteId Character data ClinicalProtocolSite ProtocolTitle Character data ClinicalProtocolSite Region Character data ClinicalProtocolSite RegionId Character data ClinicalProtocolSite SiteId Character data ClinicalProtocolSite AccountMainPhone Number Character data ClinicalProtocolSite Account Character data ClinicalProtocolSite SiteNumber Character data ClinicalProtocolSite PrimaryInvestigator Id Character data ClinicalProtocolSite AddressId Character data ClinicalProtocolSite Planned Integer ClinicalProtocolSite AccountStatus Character data ClinicalProtocolSite Status Character data ClinicalProtocolSite AccountType Character data ClinicalProtocolSite UserId Character data ClinicalProtocolSiteAddressBc Fax Character data Display details of addresses associated with the site. ClinicalProtocolSiteAddressBc City Character data ClinicalProtocolSiteAddressBc AddressLine2 Character data ClinicalProtocolSiteAddressBc Phone Character data ClinicalProtocolSiteAddressBc State Character data ClinicalProtocolSiteAddressBc Country Character data ClinicalProtocolSiteAddressBc Zip Character data
- 535. Siebel CRM Primary Web Services ■ SWILSClinicalQueryProtocolSite_ SiteVisits Table 1170.Response Message Description: query Parent Node Field Type Description ClinicalAccountInvestigatorRole FirstName Character data Display site contact details. ClinicalAccountInvestigatorRole FaxPhone Character data ClinicalAccountInvestigatorRole EmailAddress Character data ClinicalAccountInvestigatorRole WorkPhone Character data ClinicalAccountInvestigatorRole State Character data ClinicalAccountInvestigatorRole LastName Character data ClinicalTripReport Done Date and Time Display site visit details. ClinicalTripReport Description Character data ClinicalTripReport Comment Character data ClinicalTripReport Id Character data ClinicalTripReport InvestigatorFirst Name Character data ClinicalTripReport InvestigatorLast Name Character data ClinicalTripReport Planned2 Date and Time ClinicalTripReport Status Character data ClinicalTripReport Type Character data ClinicalTripReport TripReportStatus Character data LsClinicalSiteVisitEmployee Login Character data Display site visit team member details. LsClinicalSiteVisitEmployee Emp Id Character data LsClinicalSiteVisitEmployee IsPrimaryOwner Character data query LastPage Character data Displays True if the page is last, otherwise it will display False. SWILSClinicalQueryProtocolSite_SiteVisits 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. Siebel CRM Web Services Reference Version 8.1/8.2 535
- 536. Siebel CRM Primary Web Services ■ SWILSClinicalQueryProtocolSite_ SiteVisits Service Object (Workflow) For a description of the service objects for this Web service, see Table 1171. Table 1171.SWILSClinicalQueryProtocolSite_SiteVisits Service Object Name Boundary Object Type Class SWI LS Clinical Query Protocol Site_Site Visits Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1172. Example Package for SWILSClinicalQueryProtocolSite_SiteVisits To view an example of messages 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. Request See the following file to view the sample code: ...SWILSClinicalQueryProtocolSite_SiteVisitsSWILSClinicalQueryProtocolSite_Site Visits_request.xml Response See the following file to view the sample code: ...SWILSClinicalQueryProtocolSite_SiteVisitsSWILSClinicalQueryProtocolSite_Site Visits_response.xml Interface Description (WSDL) for SWILSClinicalQueryProtocolSite_SiteVisits 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. ...SWILSClinicalQueryProtocolSite_SiteVisitsSWILSClinicalQueryProtocolSite_Site Visits.wsdl Siebel CRM Web Services Reference Version 8.1/8.2 536 Workflow Not applicable. Table 1172.SWILSClinicalQueryProtocolSite_SiteVisits Data Object Siebel Repository Name External Name LS Clinical Protocol Site_Site Visits Input IO Clinical Protocol Site for Mobile Integration LS Clinical Protocol Site_Site Visits Output IO Clinical Protocol Site for Mobile Integration
- 537. Siebel CRM Primary Web Services ■ SWI LS Clinical Payments Inbound SWI LS Clinical Payments Inbound Use this Web service to update the incoming status, and to check the details of a payment for a site. An external application invokes this Web service with payment number, status, currency code, and check date. If the Payment Number or Status fields are null, then no updates are made to the Siebel Life Sciences application. If the currency code is null in the Web service, then the currency code presented in Siebel Life Sciences will be used. An error message is returned in the event of an error. SWI LS Clinical Payments Inbound Operations For a list of operations associated with this Web service, see Table 1173. Table 1173.SWI LS Clinical Payments Inbound Operations Name Description UpdateClinicalPayment Updates the payment status, and checks the details of a payment for a particular site. Request Message Description: UpdateClinicalPayment For a description of this request message, see Table 1174. NOTE: An external application can pass values for other nodes, apart from those listed in Table 1174. Values in Table 1174 are updated in the Siebel Life Sciences application. Table 1174.Request Message Description: UpdateClinicalPayment Node Description Type Payment Number Required. Character data Status Required. Status of the payment. Character data AmountCurrencyCode Optional. Character data CheckDate Optional. Date CheckNumber Optional. Character data PaymentFeedback Optional. Customer feedback or comments. VATAmount Optional. Value added tax amount. Currency Response Message Description: UpdateClinicalPayment There is no response message for the UpdateClinicalPayment operation. Character data SWI LS Clinical Payments Inbound 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. Siebel CRM Web Services Reference Version 8.1/8.2 537
- 538. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Service Object (Workflow) For a description of the service objects for this Web service, see Table 1175. Table 1175.SWI LS Clinical Payments Inbound Service Object Name Boundary Object Type Class SWI LS Clinical Payments Inbound Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1176. Example Package for SWI LS Clinical Payments To view an example of messages 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. Request See the following file to view the sample code: ...LSClinicalPaymentsUpdateClinicalPayment_request.xml Interface Description (WSDL) for SWI LS Clinical Payments 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. ...LSClinicalPaymentsSWI_LS_Clinical_Payments_Inbound.wsdl SWILSClinicalTripReportInterface Service Use this Web service to send trip report details to external applications and also to update the trip report details into your clinical trial management system. The user who invokes this Web service must be present in the site visit team. Also, consider the following: Siebel CRM Web Services Reference Version 8.1/8.2 538 Workflow Not applicable. Table 1176.SWI LS Clinical Payments Inbound Data Object Siebel Repository Name External Name LS Clinical Payments Clinical Payments
- 539. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service ■ If no input is provided for any tags in the TripReportQueryByExample operation, shown in Table 1177 on page 539, then the Web service will return all those site visit details where the user is part of site visit teams. If the number of records are larger than the predefined maximum size, then the Web service returns an error prompting the user to refine the search and limit the result set. ■ An external application can invoke this Web service with any of the listed operations depending Table 1177.SWILSClinicalTripReportInterfaceService Operations Operation Name Description TripReportQueryById Used to query the trip report details based on give trip report Id or Site Visit Row Id. TripReportQueryPage Used to query the trip report details in pages based on given filter criteria. TripReportQueryByExample Used to query the trip report details based on given filter criteria. TripReportSynchronize Used to synchronize the trip report and its child records. TripReportUpdate Used to update the trip report header details. TripReportInsertOrUpdate Used either to update the trip report and its child components or to insert new child items of trip report. Siebel CRM Web Services Reference Version 8.1/8.2 539 on the scenario. ■ This Web service returns an error message if the Page Size field is left blank on the TripReportQueryPage operation. ■ Only provided tags can be used with TripReportQueryPage operation. ■ Mobile application users might need to update trip information offline. In this case, trip reports can be accessed from the clinical trial management system using query operations. The information can then be updated on the mobile device and then sent back to the clinical trial management system to complete the update. SWILSClinicalTripReportInterfaceService Operations For a list of operations associated with this Web service, see Table 1177. Request Message Description: TripReportQueryById For a description of this request message, see Table 1178. Table 1178.Request Message Description: TripReportQueryById Node Description Type PrimaryRowId Required. The site visit row ID. Character data
- 540. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Request Message Description: TripReportQueryPage For a description of this request message, see Table 1179. Table 1179.Request Message Description: TripReportQueryPage Node Description Type ClinicalTripReport.Id Required. The site visit row ID. Siebel CRM Web Services Reference Version 8.1/8.2 540 Can be either an asterisk (*), or a valid row ID. Character data ClinicalTripReport. ActivityUID Required. Site visit activity ID. Can be either an asterisk (*), or a valid activity ID. Character data ClinicalTripReport. Description Required. The trip report description. Can be either an asterisk (*), or a valid description. Character data ClinicalTripReport. DisplayInvestigatorFirstName Required. Can be either an asterisk (*), or valid First Name. Character data ClinicalTripReport. DisplayInvestigatorLastName Required. The last name of the principal investigator. Can be either an asterisk (*), or a valid last name. Character data ClinicalTripReport. ProtocolNumber Required. The protocol number. Can be either an asterisk (*), or a valid protocol number. Character data ClinicalTripReport. ProtocolSiteId Required. The site row ID. Can be either an asterisk (*), or a valid protocol site ID. Character data ClinicalTripReport. ProtocolTitle Required. The protocol title. Can be either an asterisk (*), or a valid protocol title. Character data ClinicalTripReport. SiteName Required. The trip report account. Can be either an asterisk (*), or a valid site name. Character data ClinicalTripReport. SiteNumber Required. The site number. Can be either an asterisk (*), or a valid site number. Character data ClinicalTripReport. Status Required. The trip report status. Can be either an asterisk (*), or a valid status value. Character data ClinicalTripReport. TripReportStatus Required. The trip report status. Can be either an asterisk (*), or a valid trip report status. Character data
- 541. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1179.Request Message Description: TripReportQueryPage Node Description Type ClinicalTripReport.Type Required. The visit type. Can be either an asterisk (*), or a valid visit type value. Character data LsClinicalSiteVisitAssignee.Id Required. The row ID of the employee in the site visit team. Can be either an asterisk (*), or valid row ID. Character data LsClinicalSiteVisitAssignee. ActivityId Required. The activity ID of the employee in the site visit team.Can be either an asterisk (*), or a valid activity ID. Character data LsClinicalSiteVisitAssignee. EmpId Required. The employee ID. Can be either an asterisk (*), or a valid employee ID. Character data LsClinicalSiteVisitAssignee. FirstName Required. The employee’s first name. Can be either an asterisk (*), or a valid first name. Character data LsClinicalSiteVisitAssignee. LastName Required. The employee’s last name. Can be either an asterisk (*), or a valid last name. Character data LsClinicalSiteVisitAssignee. UserId Required. The user ID. Can be either an asterisk (*), or a valid user ID. Character data ClinicalAttendee.Id Required. The attendee row ID. Can be either an asterisk (*), or a valid attendee row ID. Character data ClinicalAttendee. EmployeeFlag Required. The employee flag. Can be either an asterisk (*), or the employee flag. Boolean ClinicalAttendee. FirstName Required. The attendee’s first name. Can be either an asterisk (*), or a valid first name. Character data ClinicalAttendee. LastName Required. The attendee’s last name. Can be either an asterisk (*), or a valid last name. Character data ClinicalAttendeeStatic.Id Required. The attendee row ID. Can be either an asterisk (*), or a valid row ID. Character data Siebel CRM Web Services Reference Version 8.1/8.2 541
- 542. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1179.Request Message Description: TripReportQueryPage Node Description Type ClinicalAttendeeStatic. ActivityId Required. The attendee’s activity Siebel CRM Web Services Reference Version 8.1/8.2 542 ID. Can be either an asterisk (*), or a valid activity ID. Character data ClinicalAttendeeStatic. ContactId Required. The contact ID. Can be either an asterisk (*), or a valid contact ID. Character data ClinicalChecklist.Id Required. The checklist row ID. Can be either an asterisk (*), or valid checklist row ID. Character data ClinicalChecklist.ActivityUID Required. The checklist activity ID. Can be either an asterisk (*), or a valid activity ID. Character data ClinicalChecklist. CreatedByName Required. The created user name. Can be either an asterisk (*), or a valid created user name. Character data ClinicalChecklist. ParentActivityId Required. The parent activity ID. Can be either an asterisk (*), or a valid parent activity ID. Character data ClinicalFollowUp.Id Required. The clinical followup row ID. Can be either an asterisk (*), or a valid followup row ID. Character data ClinicalFollowUp. ActivityUID Required. The activity ID. Can be either an asterisk (*), or a valid activity ID. Character data ClinicalFollowUp. CreatedByName Required. The created user name. Can be either an asterisk (*), or a valid created user name. Character data ClinicalFollowUp. ParentActivityId Required. The parent activity ID. Can be either an asterisk (*), or a valid parent activity ID. Character data ClinicalFollowUpSiteLevel.Id Required. The followup site level row ID. Can be either an asterisk (*), or a valid followup site level row ID. Character data ClinicalFollowUpSiteLevel. ActivityUID Required. The activity ID. Can be either an asterisk (*), or a valid activity ID. Character data
- 543. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1179.Request Message Description: TripReportQueryPage Node Description Type ClinicalFollowUpSiteLevel. CreatedByName Required. The created user name. Can be either an asterisk (*), or a valid created user name. Character data ClinicalFollowUpSiteLevel. ParentActivityId Required. The parent activity ID. Can be either an asterisk (*), or a valid parent activity ID. Character data LsCaseReportFormsTracking.Id Required. The case report form row ID. Can be either an asterisk (*), or a valid case report form row ID. Character data LsCaseReportFormsTracking.ActivityUID Required. The activity ID. Can be either an asterisk (*), or a valid activity ID. Character data LsCaseReportFormsTracking.ParentActivityId Required. Can be either an asterisk (*), or valid Parent Activity Id.Parent Activity Id Character data LsCaseReportFormsTracking.ParentTemplate Version Required. The template version. Can be either an asterisk (*), or a valid parent template version. Character data LsCaseReportFormsTracking.SubjectInitial Required. The subject initial. Can be either an asterisk (*), or a valid subject initial. Character data LsCaseReportFormsTracking.SubjectNumber Required. The subject number. Can be either an asterisk (*), or a valid subject number. Character data LsCaseReportFormsTracking.Visit Required. The visit name. Can be either an asterisk (*), or a valid visit name. Character data LsCaseReportFormsTracking.VisitType Required. The visit type. Can be either an asterisk (*), or a valid visit type. Character data Siebel CRM Web Services Reference Version 8.1/8.2 543
- 544. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Request Message Description: TripReportQueryByExample For a description of this request message, see Table 1180. Table 1180.Request Message Description: TripReportQueryByExample Node Description Type ClinicalTripReport.Id Optional. The site visit Siebel CRM Web Services Reference Version 8.1/8.2 544 row ID. Character data ClinicalTripReport. Searchspec Optional. The search specification. Character data ClinicalTripReport. ActivityUID Optional. The site visit activity ID. Character data ClinicalTripReport. ApproverLogin Optional. The approver login. Character data ClinicalTripReport. Comment Optional. Comments. Character data ClinicalTripReport. Completed Optional. The completed flag. Boolean ClinicalTripReport. Description Optional. The trip report description. Character data ClinicalTripReport. DisplayInvestigatorFirstName Optional. The PI first name. Character data ClinicalTripReport. DisplayInvestigatorLastName Optional. The PI last name. Character data ClinicalTripReport. Done Optional. The completed date. UTC Date Time ClinicalTripReport. Planned Optional. The planned date. UTC Date Time ClinicalTripReport. ProtocolNumber Optional. The protocol number. Character data ClinicalTripReport. ProtocolSiteId Optional. The site row ID. Character data ClinicalTripReport. ProtocolTitle Optional. The protocol title. Character data ClinicalTripReport. ReviewerComments Optional. Reviewer comments. Character data ClinicalTripReport. ReviewerLogin Optional. The reviewer login ID. Character data ClinicalTripReport. ApproverComments Optional. Approver comments. Character data ClinicalTripReport. SiteName Optional. Trip report account. Character data
- 545. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1180.Request Message Description: TripReportQueryByExample Node Description Type ClinicalTripReport. SiteNumber Optional. Site number. Character data ClinicalTripReport. Status Optional. Status. Character data ClinicalTripReport. TemplateName Optional. Template name. Character data ClinicalTripReport. TripReportCompleted Optional. Trip report completed date. Date ClinicalTripReport. TripReportStatus Optional. Trip report status. Character data ClinicalTripReport.Type Optional. Visit type. Character data LsClinicalSiteVisitAssignee.Id Optional. Row ID of the employee in the site visit team. Character data LsClinicalSiteVisitAssignee.Searchspec Optional. The search specification. Character data LsClinicalSiteVisitAssignee. ActivityId Optional. The activity ID of the employee in the site visit team. Character data LsClinicalSiteVisitAssignee. ConfigurationName Optional. The configuration name. Character data LsClinicalSiteVisitAssignee. EMailAddr Optional. Email address. Character data LsClinicalSiteVisitAssignee. EmpId Optional. Employee ID. Character data LsClinicalSiteVisitAssignee. FirstName Optional. The employee’s first name. Character data LsClinicalSiteVisitAssignee. IsPrimaryOwner Optional. Is Primary Owner flag. Character data LsClinicalSiteVisitAssignee. JobTitle Optional. Job title. Character data LsClinicalSiteVisitAssignee. LastName Optional. The employee’s last name. Character data LsClinicalSiteVisitAssignee. Phone Optional. Phone number. Character data LsClinicalSiteVisitAssignee. ShiftName Optional. The shift name. Character data LsClinicalSiteVisitAssignee. UserId Optional. The User ID. Character data ClinicalAttendee.Id Optional. The Attendee’s Row ID. Character data ClinicalAttendee. Searchspec Optional. The search specification. Character data Siebel CRM Web Services Reference Version 8.1/8.2 545
- 546. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1180.Request Message Description: TripReportQueryByExample Node Description Type ClinicalAttendee. DisplayRole Optional. The display Siebel CRM Web Services Reference Version 8.1/8.2 546 role. Character data ClinicalAttendee. EmployeeFlag Optional. The employee flag. Boolean ClinicalAttendee. FirstName Optional. First name. Character data ClinicalAttendee. LastName Optional. Last name. Character data ClinicalAttendee. Position Optional. Position Character data ClinicalAttendeeStatic.Id Optional. Attendee’s row ID. Character data ClinicalAttendeeStatic. ActivityId Optional. Attendee’s activity ID. Character data ClinicalAttendeeStatic. ContactId Optional. Contact ID. Character data ClinicalChecklist.Id Optional. Checklist row ID. Character data ClinicalChecklist. Searchspec Optional. Search specification. Character data ClinicalChecklist.ActivityUID Optional. Checklist activity ID. Character data ClinicalChecklist. Category Optional. Category Character data ClinicalChecklist. CreatedByName Optional. Created user name. Character data ClinicalChecklist. Description Optional. Description. Character data ClinicalChecklist. Display Optional. Display for calendar activities. Character data ClinicalChecklist. ParentActivityId Optional. Parent activity ID. Character data ClinicalChecklist. ShortComment Optional. Comments. Character data ClinicalChecklist. Status Optional. Status. Character data ClinicalChecklist. Type Optional. Type. Character data ClinicalFollowUp.Id Optional. Row ID of the clinical followup record. Character data ClinicalFollowUp. ActivityUID Optional. Activity ID. Character data ClinicalFollowUp. CreatedByName Optional. Created user name. Character data ClinicalFollowUp. Description Optional. Description. Character data
- 547. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1180.Request Message Description: TripReportQueryByExample Node Description Type ClinicalFollowUp. Display Optional. Display. Character data ClinicalFollowUp. Done Optional. Completed date. UTC Date Time ClinicalFollowUp. Due Optional. Due date. UTC Date Time ClinicalFollowUp. ParentActivityId Optional. Parent activity ID. Character data ClinicalFollowUp. ShortComment Optional. Comments. Character data ClinicalFollowUp. Status Optional. Status. Character data ClinicalFollowUp. Type Optional. Activity type. Character data ClinicalFollowUpSiteLevel.Id Optional. Row ID of the followup site level record. Character data ClinicalFollowUpSiteLevel. ActivityUID Optional. Activity ID. Character data ClinicalFollowUpSiteLevel. Category Optional. Category. Character data ClinicalFollowUpSiteLevel. CreatedByName Optional. Created user name. Character data ClinicalFollowUpSiteLevel. Description Optional. Description. Character data ClinicalFollowUpSiteLevel. Display Optional. Display. Character data ClinicalFollowUpSiteLevel. Done Optional. Completed date. UTC Date Time ClinicalFollowUpSiteLevel. Due Optional. Due date. UTC Date Time ClinicalFollowUpSiteLevel. ParentActivityId Optional. Parent activity ID. Character data ClinicalFollowUpSiteLevel. ShortComment Optional. Comments. Character data ClinicalFollowUpSiteLevel. Status Optional. Status. Character data ClinicalFollowUpSiteLevel. Type Optional. Type. Character data LsCaseReportFormsTracking.Id Optional. Row ID of the case report form. Character data LsCaseReportFormsTracking. CRFPages Optional. Number of case report form pages. Integer LsCaseReportFormsTracking. ActivityType Optional. Activity type. Character data LsCaseReportFormsTracking. ActivityUID Optional. Activity Id Character data LsCaseReportFormsTracking. Category Optional. Category. Character data LsCaseReportFormsTracking. Comments Optional. Comments. Character data Siebel CRM Web Services Reference Version 8.1/8.2 547
- 548. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1180.Request Message Description: TripReportQueryByExample Node Description Type LsCaseReportFormsTracking. OwnedById Optional. Owner user Request Message Description: TripReportInsertOrUpdate For a description of this request message, see Table 1181. Siebel CRM Web Services Reference Version 8.1/8.2 548 ID. Character data LsCaseReportFormsTracking. ParentActivityId Optional. Parent activity ID. Character data LsCaseReportFormsTracking. ParentTemplateVersion Optional. Template version. Character data LsCaseReportFormsTracking. PrivateFlag Optional. Private flag. Boolean LsCaseReportFormsTracking. Retrieved Optional. Retrieved flag. Boolean LsCaseReportFormsTracking. RetrievedDate Optional. Retrieved date. UTC Date Time LsCaseReportFormsTracking. SourceDocumentVerfied Optional. Source Document Verified flag. Boolean LsCaseReportFormsTracking. SourceDocumentVerifiedDate Optional. Source Document Verified date. UTC Date Time LsCaseReportFormsTracking. SubjectInitial Optional. Subject initial. Character data LsCaseReportFormsTracking. SubjectNumber Optional. Subject number. Character data LsCaseReportFormsTracking. Visit Optional. Visit name. Character data LsCaseReportFormsTracking. VisitType Optional. Visit type. Character data Table 1181.Request Message Description: TripReportInsertOrUpdate Node Description Type ClinicalTripReport.Id Required. Site visit row ID. Character data ClinicalTripReport. ActivityUID Optional. Site visit activity ID. Character data ClinicalTripReport. ApproverLogin Optional. Approver login. Character data ClinicalTripReport. Comment Optional. Comments. Character data ClinicalTripReport. Completed Optional. Completed flag. Boolean
- 549. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1181.Request Message Description: TripReportInsertOrUpdate Node Description Type ClinicalTripReport. Description Required. Trip Report Description Character data ClinicalTripReport. DisplayInvestigatorFirstName Optional. The first name of the principal investigator. Character data ClinicalTripReport. DisplayInvestigatorLastName Optional. PI last name. Character data ClinicalTripReport. Done Optional. Completed date. UTC Date Time ClinicalTripReport. Planned Optional. Planned date. UTC Date Time ClinicalTripReport. ProtocolSiteId Required. Site row ID. Character data ClinicalTripReport. ReviewerComments Optional. Reviewer comments. Character data ClinicalTripReport. ReviewerLogin Optional. Reviewer login ID. Character data ClinicalTripReport. ApproverComments Optional. Approver comments. Character data ClinicalTripReport. SiteNumber Optional. Site number. Character data ClinicalTripReport. Status Required. Status. Character data ClinicalTripReport. TemplateName Optional. Template name. Character data ClinicalTripReport. TripReportCompleted Optional. Trip report completed date. Date ClinicalTripReport. TripReportStatus Optional. Trip report status. Character data ClinicalTripReport. Type Required. Visit type. Character data LsClinicalSiteVisitAssignee. Id Optional. Row ID of the employee in the site visit team. Character data Siebel CRM Web Services Reference Version 8.1/8.2 549
- 550. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1181.Request Message Description: TripReportInsertOrUpdate Node Description Type LsClinicalSiteVisitAssignee. ActivityId Required. Activity Siebel CRM Web Services Reference Version 8.1/8.2 550 ID of the employee in the site visit team. Character data LsClinicalSiteVisitAssignee. ConfigurationName Optional. Configuration name. Character data LsClinicalSiteVisitAssignee. EMailAddr Optional. Email address. Character data LsClinicalSiteVisitAssignee. EmpId Required. Employee ID. Character data LsClinicalSiteVisitAssignee. FirstName Optional. Employee first name. Character data LsClinicalSiteVisitAssignee. IsPrimaryOwner Optional. The Is Primary Owner flag. Character data LsClinicalSiteVisitAssignee. JobTitle Optional. Job title. Character data LsClinicalSiteVisitAssignee. LastName Optional. Employee last name. Character data LsClinicalSiteVisitAssignee. Phone Optional. Phone number. Character data LsClinicalSiteVisitAssignee. ShiftName Optional. Shift name. Character data LsClinicalSiteVisitAssignee. UserId Optional. User ID. Character data ClinicalAttendeeStatic. Id Optional. Row ID of the attendee. Character data ClinicalAttendeeStatic. ActivityId Required. Activity ID of the attendee. Character data ClinicalAttendeeStatic. ContactId Required. Contact ID. Character data ClinicalChecklist. Id Required. Checklist row ID. Character data ClinicalChecklist. ActivityUID Required. Checklist activity ID. Character data ClinicalChecklist. Category Required. Category. Character data ClinicalChecklist. CreatedByName Optional. Created user name Character data
- 551. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1181.Request Message Description: TripReportInsertOrUpdate Node Description Type ClinicalChecklist. Description Optional. Description. Character data ClinicalChecklist. Display Optional. Display. Character data ClinicalChecklist. ParentActivityId Required. Parent activity ID. Character data ClinicalChecklist. ShortComment Optional. Comments. Character data ClinicalChecklist. Status Optional. Status. Character data ClinicalChecklist. Type Optional. Type. Character data LsClinicalChecklistAssignee. Id Optional. Checklist assignee Row ID. Character data LsClinicalChecklistAssignee. ActivityId Required. Activity ID. Character data LsClinicalChecklistAssignee. ConfigurationName Optional. Configuration name. Character data LsClinicalChecklistAssignee. EMailAddr Optional. Email address. Character data LsClinicalChecklistAssignee. FirstName Optional. First name. Character data LsClinicalChecklistAssignee. IsPrimaryOwner Optional. Primary Owner flag. Character data LsClinicalChecklistAssignee. JobTitle Optional. Job title. Character data LsClinicalChecklistAssignee. LastName Optional. Last name. Character data LsClinicalChecklistAssignee. Phone Optional. Phone. Character data LsClinicalChecklistAssignee. UserId Optional. User ID. Character data LsClinicalChecklistAssignee. ShiftName Optional. Shift name. Character data LsClinicalChecklistAssignee. EmpId Required. Employee ID. Character data ClinicalFollowUp. Id Required. Clinical followup Row ID. Character data ClinicalFollowUp. ActivityUID Required. Activity ID. Character data ClinicalFollowUp.Category Required. Character data Siebel CRM Web Services Reference Version 8.1/8.2 551
- 552. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1181.Request Message Description: TripReportInsertOrUpdate Node Description Type ClinicalFollowUp. CreatedByName Optional. Created Siebel CRM Web Services Reference Version 8.1/8.2 552 user name. Character data ClinicalFollowUp. Description Optional. Description. Character data ClinicalFollowUp. Display Optional. Display. Character data ClinicalFollowUp. Done Optional. Completed date. UTC Date Time ClinicalFollowUp. Due Optional. Due Date UTC Date Time ClinicalFollowUp. ParentActivityId Required. Parent activity ID. Character data ClinicalFollowUp. ShortComment Optional. Comments. Character data ClinicalFollowUp. Status Optional. Status. Character data ClinicalFollowUp. Type Optional. Activity type. Character data LsClinicalFollowUpAssignee. Id Optional. Followup item assignee row ID. Character data LsClinicalFollowUpAssignee. ActivityId Required. Activity ID. Character data LsClinicalFollowUpAssignee. ConfigurationName Optional. Configuration name. Character data LsClinicalFollowUpAssignee. EMailAddr Optional. Email address. Character data LsClinicalFollowUpAssignee. EmpId Required. Employee ID. Character data LsClinicalFollowUpAssignee. FirstName Optional. First name. Character data LsClinicalFollowUpAssignee. IsPrimaryOwner Optional. Primary Owner flag. Character data LsClinicalFollowUpAssignee. JobTitle Optional. Job title. Character data LsClinicalFollowUpAssignee. LastName Optional. Last name. Character data LsClinicalFollowUpAssignee. Phone Optional. Phone. Character data
- 553. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1181.Request Message Description: TripReportInsertOrUpdate Node Description Type LsClinicalFollowUpAssignee. ShiftName Optional. Shift name. Character data LsClinicalFollowUpAssignee. UserId Optional. User ID. Character data LsCaseReportFormsTracking. Id Required. Case report form row ID. Character data LsCaseReportFormsTracking. CRFPages Optional. The number of case report form pages. Integer LsCaseReportFormsTracking. ActivityType Optional. Activity type. Character data LsCaseReportFormsTracking. ActivityUID Required. Activity ID. Character data LsCaseReportFormsTracking. Category Required. Category. Character data LsCaseReportFormsTracking. Comments Optional. Comments. Character data LsCaseReportFormsTracking. OwnedById Optional. Owner User ID. Character data LsCaseReportFormsTracking. ParentActivityId Required. Parent activity ID. Character data LsCaseReportFormsTracking. ParentTemplateVersion Required. Template version. Character data LsCaseReportFormsTracking. PrivateFlag Optional. The Private flag. Boolean LsCaseReportFormsTracking. Retrieved Optional. Retrieved flag. Boolean LsCaseReportFormsTracking. RetrievedDate Optional. Retrieved date. UTC Date Time LsCaseReportFormsTracking. SourceDocumentVerfied Optional. The Source Document Verified flag. Boolean LsCaseReportFormsTracking. SourceDocumentVerifiedDate Optional. Source document verified date. UTC Date Time LsCaseReportFormsTracking. SubjectInitial Required. Subject initial. Character data LsCaseReportFormsTracking. SubjectNumber Required. Subject number. Character data Siebel CRM Web Services Reference Version 8.1/8.2 553
- 554. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1181.Request Message Description: TripReportInsertOrUpdate Node Description Type LsCaseReportFormsTracking. Visit Required. Visit Request Message Description: TripReportUpdate For a description of this request message, see Table 1182. Siebel CRM Web Services Reference Version 8.1/8.2 554 name. Character data LsCaseReportFormsTracking. VisitType Required. Visit type. Character data LsClinicalGeoLocation. Id Required. Geo location row ID. Character data LsClinicalGeoLocation. Comments Optional. Comments. Character data LsClinicalGeoLocation. EmpId Required. Employee ID. Character data LsClinicalGeoLocation. Latitude Optional. Latitude. Number LsClinicalGeoLocation. LoginId Optional. Login ID. Character data LsClinicalGeoLocation. Longitude Optional. Longitude. Number LsClinicalGeoLocation. SiteVisitId Required. Site visit row ID. Character data LsClinicalGeoLocation VisitDate Required. Visit date. Date Time Table 1182.Request Message Description: TripReportUpdate Node Description Type ClinicalTripReport.Id Required. Site visit row ID. Character data ClinicalTripReport. ActivityUID Optional. Site visit activity ID. Character data ClinicalTripReport. ApproverLogin Optional. Approver login. Character data ClinicalTripReport. Comment Optional. Comments. Character data ClinicalTripReport. Completed Optional. The Completed flag. Boolean ClinicalTripReport. Description Required. Trip report description. Character data ClinicalTripReport. DisplayInvestigatorFirstName Optional. PI first name. Character data
- 555. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1182.Request Message Description: TripReportUpdate Node Description Type ClinicalTripReport. DisplayInvestigatorLastName Optional. PI last name. Character data ClinicalTripReport. Done Optional. Completed date. ClinicalTripReport. Planned Optional. Planned date. UTC Date Time ClinicalTripReport. ProtocolSiteId Required. Site row ID. Character data ClinicalTripReport. ReviewerComments Optional. Reviewer comments. ClinicalTripReport. ReviewerLogin Optional. Review login ID. ClinicalTripReport. ApproverComments Optional. Approver comments. ClinicalTripReport. SiteNumber Optional. Site number. Character data ClinicalTripReport. Status Required. Status. Character data ClinicalTripReport. TemplateName Optional. Template name. ClinicalTripReport. TripReportCompleted Optional. Trip report completed date. ClinicalTripReport. TripReportStatus Optional. Trip report status. ClinicalTripReport. Type Required. Visit type. Character data Request Message Description: TripReportSynchronize For a description of this request message, see Table 1183. UTC Date Time Character data Character data Character data Character data Date Character data Table 1183.Request Message Description: TripReportSynchronize Node Description Type ClinicalTripReport.Id Required. Site visit row ID. Character ata ClinicalTripReport. ApproverLogin Optional. Approver login. Character data ClinicalTripReport. Comment Optional. Comments. Character data ClinicalTripReport. Completed Optional. Completed flag. Character data ClinicalTripReport. Description Required. Trip report description. Character data Siebel CRM Web Services Reference Version 8.1/8.2 555
- 556. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1183.Request Message Description: TripReportSynchronize Node Description Type ClinicalTripReport. DisplayInvestigatorFirstName Optional. First Siebel CRM Web Services Reference Version 8.1/8.2 556 name of principal investigator. Character data ClinicalTripReport. DisplayInvestigatorLastName Optional. Last name of the principal investigator. Character data ClinicalTripReport. Done Optional. Completed date. UTC Date Time ClinicalTripReport. Planned Optional. Planned date. UTC Date Time ClinicalTripReport. ProtocolSiteId Required. Site row ID. Character data ClinicalTripReport. ReviewerComments Optional. Reviewer comments, Character data ClinicalTripReport. ReviewerLogin Optional. Reviewer login ID. Character data ClinicalTripReport. ApproverComments Optional. Approver comments. Character data ClinicalTripReport. SiteNumber Optional. Site number. Character data ClinicalTripReport. Status Required. Status. Character data ClinicalTripReport. TemplateName Optional. Template name. Character data ClinicalTripReport. TripReportCompleted Optional. Trip report completed date. Date ClinicalTripReport. TripReportStatus Optional. Trip report status. Character data ClinicalTripReport. Type Required. Visit type. Character data LsClinicalSiteVisitAssignee. Id Optional. Row ID of the employee in the site visit team. Character data LsClinicalSiteVisitAssignee. ActivityId Required. Activity ID of the employee in the site visit team. Character data
- 557. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1183.Request Message Description: TripReportSynchronize Node Description Type LsClinicalSiteVisitAssignee. ConfigurationName Optional. Configuration name. Character data LsClinicalSiteVisitAssignee. EMailAddr Optional. Email address. Character data LsClinicalSiteVisitAssignee. EmpId Required. Employee ID. Character data LsClinicalSiteVisitAssignee. FirstName Optional. Employee first name. Character data LsClinicalSiteVisitAssignee. IsPrimaryOwner Optional. Is Primary Owner flag. Character data LsClinicalSiteVisitAssignee. JobTitle Optional. Job title. Character data LsClinicalSiteVisitAssignee. LastName Optional. Employee last name. Character data LsClinicalSiteVisitAssignee. Phone Optional. Phone number. Character data LsClinicalSiteVisitAssignee. ShiftName Optional. Shift name. Character data LsClinicalSiteVisitAssignee. UserId Optional. User ID. Character data ClinicalAttendeeStatic. Id Optional. Attendees row ID. Character data ClinicalAttendeeStatic. ActivityId Required. Attendee’s Activity ID. Character data ClinicalAttendeeStatic. ContactId Required. Contact ID. Character data ClinicalFollowUp. Id Required. Clinical followup row ID. Character data ClinicalFollowUp. ActivityUID Required. Activity ID. Character data ClinicalFollowUp. Category Required. Category. Character data ClinicalFollowUp. CreatedByName Optional. Created user name. Character data ClinicalFollowUp. Description Optional. Description. Character data ClinicalFollowUp. Display Optional. Display. Character data Siebel CRM Web Services Reference Version 8.1/8.2 557
- 558. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1183.Request Message Description: TripReportSynchronize Node Description Type ClinicalFollowUp. Done Optional. Siebel CRM Web Services Reference Version 8.1/8.2 558 Completed date. UTC date and time. ClinicalFollowUp. Due Optional. Due date. UTC date and time. ClinicalFollowUp. ParentActivityId Required. Parent Activity ID. Character data ClinicalFollowUp. ShortComment Optional. Comments. Character data ClinicalFollowUp. Status Optional. Status. Character data ClinicalFollowUp. Type Optional. Activity type. Character data LsClinicalFollowUpAssignee. Id Required. Followup item assignee row ID. Character data LsClinicalFollowUpAssignee. ActivityId Required. Activity ID. Character data LsClinicalFollowUpAssignee. ConfigurationName Optional. Configuration name. Character data LsClinicalFollowUpAssignee. EMailAddr Optional. Email address. Character data LsClinicalFollowUpAssignee. EmpId Required. Employee ID. Character data LsClinicalFollowUpAssignee. FirstName Optional. First name. Character data LsClinicalFollowUpAssignee. IsPrimaryOwner Optional. Primary Owner flag. Character data LsClinicalFollowUpAssignee. JobTitle Optional. Job title. Character data LsClinicalFollowUpAssignee. LastName Optional. Last name. Character data LsClinicalFollowUpAssignee. Phone Optional. Phone. Character data LsClinicalFollowUpAssignee. ShiftName Optional. Shift name. Character data LsClinicalFollowUpAssignee. UserId Optional. User ID. Character data LsCaseReportFormsTracking. Id Required. Case report form row ID. Character data
- 559. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1183.Request Message Description: TripReportSynchronize Node Description Type LsCaseReportFormsTracking. CRFPages Optional. Number of Case report form pages. Character data LsCaseReportFormsTracking. ActivityType Optional. Activity type. Character data LsCaseReportFormsTracking. ActivityUID Required. Activity ID. Character data LsCaseReportFormsTracking. Category Required. Category. Character data LsCaseReportFormsTracking. Comments Optional. Comments. Character data LsCaseReportFormsTracking. OwnedById Optional. Owner’s user ID. Character data LsCaseReportFormsTracking. ParentActivityId Required. Parent activity ID. Character data LsCaseReportFormsTracking. ParentTemplateVersion Optional. Template version. Character data LsCaseReportFormsTracking. PrivateFlag Optional. Private flag. Character data LsCaseReportFormsTracking. Retrieved Optional. Retrieved flag. Character data LsCaseReportFormsTracking. RetrievedDate Optional. Retrieved date. UTC date and time LsCaseReportFormsTracking. SourceDocumentVerfied Optional. Source Document Verified flag. Character data LsCaseReportFormsTracking. SourceDocumentVerifiedDate Optional. Source document verified date. UTC date and time. LsCaseReportFormsTracking. SubjectInitial Optional. Required subject initial. Character data LsCaseReportFormsTracking. SubjectNumber Required. Subject number. Character data LsCaseReportFormsTracking. Visit Required. Visit name. Character data LsCaseReportFormsTracking. VisitType Required. Visit type. Character data Siebel CRM Web Services Reference Version 8.1/8.2 559
- 560. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Response Message Description: All SWILSClinicalTripReportInterfaceService Query Operations For a description of these response messages, see Table 1184. Table 1184.Response Message Description: All SWILSClinicalTripReportInterfaceService Query Siebel CRM Web Services Reference Version 8.1/8.2 560 Operations Node Description Type ClinicalTripReport. Id Site visit row ID. Character data ClinicalTripReport. ActivityUID Site visit activity ID. Character data ClinicalTripReport. ApproverLogin Approver login. Character data ClinicalTripReport. Comment Comments. Character data ClinicalTripReport. Completed The Completed flag. Boolean ClinicalTripReport. Description Trip report description. Character data ClinicalTripReport. DisplayInvestigatorFirstName The first name of the principal investigator. Character data ClinicalTripReport. DisplayInvestigatorLastName The last name of the principal investigator. Character data ClinicalTripReport. Done Completed date. UTC date time ClinicalTripReport. Planned Planned date. UTC Date Time ClinicalTripReport. ProtocolNumber Protocol number. Character data ClinicalTripReport. ProtocolSiteId Site row ID. Character data ClinicalTripReport. ProtocolTitle Protocol title. Character data ClinicalTripReport. ReviewerComments Reviewer comments. Character data ClinicalTripReport. ReviewerLogin Reviewer login ID. Character data ClinicalTripReport. ApproverComments Approver comments. Character data ClinicalTripReport. SiteName Trip report account. Character data ClinicalTripReport. SiteNumber Site number. Character data ClinicalTripReport. Status Status. Character data ClinicalTripReport. TemplateName Template name. Character data ClinicalTripReport. TripReportCompleted Trip report completed date. Date ClinicalTripReport. TripReportStatus Trip report status. Character data ClinicalTripReport. Type Visit type. Character data LsClinicalSiteVisitAssignee. Id Row ID of the employee in the site visit team. Character data
- 561. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1184.Response Message Description: All SWILSClinicalTripReportInterfaceService Query LsClinicalSiteVisitAssignee. ActivityId Activity ID of the employee in the site visit team. Character data LsClinicalSiteVisitAssignee. ConfigurationName Configuration name. Character data LsClinicalSiteVisitAssignee. EMailAddr Email address. Character data LsClinicalSiteVisitAssignee. EmpId Employee ID. Character data LsClinicalSiteVisitAssignee. FirstName Employee first name. Character data LsClinicalSiteVisitAssignee. IsPrimaryOwner Is Primary Owner flag. Character data LsClinicalSiteVisitAssignee. JobTitle Job title. Character data LsClinicalSiteVisitAssignee. LastName Employee last name. Character data LsClinicalSiteVisitAssignee. Phone Phone number. Character data LsClinicalSiteVisitAssignee. ShiftName Shift name. Character data LsClinicalSiteVisitAssignee. UserId User ID. Character data LSClinicalSiteVisitAssignee_Position. Division Division. Character data LSClinicalSiteVisitAssignee_Position. Name Position name. Character data LSClinicalSiteVisitAssignee_Responsibility. Responsibility. Character data Responsibility LSClinicalSiteVisitAssignee_Responsibility. PrimaryOrganization Primary organization. Character data ListOfLSClinicalSiteVisitAssignee_Subcontractor. Subcontractor Name Subcontractor name. Character data ClinicalAttendee. Id Row ID of the attendee. Character data ClinicalAttendee. DisplayRole Display role. Character data ClinicalAttendee. EmployeeFlag Employee flag. Boolean ClinicalAttendee. FirstName First name. Character data ClinicalAttendee. LastName Last name. Character data ClinicalAttendee. Position Position. Character data ClinicalAttendeeStatic. Id Attendees row ID. Character data ClinicalAttendeeStatic. ActivityId Attendee Activity ID. Character data ClinicalAttendeeStatic. ContactId Contact ID Character data ClinicalChecklist. Id Checklist row ID Character data ClinicalChecklist. ActivityUID Checklist Activity ID. Character data Siebel CRM Web Services Reference Version 8.1/8.2 561 Operations Node Description Type
- 562. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1184.Response Message Description: All SWILSClinicalTripReportInterfaceService Query Operations Node Description Type ClinicalChecklist. Category Category. Character data ClinicalChecklist. CreatedByName Created user name. Character data ClinicalChecklist. Description Description. Character data ClinicalChecklist. Display Display. Character data ClinicalChecklist. ParentActivityId Parent activity ID. Character data ClinicalChecklist. ShortComment Comments. Character data ClinicalChecklist. Status Status. Character data ClinicalChecklist. Type Type. Character data LsClinicalChecklistAssignee. Id Checklist assignee row Siebel CRM Web Services Reference Version 8.1/8.2 562 ID. Character data LsClinicalChecklistAssignee. ActivityId Activity ID. Character data LsClinicalChecklistAssignee. ConfigurationName Configuration name. Character data LsClinicalChecklistAssignee. EMailAddr Email address. Character data LsClinicalChecklistAssignee. FirstName First name. Character data LsClinicalChecklistAssignee. IsPrimaryOwner Is Primary Owner flag. Character data LsClinicalChecklistAssignee. JobTitle Job title. Character data LsClinicalChecklistAssignee. LastName Last name. Character data LsClinicalChecklistAssignee. Phone Phone number. Character data LsClinicalChecklistAssignee. UserId User ID. Character data LsClinicalChecklistAssignee. ShiftName Schedule name. Character data LsClinicalChecklistAssignee. EmpId Employee ID. Character data ClinicalFollowUp. Id Clinical followup row ID. Character data ClinicalFollowUp. ActivityUID Activity ID. Character data ClinicalFollowUp. Category Category. Character data ClinicalFollowUp. CreatedByName Created user name. Character data ClinicalFollowUp. Description Description. Character data ClinicalFollowUp. Display Display. Character data ClinicalFollowUp. Done Completed date. UTC Date Time ClinicalFollowUp. Due Due date. UTC Date Time ClinicalFollowUp. ParentActivityId Parent activity ID Character data
- 563. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1184.Response Message Description: All SWILSClinicalTripReportInterfaceService Query ClinicalFollowUp. ShortComment Comments. Character data ClinicalFollowUp. Status Status. Character data ClinicalFollowUp. Type Activity type. Character data LsClinicalFollowUpAssignee. Id Followup assignee row ID. Character data LsClinicalFollowUpAssignee. ActivityId Activity ID. Character data LsClinicalFollowUpAssignee. ConfigurationName Configuration name. Character data LsClinicalFollowUpAssignee. EmailAddr Email address. Character data LsClinicalFollowUpAssignee. EmpId Employee ID. Character data LsClinicalFollowUpAssignee. FirstName First name. Character data LsClinicalFollowUpAssignee. IsPrimaryOwner Is Primary Owner flag. Character data LsClinicalFollowUpAssignee. JobTitle Job title. Character data LsClinicalFollowUpAssignee. LastName Last name. Character data LsClinicalFollowUpAssignee. Phone Phone number. Character data LsClinicalFollowUpAssignee. ShiftName Schedule name. Character data LsClinicalFollowUpAssignee. UserId User ID. Character data LSClinicalFollowUpAssignee_Position. Division Position division. Character data LSClinicalFollowUpAssignee_Position. Name Position. Character data LSClinicalFollowUpAssignee_Responsibility. Responsibility. Character data Responsibility LSClinicalFollowUpAssignee_Subcontractor. SubcontractorName Subcontractor name. Character data ClinicalFollowUpSiteLevel. Id Followup site level row ID. Character data ClinicalFollowUpSiteLevel. ActivityUID Activity ID. Character data ClinicalFollowUpSiteLevel. Category Category. ClinicalFollowUpSiteLevel. CreatedByName Created user name. Character data ClinicalFollowUpSiteLevel. Description Description. Character data ClinicalFollowUpSiteLevel. Display Display. Character data ClinicalFollowUpSiteLevel. Done Completed date. UTC Date Time ClinicalFollowUpSiteLevel. Due Due date. UTC Date Time Siebel CRM Web Services Reference Version 8.1/8.2 563 Operations Node Description Type
- 564. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1184.Response Message Description: All SWILSClinicalTripReportInterfaceService Query Operations Node Description Type ClinicalFollowUpSiteLevel. ParentActivityId Parent activity ID. Character data ClinicalFollowUpSiteLevel. ShortComment Comments. Character data ClinicalFollowUpSiteLevel. Status Status. Character data ClinicalFollowUpSiteLevel. Type Type. Character data LsClinicalFollowUpSiteLevelAssignee. Id Site level assignee row Siebel CRM Web Services Reference Version 8.1/8.2 564 ID. Character data LsClinicalFollowUpSiteLevelAssignee. ActivityId Activity ID. Character data LsClinicalFollowUpSiteLevelAssignee. Configuration name. Character data ConfigurationName LsClinicalFollowUpSiteLevelAssignee. EMailAddr Email address. Character data LsClinicalFollowUpSiteLevelAssignee. EmpId Employee ID. Character data LsClinicalFollowUpSiteLevelAssignee. FirstName First Name Character data LsClinicalFollowUpSiteLevelAssignee. The Primary Owner flag. Character data IsPrimaryOwner LsClinicalFollowUpSiteLevelAssignee. JobTitle Job title. Character data LsClinicalFollowUpSiteLevelAssignee. LastName Last name. Character data LsClinicalFollowUpSiteLevelAssignee. Phone Phone. Character data LsClinicalFollowUpSiteLevelAssignee. ShiftName Shift name. Character data LsClinicalFollowUpSiteLevelAssignee. UserId User ID. Character data LSClinicalFollowUpSiteLevelAssignee_Position. Position division. Character data Division LSClinicalFollowUpSiteLevelAssignee_Position. Name Position. Character data LSClinicalFollowUpSiteLevelAssignee_Responsibilit y. Responsibility Responsibility. Character data LSClinicalFollowUpSiteLevelAssignee_Subcontracto r. SubcontractorName Contractor name. Character data LsCaseReportFormsTracking. Id Case report form row ID. Character data LsCaseReportFormsTracking. CRFPages Number of case report form pages. Number LsCaseReportFormsTracking. ActivityType Activity type. Character data LsCaseReportFormsTracking. ActivityUID Activity ID. Character data LsCaseReportFormsTracking. Category Category. Character data
- 565. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Table 1184.Response Message Description: All SWILSClinicalTripReportInterfaceService Query LsCaseReportFormsTracking. Comments Comments. Character data LsCaseReportFormsTracking. OwnedById Owner user ID. Character data LsCaseReportFormsTracking. ParentActivityId Parent activity ID. Character data LsCaseReportFormsTracking. Template version. Character data ParentTemplateVersion LsCaseReportFormsTracking. PrivateFlag Private flag. Boolean LsCaseReportFormsTracking. Retrieved Retrieved flag. Character data LsCaseReportFormsTracking. RetrievedDate Retrieved date. UTC Date Time LsCaseReportFormsTracking. Source Document Boolean SourceDocumentVerified Verified flag. LsCaseReportFormsTracking. SourceDocumentVerifiedDate Source document verification date UTC Date Time LsCaseReportFormsTracking. SubjectInitial Subject initial. Character data LsCaseReportFormsTracking. SubjectNumber Subject number. Character data LsCaseReportFormsTracking. Visit Visit name. Character data LsCaseReportFormsTracking. VisitType Visit type. Character data LsClinicalGeoLocation. Id Geo location row ID. Character data LsClinicalGeoLocation. Comments Comments. Character data LsClinicalGeoLocation. EmpId Employee ID. Character data LsClinicalGeoLocation. Latitude Latitude. Number LsClinicalGeoLocation. LoginId Login user. Character data LsClinicalGeoLocation. Longitude Longitude. Number LsClinicalGeoLocation. SiteVisitId Site visit row ID. Character data LsClinicalGeoLocation. VisitDate Visit date. Date Time SWILSClinicalTripReportInterfaceService 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. Siebel CRM Web Services Reference Version 8.1/8.2 565 Operations Node Description Type
- 566. Siebel CRM Primary Web Services ■ SWILSClinicalTripReportInterface Service Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 1185. Table 1185.SWILSClinicalTripReportInterfaceService Service Object Name Boundary Object Type Class LS Clinical Trip Report Interface Services Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1186. Example Package for SWILSClinicalTripReportInterfaceService To view an example of messages 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. Request See the following file to view the sample code: ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- QueryByExample-request.xml ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- QueryPage-request.xml ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- QueryById-request.xml ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- InsertOrUpdate-request.xml ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- Update-request.xml ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- Synchronize-request.xml Siebel CRM Web Services Reference Version 8.1/8.2 566 Business Service CSSEAIDataSyncService Table 1186.SWILSClinicalTripReportInterfaceService Data Object Siebel Repository Name External Name LS Clinical Trip Report Interface IO Clinical Trip Report
- 567. Siebel CRM Primary Web Services ■ SWI LS Medical Product Issue Create Inbox Item Inbound Interface Description (WSDL) for SWILSClinicalTripReportInterfaceService 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. ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- QueryByExample.WSDL ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- QueryPage.WSDL ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- QueryById.WSDL ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- InsertOrUpdate.WSDL ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- Synchronize.WSDL ...SWILSClinicalTripReportInterfaceServiceSWILSClinicalTripReportInterfaceService- Update.WSDL SWI LS Medical Product Issue Create Inbox Item Inbound Use this Web service to create inbox items with provided comments to invoke a message to owners of a product issue in Siebel Life Sciences. An external application invokes this Web service with a required product issue ID, and, optionally, with comments. When the inbox items are created with the product issue number as the subject, the product issue owners click the hyperlink to navigate to the corresponding product issue. An error message is returned in the event of failed connection attempts. SWI LS Medical Product Issue Create Inbox Item Inbound Operations For a list of operations associated with this Web service, see Table 1187. Table 1187.SWI LS Medical Product Issue Create Inbox Item Inbound Operations Name Description LS Medical Product Issue Create Inbox Item Creates an inbox item for the product issue Inbound ID provided in the Web service Siebel CRM Web Services Reference Version 8.1/8.2 567
- 568. Siebel CRM Primary Web Services ■ SWI LS Medical Product Issue Create Inbox Item Inbound Request Message Description: LS Medical Product Issue Create Inbox Item Inbound For a description of this request message, see Table 1188. Table 1188.Request Message Description: LS Medical Product Issue Create Inbox Item Inbound Node Description Type Id Required. The product issue ID. Character data OwnerComments Optional. The message that is Response Message Description: LS Medical Product Issue Create Inbox Item Inbound There is no response message for operation. SWI LS Medical Product Issue Create Inbox Item Inbound 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 (Workflow) For a description of the service objects for this Web service, see Table 1189. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1190. Example Package for SWI LS Medical Product Issue Create Inbox Item Inbound To view an example of messages 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. Siebel CRM Web Services Reference Version 8.1/8.2 568 passed to the product issue owners. Character data Table 1189.SWI Medical Product Issue Create Inbox Item Inbound Service Object Name Boundary Object Type Class LS Medical Product Issue Create Inbox Item Inbound Workflow Not applicable Table 1190.SWI Medical Product Issue Create Inbox Item Inbound Data Object Siebel Repository Name External Name LSMedicalFromSafetyIntegProductIssueInterface LS Medical Product Issue
- 569. Siebel CRM Primary Web Services ■ SWI LS Medical Update Product Issue Inbound Request See the following file to view the sample code: ...LSMedicalProductIssueCreateInboxItem_request.xml Interface Description (WSDL) for SWI LS Medical Product Issue Create Inbox Item Inbound 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. ...LSMedicalProductIssueSWI_LS_Medical_Product_Issue_Create_Inbox_Item_Inbound.wsdl SWI LS Medical Update Product Issue Inbound Use this Web service to update product issue information such as AE Case ID, Safety Received Date, Status, and so on in Siebel Life Sciences. An external application invokes this Web service with the product issue ID, and with the new data updates to the information already in the Siebel database. An error message is returned in the event of failed connection attempts. SWI LS Medical Update Product Issue Inbound Operations For a list of operations associated with this Web service, see Table 1191. Table 1191.SWI LS Medical Update Product Issue Inbound Operations Name Description LS Medical Update Product Issue Inbound Updates Product Issue information such as AE Case ID, Safety Received Date, and Status Request Message Description: LS Medical Update Product Inbound For a description of this request message, see Table 1192. Table 1192.Request Message Description: LS Medical Update Product Inbound Node Description Type Id Required. The product issue ID. Character data AECaseId Optional. Corresponding safety system ID. Character data Siebel CRM Web Services Reference Version 8.1/8.2 569
- 570. Siebel CRM Primary Web Services ■ SWI LS Medical Update Product Issue Inbound Table 1192.Request Message Description: LS Medical Update Product Inbound Node Description Type SafetyReceivedDate Optional. The date on which safety Response Message Description: LS Medical Update Product Inbound There is no response message for operation. SWI LS Medical Update Product Issue Inbound 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 (Workflow) For a description of the service objects for this Web service, see Table 1193. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1194. Example Package for SWI LS Medical Update Product Issue Inbound To view an example of messages 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. Request See the following file to view the sample code: ...LSMedicalProductIssueUpdateProductIssue_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 570 system accepted the product issue. Date Status Optional. The status of the product issue. Character data Table 1193.SWI Medical Update Product Issue Inbound Service Object Name Boundary Object Type Class LS Medical Update Product Issue Inbound Workflow Not applicable Table 1194.SWI Medical Product Issue Create Inbox Item Inbound Data Object Siebel Repository Name External Name LSMedicalFromSafetyIntegProductIssueInterface LS Medical Product Issue
- 571. Siebel CRM Primary Web Services ■ SWIMergeServices Interface Description (WSDL) for SWI LS Medical Update Product Issue Inbound 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. ...LSMedicalProductIssueSWI_LS_Medical_Update_Product_Issue_Inbound.wsdl SWIMergeServices Use this inbound Web service to support merging of Account, Contact and Address records. SWIMergeServices Operations For a list of operations associated with this Web service, see Table 1195. Table 1195.FetchAccountSiebelReqABCSImpl Operations Name Description SWIMergeServices Calls the Merge method of the business service SWI Merge Service which is used for merging one or more accounts to another account record. This Web service merges child records of the losing objects to the wining object and deletes the losing object records. Takes the business object name, business component name, one winning record's ID value and one or more losing record's ID values as the arguments in .xml format. Request Message Description: SWIMergeServices Specifies the Siebel business object name and business component name, one wining object record‘s ID values and one or more losing objects record’s ID values. For a description of this request message, see Table 1196. Table 1196.Request Message Description: SWIMergeServices Node Description Type ListOfSWImergeobjectIO An instance of the integration object ListofSWImergeobjectIO. Integration Object The following nodes apply to ListOfSWImergeobjectIO. SWIMergeObject BusinessComponentName Name of business component. String BusinessObjectName Name of business object. String MergeId ID number assigned to merged item. String Siebel CRM Web Services Reference Version 8.1/8.2 571
- 572. Siebel CRM Primary Web Services ■ SWIMergeServices Table 1196.Request Message Description: SWIMergeServices Node Description Type ListofSWILosingObject Container element for the Losing Object Response Message Description: SWIMergeServices For a description of this response message, see Table 1197. Siebel CRM Web Services Reference Version 8.1/8.2 572 details which is an instance of the VBC SWI Losing Object. Contains the details of the object that is merged to another object. Integration Component SWILosingObject Losing object. String LosingObjectId Losing object ID. String ParentRowId Parent row ID of losing object. String ListOfSWIWinningObject Container element for the Winning Object details which is an instance of the VBC SWI Winning Object. Contains the details of the object that is merged to another object. Integration Component SWIWinningObject Winning object. String ParentRowId Parent row ID of winning object. String WinningObjectId Winning object ID. String Table 1197.Response Message Description: SWIMergeServices Node Description Type ListOfSWImergeobjectIO An instance of the integration object ListofSWImergeobjectIO. Integration Object The following nodes apply to ListOfSWImergeobjectIO SWIMergeObject Integration object name. Integration Object BusinessComponentName Name of the business component. String BusinessObjectName Name of the business object. String MergeId ID number assigned to merged item. String ListofSWILosingObject Container element for the Losing Object details which is an instance of the VBC SWI Losing Object. Contains the details of the object that is merged to another object. Integration Component SWILosingObject Losing object. String LosingObjectId Losing object ID. String ParentRowId Parent row ID of losing object. String
- 573. Siebel CRM Primary Web Services ■ SWIOrderUpsert Table 1197.Response Message Description: SWIMergeServices Node Description Type ListOfSWIWinningObject Container element for the Winning Object details which is an instance of the VBC SWI Winning Object. Contains the details of the object that is merged to another object. Integration Component SWIWinningObject Winning object. String ParentRowId Parent row ID of winning object. String WinningObjectId Winning object ID. String SWIMergeServices 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 1198. Table 1198.SWIMergeServices Service Object Siebel Repository Name Boundary Object Type Class SWIMergeServices Business Service CSSMergeService Data Object (Integration Object) For a description of data objects for this Web service, see Table 1199. Table 1199.SWIMergeServices Data Object Siebel Repository Name External Name SWIMergeObjectIO SWI Merge Object SWIOrderUpsert Use this Web service to perform the following basic operations on a sales order: ■ Back up the order. ■ Update or insert (upsert) the order. ■ Cascade down updates to the order. ■ Trigger an auto asset for the order. Siebel CRM Web Services Reference Version 8.1/8.2 573
- 574. Siebel CRM Primary Web Services ■ SWIOrderUpsert SWIOrderUpsert Operations For a list of operations associated with this Web service, see Table 1200. Table 1200.SWIOrderUpsert Operations Name Description SWIOrderUpsert Inserts or updates order details Request Message Description: SWIOrderUpsert For a description of this request message, see Table 1201. Table 1201.Request Message Description: SWIOrderUpsert Node Description Type SWIOrderIO Required Integration Object Auto-Asset Flag Optional String Backup Order Flag Optional String Cascade Down Flag Optional String UTCCanonical A value of Y means that all date-type Response Message Description: SWIOrderUpsert For a description of this response message, see Table 1202. SWIOrderUpsert 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 (Workflow) For a description of the service objects for this Web service, see Table 1203. Siebel CRM Web Services Reference Version 8.1/8.2 574 fields in the payload are in UTC standard format. String Table 1202.Response Message Description: SWIOrderUpsert Node Description Type SWIOrderIO Required. An instance of the integration object SWIOrder. Integration Object Table 1203.SWIOrderUpsert Service Object Name Boundary Object Type Class SWIOrderupsert Workflow Not applicable.
- 575. Siebel CRM Primary Web Services ■ SWI Price List IO Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1204. Table 1204.SWIOrderUpsert Data Object Siebel Repository Name External Name SWIOrderIO PDS Simplified Order Interface Description (WSDL) for SWIOrderIO 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. ...SWIOrderUpsertSWIOrderIO.wsdl SWI Price List IO Use this Web service for querying, creating, updating, and deleting price lists. The Web service enables you to associate an existing organization or many organizations with a price list. For working with price list line items, see “SWIISSPriceListItemIO” on page 580. SWIPriceList Operations For a list of operations associated with this Web service, see Table 1205. Table 1205.SWIPriceList Operations Name Description SWIPriceList_Insert Creates a price list. SWIPriceList_Update Provides the name of the price list along with the updated field values and the operation updates the price list. SWIPriceList_QueryByExample Provides the price list using a unique value, such as name, and all price list details are returned. SWIPriceList_QueryById Provides price list ID and all price list details are returned. SWIPriceList_Delete Deletes an existing price list. Siebel CRM Web Services Reference Version 8.1/8.2 575
- 576. Siebel CRM Primary Web Services ■ SWI Price List IO Request Message Description: SWIPriceList_Insert For a description of this request message, see Table 1206. Table 1206.Request Message Description: SWIPriceList_Insert Node Description Type SWI Price List IO Required. An instance of the Response Message Description: SWIPriceList_Insert For a description of this response message, see Table 1207. Request Message Description: SWIPriceList_Update For a description of this request message, see Table 1208. Response Message Description: SWIPriceList_Update For a description of this response message, see Table 1209. Siebel CRM Web Services Reference Version 8.1/8.2 576 Integration Object Price List. Price List is the parent header and Organization is the child. Integration Object Table 1207.Response Message Description: SWIPriceList_Insert Node Description Type ID The price list ID created after an insert operation. String Name The name of the price list. String. Table 1208.Request Message Description: SWIPriceList_Update Node Description Type SWI Price List IO Required. An instance of the Integration Object Price List. Price List is the parent header and Organization is the child. Integration Object Table 1209.Response Message Description: SWIPriceList_Update Node Description Type ID The price list ID created after an update operation. String Name The name of the price list. String.
- 577. Siebel CRM Primary Web Services ■ SWI Price List IO Request Message Description: SWIPriceList_QueryByExample For a description of this request message, see Table 1210. Table 1210.Request Message Description: SWIPriceList_QueryByExample Node Description Type SWI Price List IO Required. An instance of the Integration Object Price List. Price List is the parent header and Organization is the child. Response Message Description: SWIPriceList_QueryByExample For a description of this response message, see Table 1211. Table 1211.Response Message Description: SWIPriceList_QueryByExample Node Description Type ID The price list ID displayed after an query operation. Name The name of the price list. String. Organization Organization name of the price list. Request Message Description: SWIPriceList_QueryById For a description of this request message, see Table 1212. Table 1212.Request Message Description: SWIPriceList_QueryById Node Description Type SWI Price List IO Required. An instance of the Integration Object Price List. Price List is the parent header and Organization is the child. Response Message Description: SWIPriceList_QueryById For a description of this response message, see Table 1213. Integration Object String String Integration Object Table 1213.Response Message Description: SWIPriceList_QueryById Node Description Type ID The price list ID displayed after the query operation. String Siebel CRM Web Services Reference Version 8.1/8.2 577
- 578. Siebel CRM Primary Web Services ■ SWI Price List IO Table 1213.Response Message Description: SWIPriceList_QueryById Node Description Type Name The name of the price list. String. Organization Organization name of the price Request Message Description: SWIPriceList_Delete For a description of this request message, see Table 1214. Response Message Description: SWIPriceList_Delete For a description of this response message, see Table 1215. SWI Price List IO 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 1216. Siebel CRM Web Services Reference Version 8.1/8.2 578 list. String Table 1214.Request Message Description: SWIPriceList_Delete Node Description Type SWI Price List IO Required. An instance of the Integration Object Price List. Price List is the parent header, and Organization is the child. Integration Object Table 1215.Response Message Description: SWIPriceList_Delete Node Description Type ID The price list ID deleted after the delete operation. String Name The name of the price list. String. Table 1216.SWI Price List IO Service Object Name Boundary Object Type Class SWI Price List BS Business Service CSSEAIDataSyncService
- 579. Siebel CRM Primary Web Services ■ SWI Price List IO Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1217. Table 1217.SWI Price List IO Data Object Siebel Repository Name External Name SWI Price List IO Admin Price List Example Package for SWI Price List IO To view an example of messages 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. Request See the following files to view the sample code: ...SWIPriceListIODeleterequest.xml ...SWIPriceListIOInsertrequest.xml ...SWIPriceListIOQueryByExamplerequest.xml ...SWIPriceListIOQueryByIdrequest.xml ...SWIPriceListIOUpdaterequest.xml Response See the following files to view the sample code: ...SWIPriceListIODeleteresponse.xml ...SWIPriceListIOInsertresponse.xml ...SWIPriceListIOQueryByExampleresponse.xml ...SWIPriceListIOQueryByIdresponse.xml ...SWIPriceListIOUpdateresponse.xml Interface Description (WSDL) for SWI Price List IO 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. ...SWIPriceListIOWSDLhttp_siebel_asi_SWIPriceList.WSDL Siebel CRM Web Services Reference Version 8.1/8.2 579
- 580. Siebel CRM Primary Web Services ■ SWIISSPriceListItemIO SWIISSPriceListItemIO Use this inbound Web service to perform basic operations, such as create, update, modify, and delete price list line items. SWIISSPriceListItemIO Operations For a list of operations associated with this Web service, see Table 1218. Table 1218.SWIISSPriceListItemIO Operations Name Description SWIPriceListItemInsert Creates a price list line item. SWIPriceListItemUpdate Updates a price list line item. SWIPriceListItemUpsert Inserts or updates a price list item. SWIPriceListItemDelete Deletes a price list line item. Request Message Description: SWIPriceListItemInsert For a description of this request message, see Table 1219. Table 1219.Request Message Description: SWIPriceListItemInsert Node Description Type SWIISSPriceListItemIO Required. An instance of the Integration Response Message Description: SWIPriceListItemInsert For a description of this response message, see Table 1220. Siebel CRM Web Services Reference Version 8.1/8.2 580 Object SWIISSPriceListItem. To insert a price list line item, note that price list (PriceListId), product (ProductId) and start date (StartDate) are user keys and the payload must provide these fields. Integration Object Table 1220.Response Message Description: SWIPriceListItemInsert Node Description Type PriceListItemID The PriceListItemID that is created after the insert operation. String PriceListId The PriceListID that is associated with PriceListItemID. String ProductId The Product ID that is associated to PriceListItemID. String StartDate Start date of the price list. StartDate is part of the user key. String
- 581. Siebel CRM Primary Web Services ■ SWIISSPriceListItemIO Request Message Description: SWIPriceListItemUpdate For a description of this request message, see Table 1221. Table 1221.Request Message Description: SWIPriceListItemUpdate Node Description Type SWIISSPriceListItemIO Required. An instance of the integration object SWIISSPriceListItem. To update an existing price list line item, price list (PriceListId), product (ProductId) and start date (StartDate) are user keys and payload must provide these fields. Response Message Description: SWIPriceListItemUpdate For a description of this response message, see Table 1222. Table 1222.Response Message Description: SWIPriceListItemUpdate Node Description Type PriceListItemID The PriceListItemID that is updated after the update operation. PriceListId The PriceListID that is associated with PriceListItemID ProductId The Product ID that is associated to PriceListItemID. Request Message Description: SWIPriceListItemUpsert For a description of this request message, see Table 1223. Integration Object String String String Table 1223.Request Message Description: SWIPriceListItemUpsert Node Description Type SWIISSPriceListItemIO Required. An instance of the integration object SWIISSPriceListItem. Price List Item - Import is the parent header. Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 581
- 582. Siebel CRM Primary Web Services ■ SWIISSPriceListItemIO Response Message Description: SWIPriceListItemUpsert For a description of this response message, see Table 1224. Table 1224.Response Message Description: SWIPriceListItemUpsert Node Description Type PriceListItemID The PriceListItemID that is created or updated after Request Message Description: SWIPriceListItemDelete For a description of this request message, see Table 1225. Response Message Description: SWIPriceListItemDelete For a description of this response message, see Table 1226. SWIISSPriceListItemIO 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. Siebel CRM Web Services Reference Version 8.1/8.2 582 the upsert operation. String PriceListId The PriceListID that is associated with PriceListItemID String ProductId The Product ID that is associated to PriceListItemID. String Table 1225.Request Message Description: SWIPriceListItemDelete Node Description Type SWIISSPriceListItemIO Required. An instance of the integration object SWIISSPriceListItem. Price List Item - Import is the parent header. Integration Object Table 1226.Response Message Description: SWIPriceListItemDelete Node Description Type PriceListItemID The PriceListItemID of the record that is deleted after the delete operation. String PriceListId The PriceListID that is associated with PriceListItemID String ProductId The Product ID that is associated to PriceListItemID. String
- 583. Siebel CRM Primary Web Services ■ SWIISSPriceListItemIO Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 1227. Table 1227.SWIISSPriceListItemIO Service Object Name Boundary Object Type Class SWIPriceListItem Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1228. Table 1228.SWIISSPriceListItemIO Data Object Siebel Repository Name External Name SWIISSPriceListItemIO Admin Price List Example Package for SWIISSPriceListItemIO 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 See the following file to view the sample code: ...SWIPriceListItemInsertSWIPriceListItemInsert_request.xml ...SWIPriceListItemUpdateSWIPriceListItemUpdate_request.xml ...SWIPriceListItemUpsertSWIPriceListItemUpsert_request.xml ...SWIPriceListItemDeleteSWIPriceListItemDelete_request.xml Response See the following file to view the sample code: ...SWIPriceListItemInsertSWIPriceListItemInsert_response.xml ...SWIPriceListItemUpdateSWIPriceListItemUpdate_response.xml ...SWIPriceListItemUpsertSWIPriceListItemUpsert_response.xml ...SWIPriceListItemDeleteSWIPriceListItemDelete_response.xml Interface Description (WSDL) for SWIISSPriceListItemIO To view the interface description 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. Siebel CRM Web Services Reference Version 8.1/8.2 583
- 584. Siebel CRM Primary Web Services ■ SWIProductAttributeImport ...SWIISSPriceListItemIOSWIISSPriceListItemIO.wsdl SWIProductAttributeImport Use this Web service to perform basic operations on attributes. SWIProductAttributeImport Operations For a list of operations associated with this Web service, see Table 1229. Table 1229.SWIProductAttributeImport Operations Name Description SWIAttributeImportUpsert Creates a new or updates an existing attribute. Request Message Description: SWIProductAttributeImport For a description of this request message, see Table 1230. Table 1230.Request Message Description: SWIProductAttributeImport Node Description Type SWIAttributeIntegrationIO Required. An instance of the integration Response Message Description: SWIProductAttributeImport For a description of this response message, see Table 1231. Siebel CRM Web Services Reference Version 8.1/8.2 584 object SWIAttributeIntegration Integration Object SyncChild Upsert operation behaves as Synchronize if SyncChild flag is set to Y. NOTE: The default value of this flag is Y. String UTCCanonical A value of Y means that all date-type fields in the payload are in UTC standard format. String Table 1231.Response Message Description: SWIProductAttributeImport Node Description Type SWIAttributeIntegrationIO Returns an instance of the integration object SWIAttributeIntegration. NOTE: Returns only those fields specified in the status key of Integration components that are part of SWI Admin ISS Attribute Definition integration object. Integration Object. Error Message Error message (if any). String
- 585. Siebel CRM Primary Web Services ■ SWIProductAttributeImport SWIProductAttributeImport 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 1232. Table 1232.SWIProductAttributeImport Service Object Siebel Repository Name Boundary Object Type Class SWI Attribute Import Business Service CSSCMUProdWebSvc Data Object (Integration Object) For a description of data objects for this Web service, see Table 1233. Table 1233.SWIProductAttributeImport Data Object Siebel Repository Name External Name SWIAttributeIntegrationIO SWI Attribute Integration SWI Admin ISS Attribute Definition SWI Admin ISS Attribute Definition Methods For a description of the methods for this Web service, see Table 1234. Table 1234.SWIProductAttributeImport Methods Operation Method SWIAttributeImportUpsert Insert or Update Example Package for SWIProductAttributeImport To view an example of messages 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. Request See the following file to view the sample code: ...SWIProductAttributeImportSWIProductAttributeImport_request.xml Response See the following file to view the sample code: Siebel CRM Web Services Reference Version 8.1/8.2 585
- 586. Siebel CRM Primary Web Services ■ SWIProductClassImport ...SWIProductAttributeImportSWIProductAttributeImport_response.xml Interface Description (WSDL) for SWIProductAttributeImport 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. ...SWIProductAttributeImportSWIProductAttributeImport.wsdl SWIProductClassImport Use this Web service to perform basic operations on Product Class. SWIProductClassImport Operations For a list of operations associated with this Web service, see Table 1235. Table 1235.SWIProductClassImport Operations Name Description SWIClassImportUpsert Creates a new or updates an existing product class. Request Message Description: SWIClassImportUpsert For a description of this request message, see Table 1236. Table 1236.Request Message Description: SWIClassImportUpsert Node Description Type SWIProductClassIntegrationIO Required. An instance of the integration Siebel CRM Web Services Reference Version 8.1/8.2 586 object SWIProductClassIntegration. Integration Object SyncChild Upsert operation behaves as Synchronize if SyncChild flag is set to Y. NOTE: The default value of this flag is N. String UTCCanonical A value of Y means that all date-type fields in the payload are in UTC standard format. String
- 587. Siebel CRM Primary Web Services ■ SWIProductClassImport Response Message Description: SWIClassImportUpsert For a description of this response message, see Table 1237. Table 1237.Response Message Description: SWIClassImportUpsert Node Description Type SWIProductClassIntegrationIO Required. An instance of the integration object SWIProductClassIntegration. NOTE: Returns only those fields specified in the status key of Integration components that are part of SWI Admin ISS Class VOD Definition integration object. Integration Object. SWIClassImportUpsert 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 1238. Table 1238.SSWIClassImportUpsert Service Object Siebel Repository Name Boundary Object Type Class SWI Product Class Import Business Service CSSCMUProdWebSvc Data Object (Integration Object) For a description of data objects for this Web service, see Table 1239. Table 1239.SWIClassImportUpsert Data Object Siebel Repository Name External Name SWIProductClassIntegrationIO SWI Class Integration SWI Admin ISS Class VOD Definition SWI Admin ISS Class VOD Definition Methods For a description of the methods for this Web service, see Table 1240. Table 1240.SWIClassImportUpsert Methods Operation Method SWIClassImportUpsert Insert or Update Siebel CRM Web Services Reference Version 8.1/8.2 587
- 588. Siebel CRM Primary Web Services ■ SWIProductImport Example Package for SWIProductClassImport To view an example of messages 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. Request See the following file to view the sample code: ...SWIProductClassImportSWIProductClassImport_request.xml NOTE: The following xml tags in the SwiProductStructureVbc/ container refer to the parent class instead of the product. <ProductId/> < ProductName/> < ProductVendorId/> < ProductBusinessUnitId/> Response See the following file to view the sample code: ...SWIProductClassImportSWIProductClassImport_response.xml Interface Description (WSDL) for SWIProductClassImport 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. ...SWIProductClassImportSWIProductClassImport.wsdl SWIProductImport Use this inbound Web service to support Insert or Update of product details which allows the import of external product information into the Siebel database. Also consider the following: ■ The Web service is only available with Oracle Application Integration Architecture and has been created for syncronizing Oracle products with Siebel CRM products. ■ This Web service supports a subset of the Siebel ISS Authoring Import Export service functionality. ■ This Web service uses the Siebel EAI interface. Siebel CRM Web Services Reference Version 8.1/8.2 588
- 589. Siebel CRM Primary Web Services ■ SWIProductImport SWIProductImport Operations For a list of operations associated with this Web service, see Table 1241. Table 1241.SWIProductImport Operations Name Description SWIProductImportUpsert Calls the Insert or Update method of the business service SWI Product Import used for inserting new product details into the Siebel database. If the product is already present, then the product is updated with the details from the request message. Request Message Description: SWIProductImportUpsert Insert one or more products into the Siebel database. If the Product is already present in the Siebel database, then the Product record will be updated with the details from the request message. For a description of this request message, see Table 1242. Table 1242.Request Message Description: SWIProductImportUpsert Node Description Type SWIProductIntegrationIO Required. An instance of the integration object SWIProductIntegration. Integration Object SyncChild The upsert operation behaves as a synchronize operation if the SyncChild flag is set to Y. NOTE: The default value of this flag is Y. String UTCCanonical A value of Y means that all date-type fields in the payload are in UTC standard format. String ActiveFlag Indicates whether record is active. String BillableFlag Indicates whether record is billable. String BusinessUnitId ID of business unit associated with product record. String Description Description. String EffectiveEndDate Effective end date of record. String EffectiveStartDate Effective start date of record. String ExternalInventorySystemRef Reference number from external inventory system. String IntegrationId Integration ID. String InventoryFlag Flag to indicate if product is tracked in inventory. String LeadTime Lead time for product delivery. String ProductCost Cost of product. String Siebel CRM Web Services Reference Version 8.1/8.2 589
- 590. Siebel CRM Primary Web Services ■ SWIProductImport Table 1242.Request Message Description: SWIProductImportUpsert Node Description Type ProductName Name of product. String ProductSerializedFlag Serialized flag. Indicates if instances of this Response Message Description: SWIProductImportUpsert For a description of this response message, see Table 1243. Siebel CRM Web Services Reference Version 8.1/8.2 590 product are tracked as serialized assets or simply as quantities of product. Instances of a serialized product will each carry a unique serial number (or license number, policy number, and so on). Quantities of non-serialized assets are sometimes tracked as lots which may have a unique lot number. String ProductVersion Version of product. String ReleaseFlag Flag which indicates whether a product will be released at the time of a synchronization. String SalesProductFlag Sales product flag. Sales products appear on the product picklist when a user defines products for an opportunity. String ServiceTerms Service terms associated with product. String ShipFlag Flag to indicate whether a product has to be shipped. String Status Status of product. Active or Inactive. String StructureType Depending on the product type, users are allowed to create a simple bill of materials without using Siebel Configurator. String UnitofMeasure Unit of measure. String ListofProductInvloc Location of product in inventory. String Table 1243.Response Message Description: SWIProductImportUpsert Node Description Type SWIProductIntegrationIO Returns an instance of SWIProductIntegration. NOTE: Returns only those fields specified in the status key of Integration components that are part of SWI Admin ISS Product Definition integration object. Integration Object ErrorMessage Error Message (if any). String Id Product ID. String
- 591. Siebel CRM Primary Web Services ■ SWIProductImport Table 1243.Response Message Description: SWIProductImportUpsert Node Description Type ActiveFlag Indicates whether record is active. String AutoExplodeFlag Indicates whether or not the product needs to be automatically ungrouped and enforce ungrouped quantity equal to 1. String BillableFlag Indicates whether record is billable. String BusinessUnitId ID of business unit associated with product record. String CheckEligibilityFlag Indicates whether or not to apply eligibility and compatibility rules for this product. String Description Description of product. String EffectiveEndTime Effective end date of record. String EffectiveStartTime Effective start date of record. String ExternalInventorySystemRef Reference number from external inventory system. String InclusiveEligibilityFlag Indicates whether or not to process a particular product for inclusive eligibility rules. Inclusive eligibility rules are defined in the eligibility matrix with matrix rule type code set as Inclusive. String IntegrationId Integration ID. String InventoryFlag Flag which indicates if a product is tracked in inventory. String LeadTime Lead time for product delivery. String OrderableFlag Flag which indicates whether a product is orderable. String PriceType Price type, such as One-time, Recurring, Usage and so on. String PrimaryOrganizationId ID of primary organization associated with product record. String ProductCost Cost of product. String ProductId ID of product. String ProductName Name of product. String Siebel CRM Web Services Reference Version 8.1/8.2 591
- 592. Siebel CRM Primary Web Services ■ SWIProductImport Table 1243.Response Message Description: SWIProductImportUpsert Node Description Type ProductSerializedFlag Serialized flag. Indicates if instances of this Siebel CRM Web Services Reference Version 8.1/8.2 592 product are tracked as serialized assets or simply as quantities of product. Instances of a serialized product will each carry a unique serial number (or license number, policy number, and so on). Quantities of non-serialized assets are sometimes tracked as lots which may have a unique lot number. String ProductType Product type. String ProductVersion Product version. String ReleaseFlag Flag which indicates whether a product will be released at the time of a synchronization. String SalesProductFlag Sales product flag. Sales products appear on the product picklist when a user defines products for an opportunity. String ServiceInstanceFlag Flag to indicate whether a product requires a metering point. String ServiceProductFlag Sales and Service flag. Sales service products are services that are priced based on the tangible product for which they are purchased (an extended warranty, for example). These products appear on the picklist that pops up when the user clicks the Service button for a tangible product on a quote. When you choose a sales service product from the list, a new quote item for the product is added to the quote and priced according to the value of the tangible product to which it applies. String ShipFlag Flag to indicate whether a product needs to be shipped. String Status Status of product order. String StructureType Depending on the product type, users can create a simple bill of materials without using Siebel Configurator. String TrackAsAssetFlag Flag to indicate that a product needs to be tracked as an asset. String Type Product type. String UnitofMeasure Unit of measure. String VendorId ID of product vendor. String ListofProductInvLoc Location of product in inventory. String
- 593. Siebel CRM Primary Web Services ■ SWIProductImport SWIProductImport 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 1244. Table 1244.SWIProductImport Service Object Siebel Repository Name Boundary Object Type Class SWIProductImport Business Service CSSCMUProdWebSvc Data Object (Integration Object) For a description of data objects for this Web service, see Table 1245. Table 1245.SWIProductImport Data Object Siebel Repository Name External Name SWIProductIntegrationIO SWI Product Integration SWI Admin ISS Product Definition SWI Admin ISS Product Definition Methods For a description of the methods for this Web service, see Table 1246. Table 1246.SWIProductImport Method Operation Method SWIProductImportUpsert InsertOrUpdate Example Package for SWIProductImport To view an example of messages 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. Request See the following file to view the sample code: ...SWIProductImportSWIProductImport_request.xml Response See the following file to view the sample code: Siebel CRM Web Services Reference Version 8.1/8.2 593
- 594. Siebel CRM Primary Web Services ■ SWIPromotionIntegration ...SWIProductImportSWIProductImport_response.xml Interface Description (WSDL) for SWIProductImport 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. ...SWIProductImportSWIProductIntegrationIO.wsdl SWIPromotionIntegration Use this Web service to perform basic operations on promotions. SWIPromotionIntegration Operations For a list of operations associated with this Web service, see Table 1247. Table 1247.SWIPromotionIntegration Operations Name Description SWIPromotionUpsert Creates a new promotion or updates an existing promotion. Request Message Description: SWIPromotionUpsert For a description of this request message, see Table 1248. Table 1248.Request Message Description: SWIPromotionUpsert Node Description Type SWIPromotionIntegrationIO Required. An instance of the integration The <ComponentPath/> XML tag supports the following two formats: ■ Root Product||Relationship Name::Class/Product Name||Domain product Name::Domain Product Name ■ Root Product||::Class/Product Name::Domain type||Domain product Name::Product Siebel CRM Web Services Reference Version 8.1/8.2 594 object SWIPromotionIntegration. Integration Object SyncChild Upsert operation behaves as Synchronize if SyncChild flag is set to Y. NOTE: The default value of this flag is N. String UTCCanonical A value of Y means that all date-type fields in the payload are in UTC standard format. String
- 595. Siebel CRM Primary Web Services ■ SWIPromotionIntegration Response Message Description: SWIPromotionUpsert For a description of this response message, see Table 1249. Table 1249.Response Message Description: SWIPromotionUpsert Node Description Type SWIPromotionIntegrationIO Returns an instance of SWIPromortionIntegrationIO. NOTE: Returns only those fields specified in the status key of Integration components that are part of SWI ISS Promotion integration object. Integration Object ErrorMessage Error Message (if any). String SWIPromotionIntegration 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 1250. Table 1250.SWIPromotionIntegration Service Object Siebel Repository Name Boundary Object Type Class SWIPromotionImport Business Service CSSSWIPromWebSvc Data Object (Integration Object) For a description of data objects for this Web service, see Table 1251. Table 1251.SWIPromotionIntegration Data Object Siebel Repository Name External Name SWIPromotionIntegrationIO SWI Promotion Integration SWIISSPromotion SWI ISS Promotion Methods For a description of the methods for this Web service, see Table 1252. Table 1252.SWIPromotionIntegration Methods Operation Method SWIPromotionUpsert Insert or Update Siebel CRM Web Services Reference Version 8.1/8.2 595
- 596. Siebel CRM Primary Web Services ■ SWIQuoteUpsert Example Package for SWIPromotionIntegration To view an example of messages 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. Request See the following file to view the sample code: ...SWIPromotionIntegrationSWIPromotionIntegration_request.xml The < ComponentPath/> XML tag supports the following two formats: ■ Root Product||Relationship Name::Class/Product Name||Domain product Name:: Domain Siebel CRM Web Services Reference Version 8.1/8.2 596 Product Name or ■ Root Product||::Class/Product Name::Domain type||Domain product Name::Product Response See the following file to view the sample code: ...SWIPromotionIntegrationSWIPromotionIntegration_response.xml Interface Description (WSDL)a for SWIPromotionIntegration 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. ...SWIPromotionIntegrationSWIPromotionIntegration.wsdl SWIQuoteUpsert Use this Web service to upsert quote details SWIQuoteUpsert Operations For a list of operations associated with this Web service, see Table 1253. Table 1253.SWIQuoteUpsert Operations Name Description SWIQuoteUpsert Inserts or updates quote details.
- 597. Siebel CRM Primary Web Services ■ SWIQuoteUpsert Request Message Description: SWIQuoteUpsert For a description of this request message, see Table 1254. Table 1254.Request Message Description: SWIQuoteUpsert Node Description Type StatusObject Optional String SiebelMessage Required Integration Object UTCCanonical A value of Y means that all date-type fields in the payload are in UTC standard format. Response Message Description: SWIQuoteUpsert For a description of this response message, see Table 1255. String Table 1255.Response Message Description: SWIQuoteUpsert Node Description Type SiebelMessage Required Integration Object SWIQuoteUpsert 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 1256. Table 1256.SWIQuoteUpsert Service Object Siebel Repository Name Boundary Object Type Class SWIQuoteupsert Workflow Not applicable Data Object (Integration Object) For a description of data objects for this Web service, see Table 1257. Table 1257.SWIQuoteUpsert Data Object Siebel Repository Name External Name SWIQuoteIO PDS Simplified Order Siebel CRM Web Services Reference Version 8.1/8.2 597
- 598. Siebel CRM Primary Web Services ■ SWISpecialRatingList SWISpecialRatingList Use this Web service to send updated or modified special rating list details to the Oracle Communications Billing and Revenue Management application for synchronizing when a user clicks the Synchronize button in the Special Rating List applet. SWISpecialRatingList Operations For a list of operations associated with this Web service, see Table 1258. Table 1258.SWISpecialRatingList Operations Name Description SyncSpecialRatingListItems Synchronizes the active special rating items (for example, Phone Request Message Description: SyncSpecialRatingListItems This method is used to synchronize the special rating items. For a description of the request message, see Table 1259. SWISpecialRatingList 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 1260. Siebel CRM Web Services Reference Version 8.1/8.2 598 number) with the external Oracle Communications Billing and Revenue Management application for the updated special rating list. Table 1259.Request Message Description: SyncSpecialRatingListItems Node Description Type ListOfSWISpecialRatin Required. An instance of the integration object gListIO SWISpecialRatingListIO. Integration Object Table 1260.SWISpecialRatingList Service Object Name Boundary Object Type Class SWI Special Rating - Synchronize Process Workflow Not Applicable
- 599. Siebel CRM Primary Web Services ■ SWISubmitOrder Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1261. Table 1261.SWISpecialRatingList Data Object Siebel Repository Name External Name SWISpecialRatingListIO SWI Special Rating List Methods For a description of the methods for this Web service, see Table 1262. Table 1262.SWISpecialRatingList Method Operation Method SyncSpecialRatingListItems SyncSpecialRatingListItems SWISubmitOrder Use this Web service to submit an order to the queue. SWISubmitOrder Operations For a list of operations associated with this Web service, see Table 1263. Table 1263.SWISubmitOrder Operations Name Description process Submits the order request into the Oracle Communications Billing and Revenue Management Advanced Queue (AQ) facility. Request Message Description: process For a description of this request message, see Table 1264. Table 1264.Request Message Description: process Node Description Type CustomHeaderContext Optional Hierarchy SWISubmitOrderReqMsg:ListOfSWIOrderIO Optional Integration Object siebel_transport_param:JMSPriority Optional. Sets the priority for the order processing in the JMS queue. Response Message Description: process There is no response message for this operation. Siebel CRM Web Services Reference Version 8.1/8.2 599
- 600. Siebel CRM Primary Web Services ■ SWISubmitOrder_o2c SWISubmitOrder 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 1265. Table 1265.SWISubmitOrder Service Objects Name Boundary Object Type Class SWISubmitOrder Business Service CSSWSOutboundDispatcher SISOMBillingSubmitOrderWebService Workflow Not Applicable Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1266. Table 1266.SWISubmitOrder Data Object Siebel Repository Name External Name SWIOrderIO PDS Simplified Order Methods For a description of the methods for this Web service, see Table 1267. Table 1267.SWISubmitOrder Method Operation Method Process Process Interface Description (WSDL) for SWISubmitOrder 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. ...WSDLSWISubmitOrder.wsdl SWISubmitOrder_o2c Use this Web service to submit an order for the Order-to-Cash Process Integration Pack (O2C PIP) into the queue. Siebel CRM Web Services Reference Version 8.1/8.2 600
- 601. Siebel CRM Primary Web Services ■ SWISubmitOrder_o2c SWISubmitOrder_o2c Operations For a list of operations associated with this Web service, see Table 1268. Table 1268.SWISubmitOrder_o2c Operations Name Description process Submits an order request into the Oracle Communications Billing and Revenue Management Advanced Queue (AQ) facility. Request Message Description: process For a description of this request message, see Table 1269. Table 1269.Request Message Description: process Node Description Type CustomHeaderContext Optional Hierarchy SWISubmitOrder_o2cReqMsg:ListOf SWIOrderIO Optional Integration siebel_transport_param:JMSPriority Optional. Sets the priority of the order processing in the JMS queue. Response Message Description: process There is no response message with this operation. Object String SWISubmitOrder_o2c 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 1270. Table 1270.SWISubmitOrder_o2c Service Object Siebel Repository Name Boundary Object Type Class SWISendOrder Workflow Not applicable Siebel CRM Web Services Reference Version 8.1/8.2 601
- 602. Siebel CRM Primary Web Services ■ SWISubmitQuote_o2c Data Object (Integration Object) For a description of data objects for this Web service, see Table 1271. Table 1271.SWISubmitOrder_o2c Data Object Siebel Repository Name External Name SWIOrderIO PDS Simplified Order Methods For a description of the methods for this Web service, see Table 1272. Table 1272.SWISubmitOrder_o2c Methods Operation Method process process SWISubmitQuote_o2c Use this Web service to submit a quote for the Order-to-Cash Process Integration Pack (O2C PIP) into the queue. SWISubmitQuote_o2c Operations For a list of operations associated with this Web service, see Table 1273. Table 1273.SWISubmitQuote_o2c Operations Name Description process Submits a quote request into the Oracle Communications Billing and Request Message Description: process For a description of this request message, see Table 1274. Response Message Description: process There is no response message with this operation. Siebel CRM Web Services Reference Version 8.1/8.2 602 Revenue Management Advanced Queue (AQ) facility. Table 1274.Request Message Description: process Node Description Type CustomHeaderContext Optional Hierarchy SWISubmitQuote_o2cReqMsg:ListOfSWIQuoteIO Optional Integration Object
- 603. Siebel CRM Primary Web Services ■ SWISyncProduct SWISubmitQuote_o2c 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 1275. Table 1275.SWISubmitQuote_o2c Service Object Siebel Repository Name Boundary Object Type Class SWISendQuote Workflow Not applicable Data Object (Integration Object) For a description of data objects for this Web service, see Table 1276. Table 1276.SWISubmitQuote_o2c Data Object Siebel Repository Name External Name SWIQuoteIO PDS Simplified Order Methods For a description of the methods for this Web service, see Table 1277. Table 1277.SWISubmitQuote_o2c Methods Operation Method process process SWISyncProduct Use this outbound Web service to submit a product to the queue. SWISyncProduct Operations For a list of operations associated with this Web service, see Table 1278. Table 1278.SWISyncProduct Operations Name Description SyncItemList Submits the product information in the Siebel business application into the asynchronous queue of the third-party application Siebel CRM Web Services Reference Version 8.1/8.2 603
- 604. Siebel CRM Primary Web Services ■ SWISyncProduct Request Message Description: SyncItemList For a description of this request message, see Table 1279. Table 1279.Request Message Description: SyncItemList Node Description Type CustomHeaderContext Optional Hierarchy SWISyncProductReqMsg: SyncItemList Optional Integration Object Response Message Description: SyncItemList Not applicable. SWISyncProduct 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 1280. Table 1280.SWISyncProduct Service Object Siebel Repository Name Boundary Object Type Class SWISyncProduct Business Service CSSWSOutboundDispatcher SWIExternalProductRequestWF Workflow Not applicable Data Object (Integration Object) For a description of the data object for this Web service, see Table 1281. Table 1281.SWISyncProduct Data Object Siebel Repository Name External Name SWIAdminISSProductDefinitionIOSWI Admin ISS Product Definition IO Method For a description of the method for this Web service, see Table 1282. Table 1282.SWISyncProduct Method Operation Method SyncItemList SyncItemList Siebel CRM Web Services Reference Version 8.1/8.2 604
- 605. Siebel CRM Primary Web Services ■ SWITroubleTicket SWITroubleTicket Use this Web service to create trouble tickets for failed orders. SWITroubleTicket Operations For a list of operations associated with this Web service, see Table 1283. Table 1283.SWITroubleTicket Operations Name Description SWITroubleTicketInsert Creates a new trouble ticket. SWITroubleTicketInsertOrUpdate Inserts or updates a trouble ticket. SWITroubleTicketQueryById Queries for a trouble ticket by ID. SWITroubleTicketUpdate Updates a trouble ticket. Request Message Description: SWITroubleTicketInsert For a description of this request message, see Table 1284. Table 1284.Request Message Description: SWITroubleTicketInsert Node Description Type SWITroubleTicketIO Required Integration Object Status Optional String Response Message Description: SWITroubleTicketInsert For a description of this response message, see Table 1285. Table 1285.Response Message Description: SWITroubleTicketInsert Node Description Type SWITroubleTicketIO Required Integration Object Request Message Description: SWITroubleTicketInsertOrUpdate For a description of this request message, see Table 1286. Table 1286.Request Message Description: SWITroubleTicketInsertOrUpdate Node Description Type SWITroubleTicketIO Required Integration Object Status Optional String Siebel CRM Web Services Reference Version 8.1/8.2 605
- 606. Siebel CRM Primary Web Services ■ SWITroubleTicket Response Message Description: SWITroubleTicketInsertOrUpdate For a description of this response message, see Table 1287. Table 1287.Response Message Description: SWITroubleTicketInsertOrUpdate Node Description Type SWITroubleTicketIO Required Integration Object Request Message Description: SWITroubleTicketQueryById For a description of this request message, see Table 1288. Table 1288.Request Message Description: SWITroubleTicketQueryById Node Description Type SWITroubleTicketIO Optional Integration Object PrimaryRowId Required String Response Message Description: SWITroubleTicketQueryById For a description of this response message, see Table 1289. Table 1289.Response Message Description: SWITroubleTicketQueryById Node Description Type SWITroubleTicketIO Optional Integration Object Request Message Description: SWITroubleTicketUpdate For a description of this request message, see Table 1290. Table 1290.Request Message Description: SWITroubleTicketUpdate Node Description Type SWITroubleTicketIO Required Integration Object Status Optional String Response Message Description: SWITroubleTicketUpdate For a description of this response message, see Table 1291. Table 1291.Response Message: SWITroubleTicketUpdate Node Description Type SWITroubleTicketIO Required Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 606
- 607. Siebel CRM Primary Web Services ■ SWI Update Order Line Item SWITroubleTicket 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 1292. Table 1292.SWITroubleTicket Service Object Name Boundary Object Type Class SWI Trouble Ticket Service Business Service CSSEAIDataSyncService Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1293. Table 1293.SWITroubleTicket Data Object Siebel Repository Name External Name SWITroubleTicketIO Service Request Methods For a description of the methods for this Web service, see Table 1294. Table 1294.SWITroubleTicket Methods Operation Method Insert Insert InsertOrUpdate InsertOrUpdate QueryById QueryById Update Update SWI Update Order Line Item Use this Web service to update the status of order line items for simple products, complex products, and nested service bundles in the Siebel CRM application when the status of the order line item changes in the billing application. The billing application makes this inbound Web service call to the Siebel CRM application to update the status of the order line item. A business service is made available in the Siebel CRM application to update the status field. Siebel CRM Web Services Reference Version 8.1/8.2 607
- 608. Siebel CRM Primary Web Services ■ SWI Update Order Line Item If the order line item contains a complex product or nested service bundle, then the Web service updates the statuses of the component products within that complex product or nested service bundle for the order line item ID that is passed to this Web service. If the order line item ID is the same as the root line item ID, then the Web service updates the statuses of the entire product hierarchy for the order. The response message returns only an acknowledgement message and not data. SWI Update Order Line Item Operations For a list of operations associated with this Web service, see Table 1295. Table 1295.SWI Update Order Line Item Operations Name Description UpdateLineItems Updates the value of the field that is passed to it for order line items in Request Message Description: UpdateLineItems For a description of this request message, see Table 1296. SWI Update Order Line Item 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. Siebel CRM Web Services Reference Version 8.1/8.2 608 simple products, complex products, and nested service bundles. Table 1296.Request Message Description: UpdateLineItems Node Description FieldName1 The name of the field in the order line item to update. FieldValue1 The new value of the field in the order line item to update. RootLineItemId The row ID of the root order in the order line item hierarchy. OrderLineItemId The row ID of the nested product in the order line item hierarchy. UpdateSingleLineItem The designation for an order with a single line item. If this node has a value of TRUE, then the order has a single line item.
- 609. Siebel CRM Primary Web Services ■ SWI Update Order Line Item Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 1297. Table 1297.SWI Update Order Line Item Service Objects Name Boundary Object Type Class (If Business Service) CMU Order Line Item Update (For Business Service CSSEAIDataSyncService simple products) SIS OM UpdateOrderItem (For complex products) Workflow Not applicable SIS OM NSB Update Order Line (For nested service bundles) Workflow Not applicable Data Object (Integration Object) For a description of data objects for this Web service, see Table 1298. Table 1298.SWI Update Order Line Item Data Object Siebel Repository Name External Name Order Entry Line Item Update Order Entry Line Item Update Methods For a description of the methods for this Web service, see Table 1299. Table 1299.SWI Update Order Line Item Methods Operation Method UpdateLineItems [BS: CMU Order Line Item Update].Update Example Package for SWI Update Order Line Item To view an example of messages 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. Request See the following file to view the sample code: ...SWIUpdateOrderLineItemSWIUpdateOrderLineItem.xml Response See the following file to view the sample code: ...SWIUpdateOrderLineItemSWIUpdateOrderLineItem.xml Siebel CRM Web Services Reference Version 8.1/8.2 609
- 610. Siebel CRM Primary Web Services ■ SyncCustomerSiebelEventAggregator Interface Description (WSDL) for SWI Update Order Line Item 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. ...SWIUpdateOrderLineItemSWIUpdateOrderLineItem.wsdl SyncCustomerSiebelEventAggregator Use this outbound Web service to synchronize account, contact, address, billing profile, and statement profile details with an external system when any insert or update operation occurs for these corresponding entities in the Siebel database. SyncCustomerSiebelEventAggregator Operations For a list of operations associated with this Web service, see Table 1300. Table 1300.SyncCustomerSiebelEventAggregator operations Operation Description aggregateaccountevent Called when an account record is inserted or updated. Request Message Description: aggregateaccountevent Sends inserted or updated account details from the Siebel database to an external system to synchronize the account with the participating integrated application. Siebel CRM Web Services Reference Version 8.1/8.2 610 This operation sends the updated or inserted account details along with its child details to the external system to synchronize the account. aggregatecontactevent Called when a contact record is inserted or updated. This operation sends the updated or inserted contact details along with its child details to the external system to synchronize the contact. aggregateaddressevent Called when an address record is inserted or updated. This operation sends the updated or inserted address details along with its child details to the external system to synchronize the address. aggregatebpevent Synchronizes the billing profile. aggregatespevent Synchronizes the statement profile.
- 611. Siebel CRM Primary Web Services ■ SyncCustomerSiebelEventAggregator For a description of this request message, see Table 1301. Table 1301.Request Message Description: aggregateaccountevent Node Description Type ListofSwicustomerpartyIO An instance of the integration object ListofSwicustomerpartyIO. Integration Object AccountNumber The number of the account. String AccountStatus The status of the account that was updated. String AccountTypeCode Account class. String Created The creation date of the account. Date CurrencyCode Account currency code. String DUNSNumber Dun and Bradstreet data universal numbering system, number. String HomePage URL for account’s homepage. String IntegrationId Integration ID of account record. String Location Location of the account. String MainFaxNumber Main fax number of the account. String MainPhoneNumber Main phone number of the account. String Name Account name. String ParentAccountId Account ID of the parent account. String PrimaryAddressId Primary address of the account. String PrimaryBillingProfileId The primary billing profile ID of the account. String PrimaryContactId The primary contact ID for the account. String PrimaryOrganizationId The primary organization ID for the account. String PrimaryShipToAddressId The primary shipping address of the account. String RowId The row ID in the Siebel database table. String Type The type of account. String ListOfCutAddress The address details of the account. Integration Component ListOfCutAddressCopy The address details of the billing profile of the account. Integration Component ListOfComExemptionsProfile The exemption profile details of the account. Integration Component ListOfComInvoiceProfile The billing profile details of the account. Integration Component Siebel CRM Web Services Reference Version 8.1/8.2 611
- 612. Siebel CRM Primary Web Services ■ SyncCustomerSiebelEventAggregator Table 1301.Request Message Description: aggregateaccountevent Node Description Type ListOfComStatementProfile The statement profile details of the account. Integration Response Message Description: aggregateaccountevent This Web service is asynchronous. There is no response message. Request Message Description: aggregatecontactevent For a description of this request message, see Table 1302. Siebel CRM Web Services Reference Version 8.1/8.2 612 Component ListOfContact The contact details for the account. Integration Component ListOfContactQuery The contact associated with the billing profile of the account. Integration Component ListOfInternalDivision The internal division details of the account. Integration Component ListOfPersonalAddress The addresses associated with the contacts of the account. Integration Component Table 1302.Request Message Description: aggregatecontactevent Node Description Type ListOfSwicontactio The contact details. Integration Object Alias The contact alias. String CellularPhone The mobile phone number of the contact. String ConsumerLink The Consumer Link of the contact. String ContactPersonTitle The title of the contact. String CurrencyCode The currency code for billing profile. String DateofBirth The contact’s date of birth. String EmailAddress The email address of the contact. String FaxPhone The contact’s fax number. String FirstName The contact’s first name. String HomePhone The contact’s home phone number. String IntegrationId The Integration ID of the contact record. String JobTitle The contact’s job title. String LastName The last name of the contact. String
- 613. Siebel CRM Primary Web Services ■ SyncCustomerSiebelEventAggregator Table 1302.Request Message Description: aggregatecontactevent Node Description Type MM The salutation for the contact. String Gender The gender of the contact. String MaritalStatus The marital status of the contact. String MiddleName The middle name of the contact. String MotherMaidenName The maiden name of the contact’s mother. String PrimaryOrganizationId The primary organization ID of the contact. String PrimaryPersonalAddressId The primary address ID of the contact. String RowId The row ID in the Siebel database table. String SocialSecurityNumber The Social Security number of the contact. String Status The status of the contact record. String WorkPhone The work phone number of the contact. String ListOfAccount The account details for the contact. Integration ListofComInvoiceProfile The billing profiles of the contact. Integration ListOfFmLocation The fleet management (FM) locations of the contact. ListOfOrganization The organizations of the contact. Integration ListOfPersonalAddress The addresses of the contact. Integration ListOfUcmContactPrivacy The Universal Customer Master (UCM) contact privacy details. Response Message Description: aggregatecontactevent This Web service is asynchronous. There is no response message. Component Component Integration Component Component Component Integration Component Request Message Description: aggregateaddressevent Sends inserted or updated address details from the Siebel database to an external system to synchronize the address with the participating integrated application. Siebel CRM Web Services Reference Version 8.1/8.2 613
- 614. Siebel CRM Primary Web Services ■ SyncCustomerSiebelEventAggregator For a description of this request message, see Table 1303. Table 1303.Request Message Description: aggregateaddressevent Node Description Type ListOfSwiaddressIO The address details. Integration Object AddressName The address name. String BillAddressFlag Indicates whether the account is billable. String City The city name. String County The county name. String Country The country name. String DisableDataCleansing Disables the flag for data cleansing. String EmailAddress The email address. String IntegrationId The integration ID of the address record. String MainAddressFlag Indicates the main address. String PostalCode The postal code of the address record. String Province The province in the address record, if this value is Response Message Description: aggregateaddressevent This Web service is asynchronous. There is no response message. Siebel CRM Web Services Reference Version 8.1/8.2 614 valid. String RowId The row ID in the Siebel database table. String ShipAddressFlag Indicates the ship-to address. String State The state of the address record. String StreetAddress The street address of address record. String StreetAddress2 The secondary street address of the address record, if necessary. String ListOfAccount The account details associated with the address. Integration Component ListofComInvoiceProfile The billing profile associated with the address. Integration Component ListOfFmLocation The fleet management locations associated with the address. Integration Component ListOfContact The contacts associated with the address. Integration Component
- 615. Siebel CRM Primary Web Services ■ SyncCustomerSiebelEventAggregator Request Message Description: aggregatebpevent Sends the inserted or updated billing profile from the Siebel database to an external system to synchronize the billing profile with the participating integrated application. For a description of this request message, see Table 1304. Table 1304.Request Message Description: aggregatebpevent Node Description Type ListOfSwibillingprofileIO The billing profile details. Integration Object AccountId The account ID of the billing profile. String AddressId The address ID of the billing profile. String BankAccountName The bank account name associated with the billing profile. String BankAccountNumber The bank account number associated with the billing profile. String BankAccountType The bank account type associated with the billing profile. String BankAuthorizationflag The Bank Authorization flag associated with the billing profile. Boolean BankBranch The branch details of the bank. String BankLanguageCode The language code of the bank. String BankLanguageId The language ID of the bank. String BankName The name of the bank. String BillAverage The average of the bill. String BillCycle The cycle of the bill. String BillCycleDay The cycle day of the bill. String BillFrequency The frequency of the bill. String BillSequence The sequence of the bill. String BillSource The source of the bill. String BillVendorId The Bill Vendor ID. ID BudgetBillingFlag The Budget Billing flag. Boolean CPNIDate The Customer Proprietary Network Information (CPNI) date. String CPNIFlag The Customer Proprietary Network Information (CPNI) flag. Boolean CollectionsFlag The Collections flag. Boolean ContactId The contact ID. ID Siebel CRM Web Services Reference Version 8.1/8.2 615
- 616. Siebel CRM Primary Web Services ■ SyncCustomerSiebelEventAggregator Table 1304.Request Message Description: aggregatebpevent Node Description Type CreditCardBlockFlag Indicates whether to block the credit card. Boolean CreditCardBlockReason The reason for the credit card block. String CreditCardCategory The category of the credit card. String CreditCardExpirationDate The expiration date of the credit card. String CreditCardName The name on the credit card. String CreditCardNumber The number of the credit card. String CreditCardNumberEncryptkey Reference Siebel CRM Web Services Reference Version 8.1/8.2 616 The encryption key reference of the credit card number. String CreditCardSecurityCode The credit card security code. String CreditCardType The credit card type. String CreditCardVerificationNumber The credit card verification number. String CreditCardVerificationNumberE The encryption key reference of the credit card String ncryptionKey verification number. DaysToCash The Days to Cash. Integer EmailBillTo The email ID. String BillingProfileId The billing profile ID. ID InterestatInvoiceFlag The Interest at Invoice flag. Boolean LastBillAmount The last bill amount. String LastBillDate The last bill date. String MediaType The media type. String BillType The bill type for the billing profile. String ExtraCopies The number of copies to be sent. Integer BillingProfileName The billing profile name. String NoPayFormFlag The No Pay Form flag. Boolean NumberofManualInvoices The number of manual invoices. Integer PaymentMethod The payment method. String ReasonforManualOutsource The reason for the manual outsource. String StatementFlag The Statement flag to distinguish the billing profile from the statement profile. Boolean RepeatDebtorFlag The Repeat Debtor flag. Boolean RoutingNumber The routing number of the bank. String StandingOrderFlag The Standing Order flag. Boolean
- 617. Siebel CRM Primary Web Services ■ SyncCustomerSiebelEventAggregator Table 1304.Request Message Description: aggregatebpevent Node Description Type Status The status of the billing profile. String YearlyAdvancePaymentFlag The Yearly Advance Payment flag. Flag ListOfContact The contacts associated with the billing profile. Integration ListOfCutAddress The addresses associated with the billing profile. Response Message Description: aggregatebpevent This Web service is asynchronous. There is no response message. Component Integration Component Request Message Description: aggregatespevent Sends an inserted or updated statement profile from the Siebel database to an external application to synchronize the statement profile with the participating integrated application. For a description of this request message, see Table 1305. Table 1305.Request Message Description: aggregatespevent Node Description Type ListOfSwistatementprofileIO The statement profile details. Integration Object ContactFirstName The contact's first name. String ContactLastName The contact's last name. String StreetAddress The contact's street address. String EmailBillTo The contact's email address. String LanguageCode The language code for the statement profile. String ContactId The contact's ID. ID MediaType The media type for the statement profile. String BillType The bill type for the statement profile. String ExtraCopies The number of copies to be sent. Integer ContactFaxPhone The contact's fax number. String ContactWorkPhone The contact's work phone number. String StatementProfileId The ID for the statement profile. ID AddressId The address ID for the contact's selected address. ID AccountId The account ID for the statement profile. ID Siebel CRM Web Services Reference Version 8.1/8.2 617
- 618. Siebel CRM Primary Web Services ■ SyncCustomerSiebelEventAggregator Table 1305.Request Message Description: aggregatespevent Node Description Type StatementFlag The statement flag to distinguish the billing profile Response Message Description: aggregatespevent This Web service is asynchronous. There is no response message. SyncCustomerSiebelEventAggregator 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 1306. Data Object (Integration Object) For a description of data objects for this Web service, see Table 1307. Siebel CRM Web Services Reference Version 8.1/8.2 618 from the statement profile. Boolean City The city for the contact’s address. String State The state for the contact's address. String Country The country for the contact's address. String ZipCode The ZIP code for the contact's address. String Table 1306.SyncCustomerSiebelEventAggregator Service Object Siebel Repository Name Boundary Object Type Class SyncCustomerSiebelEventAggregator Business Service CSSWSOutboundDispatcher Table 1307.SyncCustomerSiebelEventAggregator Data Object Siebel Repository Name External Name SWICustomerPartyIO Account SWIContactIO SWI Contact SWIAddressIO SWI CUT Address Fault Fault SWIStatementProfileIO Com Statement Profile SWIBillingProfileIO CMU - Com Invoice Profile
- 619. Siebel CRM Primary Web Services ■ TNT History Oppty Insert Interface Description (WSDL) for SyncCustomerSiebelEventAggregator 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. ...SyncCustomerSiebelEventAggregatorSyncCustomerSiebelEventAggregator.wsdl TNT History Oppty Insert Use this Web service with Siebel Hospitality to import data into history records. TNT History Oppty Insert Operations For a list of operations associated with this Web service, see Table 1308. Table 1308.TNT History Oppty Insert Operations Name Description Insert If a History record with the same unique key (Opportunity ID, defined in the integration object) as the input object exists, the operation will error out. If there is no duplicate record, then a new record in the Siebel database is created based on the input object. Upsert If an object with the same unique key (Opportunity ID, defined in the integration object) as the input object exists, the existing record is updated with the specified input object. If no duplicate record exists, a new object is created in the Siebel database based on the input object. TNT History Oppty Insert 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 1309. Table 1309.TNT History Oppty Insert Service Object Name Boundary Object Type Class TNT History Oppty Insert Business Service CSSEAISiebelAdapterService Siebel CRM Web Services Reference Version 8.1/8.2 619
- 620. Siebel CRM Primary Web Services ■ Ulnbox Contact Item Data Object (Integration Object) For a description of data objects for this Web service, see Table 1310. Table 1310.TNT History Oppty Insert Data Object Siebel Repository Name External Name TNT History Opportunity IO TNT History Opportunity Methods For a description of the methods for this Web service, see Table 1311. Table 1311.TNT History Oppty Insert Methods Operation Method Insert If a History record with the same unique key (Opportunity ID, defined in the Interface Description (WSDL) for TNT History Oppty Insert 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. See the following file to view the WSDL: ...TNT History Oppty InsertTNT_Histories.wsdl ...TNT History Oppty InsertTNT_Histories.xsd Ulnbox Contact Item UInbox Contact Item is a Web service and business service generated to load Contact Inbox Items. These items can be filtered based any fields in the business component. For example, either approved or rejected Inbox items can be loaded by setting appropriate fields in the integration object while invoking the Web service. Page size needs to be specified to load the required number of items while invoking Web service. Based on the requirements Task Owner ID or Task Owner Login, Active Flag, Action and Context fields need to be set while invoking the Web service. Siebel CRM Web Services Reference Version 8.1/8.2 620 integration object) as the input object exists, error out. Otherwise, the operations creates a new record in the Siebel database based on the input object. Upsert If an object with the same unique key (Opportunity ID, defined in the integration object) as the input object exists, updates the existing record with the specified input object. Otherwise, the operations creates a new object in the Siebel database based on the input object.
- 621. Siebel CRM Primary Web Services ■ Ulnbox Contact Item Ulnbox Contact Item Operations For a list of operations associated with this Web service, see Table 1312. Table 1312.Ulnbox Contact Item Operations Name Description UlnboxContactItemQueryPage Uses the QueryPage method to query data in the Siebel database one page at a time. Query Page Uses the QueryPage method to query data in the Siebel database one page at a time. Init Action is initialized. Execute Action is executed. Request Message Description: UlnboxContactItemQueryPage For a description of this request message, see Table 1313. Table 1313.Request Message Description: UlnboxContactItemQueryPage Node Description Type ExecutionMode The mode in which the query is to be performed. String LOVLanguageMode LIC or LDC. String NamedSearchSpec Search Specification of the query. String PickListName Name of the picklist (if any). String Response Message Description: UlnboxContactItemQueryPage For a description of this response message, see Table 1314. Table 1314.Response Message Description: UlnboxContactItemQueryPage Node Description Type SiebelMessageOut Output argument. Integration Object To Specify Parameters While Invoking Ulnbox Contact Item Use the following procedure to specify parameters while invoking the Ulnbox Contact Item Web service. Siebel CRM Web Services Reference Version 8.1/8.2 621
- 622. Siebel CRM Primary Web Services ■ Ulnbox Contact Item Specifying parameters while invoking Web service 1 Run the WSDL file through a proxy generator. This creates a C# class that must be modified to construct Input Integration Objects. For performance reasons, Page size can also be specified here. Following is the sample client side code showing how page size and other input parameters can be specified. Siebel CRM Web Services Reference Version 8.1/8.2 622 AccountQueryPageMSO_Input input = new AccountQueryPageMSO_Input (); input.ViewMode = "All"; input.PageSize = "10"; input.StartRowNum = "0"; input.ListOfAccount = new Account[1]; input.ListOfAccount[0] = new Account (); input.ListOfAccount[0].Name = "MngoTestAccount"; input.ListOfAccount[0].Location = ""; proxy.AccountQueryPageMSO (input); 2 Records can be filtered based on logged in resource and context by specifying these values in Input Integration Objects. Possible Performance and Scalability Issues The volume of Inbox data loaded by the Web service for a specific user and context can be extremely huge depending on implementations. There will be performance issues if is all retrieved together. This issue can be overcome by specifying the page size during each call. Possible Deployment Issues Authentication URL can be changed during deployment to supply changed information such as user, password and so on. These changes need to be done in the WSDL file. Error Conditions All error conditions will be handled by Web services framework.
- 623. Siebel CRM Primary Web Services ■ Ulnbox Contact Item Ulnbox Contact Item 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 1315. Table 1315.Ulnbox Contact Item Service Object Name Boundary Object Type Class UInbox Contact Item Not applicable CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service, see Table 1316. Table 1316.Ulnbox Contact Item Data Object Siebel Repository Name External Name UInboxContactItem UInbox Items Example Package for Ulnbox Contact Item To view an example of messages 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. Request See the following file to view the sample code: ...UlnboxContactItemUlnboxContactItem_request.xml Response See the following file to view the sample code: ...UlnboxContactItemResponse.xml Interface Description (WSDL) for Ulnbox Contact Item 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. ...UlnboxContactItemUlnboxContactItem.wsdl Siebel CRM Web Services Reference Version 8.1/8.2 623
- 624. Siebel CRM Primary Web Services ■ UnbilledUsageSiebelCommsReqABCS UnbilledUsageSiebelCommsReqABCS Use this Web service to query for unbilled usage details in the external Oracle Communications Billing and Revenue Management application that will be displayed in a billing profile on the billing user interface. UnbilledUsageSiebelCommsReqABCS Operations For a list of operations associated with this Web service, see Table 1317. Table 1317.UnbilledUsageSiebelCommsReqABCS Operations Name Description QueryUnbilledUsage Queries unbilled usage for the billing profile in the Siebel Request Message Description: QueryUnbilledUsage For a description of this request message, see Table 1318. Response Message Description: QueryUnbilledUsage For a description of this response message, see Table 1319. Siebel CRM Web Services Reference Version 8.1/8.2 624 Communications Billing view. QueryResourceBalance Queries resource balance details for the billing profile in the Siebel Communications Billing view. SearchEventDetails Searches for unbilled event details for the billing profile in the Siebel Communications Billing view. QueryEventDetails Queries unbilled event details for the billing profile in the Siebel Communications Billing view. Table 1318.Request Message: QueryUnbilledUsage Node Description Type CustomHeaderContext Optional Hierarchy QueryUnbilledUsageReqMsg:ListOfCmuRequestBillingProfileIo Optional Integration Object Table 1319.Response Message Description: QueryUnbilledUsage Node Description Type QueryUnbilledUsageRespMsg:ListOfCmuResponseUnbilled UsageIo Optional Integration Object
- 625. Siebel CRM Primary Web Services ■ UnbilledUsageSiebelCommsReqABCS Request Message Description: QueryResourceBalance For a description of this request message, see Table 1320. Table 1320.Request Message Description: QueryResourceBalance Node Description Type CustomHeaderContext Optional Hierarchy QueryResourceBalanceReqMsg:ListOfCmuRequestUnbilledBalance DetailsIo Response Message Description: QueryResourceBalance For a description of this response message, see Table 1321. Table 1321.Response Message Description: QueryResourceBalance Node Description Type QueryResourceBalanceRespMsg:ListOfCmuResponseUnbilledBalance DetailsIo Request Message Description: SearchEventDetails For a description of this request message, see Table 1322. Table 1322.Request Message Description: SearchEventDetails Node Description Type CustomHeaderContext Optional Hierarchy SearchEventDetailsReqMsg:ListOfCmuRequestUnbilledDetailsSearch Io Response Message Description: SearchEventDetails For a description of this response message, see Table 1323. Optional Integration Object Optional Integration Object Optional Integration Object Table 1323.Response Message Description: SearchEventDetails Node Description Type SearchEventDetailsRespMsg:ListOfCmuResponseUnbilledDetailsIo Optional Integration Object Siebel CRM Web Services Reference Version 8.1/8.2 625
- 626. Siebel CRM Primary Web Services ■ UnbilledUsageSiebelCommsReqABCS Request Message Description: QueryEventDetails For a description of this request message, see Table 1324. Table 1324.Request Message Description: QueryEventDetails Node Description Type CustomHeaderContext Optional Hierarchy QueryEventDetailsReqMsg:ListOfCmuRequestUnbilledDetailsIo Optional Integration Object Response Message Description: QueryEventDetails For a description of this response message, see Table 1325. Table 1325.Response Message Description: QueryEventDetails Node Description Type QueryEventDetailsRespMsg:ListOfCmuResponseUnbilledDetailsIo Optional Integration UnbilledUsageSiebelCommsReqABCS 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 1326. Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1327. Siebel CRM Web Services Reference Version 8.1/8.2 626 Object Table 1326.UnbilledUsageSiebelCommsReqABCS Service Object Name Boundary Object Type Class UnbilledUsageSiebelCommsReqABCS Business Service CSSWSOutboundDispatcher Table 1327.UnbilledUsageSiebelCommsReqABCS Data Objects Siebel Repository Name External Name CMU Response Unbilled Details IO Account CMU Request Unbilled Details IO Account CMU Request Unbilled Balance Details IO Account CMU Response Unbilled Balance Details IO Account CMU Request Billing Profile IO Account
- 627. Siebel CRM Primary Web Services ■ UnbilledUsageSiebelCommsReqABCS Table 1327.UnbilledUsageSiebelCommsReqABCS Data Objects Siebel Repository Name External Name CMU Response Unbilled Usage IO Account CMU Request Unbilled Details Search IO Account CMU Response Unbilled Details IO Account Methods For a description of the methods for this Web service, see Table 1328. Table 1328.UnbilledUsageSiebelCommsReqABCS Operation Method QueryUnbilledUsage QueryUnbilledUsage QueryResourceBalance QueryResourceBalance SearchEventDetails SearchEventDetails QueryEventDetails QueryEventDetails Example Package for UnbilledUsageSiebelCommsReqABCS To view an example of messages 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. Request See the following file to view the sample code: ...UnbilledUsageSiebelCommsReqABCSRequest.xml Response See the following file to view the sample code: ...UnbilledUsageSiebelCommsReqABCSResponse.xml Interface Description (WSDL) for UnbilledUsageSiebelCommsReqABCS 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. ...UnbilledUsageSiebelCommsReqABCSWSDL Siebel CRM Web Services Reference Version 8.1/8.2 627
- 628. Siebel CRM Primary Web Services ■ Universal Inbox Universal Inbox Universal Inbox is an existing business service providing functionality to create, update Inbox items or owner, invoke actions, and so on. This can be modified to include methods to invoke Approve and Reject Actions that will be deployed as a Web service. Universal Inbox Operations For a list of operations associated with this Web service, see Table 1329. Table 1329.Universal Inbox Operations Name Description UniversalInboxCallAction Executes the action registered for a specific Inbox Item type. Request Message Description: UniversalInboxCallAction For a description of this request message, see Table 1330. Table 1330.Request Message Description: UniversalInboxCallAction Node Description Type InboxItemId InboxItemId String ActionLIC ActionLIC String InboxTypeName InboxTypeName String OwnerId OwnerId String ObjectId ObjectId String Response Message Description: UniversalInboxCallAction For a description of this response message, see Table 1331. Table 1331.Response Message Description: UniversalInboxCallAction Node Description Type Status Call status. String Error message Error message returned, if any. String This operation will return the following messages: ■ Errors such as post-approval action not configured. ■ User-friendly error message, for example, when the same inbox item is concurrently updated by two Siebel Self-Service users. Messages such as “This has already been approved by a different user” appear if the action has been approved. If the action has been rejected, then the message: this has already been rejected by a different user appears. Siebel CRM Web Services Reference Version 8.1/8.2 628
- 629. Siebel CRM Primary Web Services ■ Universal Inbox ■ Returning the actual error message, if any, from the workflow that is being invoked. Since the Self-Service workflow is invoked synchronously, all error messages will be propagated. ■ CallAction business service method will detect and return error messages raised by the Action business service. Web service Infrastructure will detect that the CallAction business service method has returned an error code and create a SOAP fault. Invalid input conditions InboxItemId and ActionName are required input parameters to execute the action. Comments is an optional parameter. Processing errors Errors occurring during workflow execution and so on will be handled by Web services framework and the error extracted will be sent as SOAP fault. Universal Inbox 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 1332. Table 1332.Universal Inbox Service Object Node Description Type Universal Inbox Not applicable CSSUInboxSvc Data Object (Integration Object) Since all Input and Output parameters are Strings, Integration Object is not required. Example Package for Universal Inbox To view an example of messages 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. Request See the following file to view the sample code: ...UniversalInboxUniversalInbox_request.xml Siebel CRM Web Services Reference Version 8.1/8.2 629
- 630. Siebel CRM Primary Web Services ■ UpdateCreditAlertSiebelCommsReqABCSImpl Response See the following file to view the sample code: ...UniversalInboxUniversal_Inbox_response.xml Interface Description (WSDL) for Universal Inbox 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. ...UniversalInboxUniversalInbox.wsdl UpdateCreditAlertSiebelCommsReqABC SImpl Use this Web service to update the credit alert status from Siebel CRM to the external Oracle Communications Billing and Revenue Management application. UpdateCreditAlertSiebelCommsReqABCSImpl Operations For a list of operations associated with this Web service, see Table 1333. Table 1333.UpdateCreditAlertSiebelCommsReqABCSImpl Operations Name Description UpdateCreditAlert Updates the credit alert. Request Message Description: UpdateCreditAlert For a description of this request message, see Table 1334. Table 1334.Request Message Description: UpdateCreditAlert Node Description Type CustomHeaderContext Optional Hierarchy UpdateCreditAlertReqMsg:UpdateCreditAlert Optional Integration Object Request Message Description: UpdateCreditAlert There is no response message for this Web service. UpdateCreditAlertSiebelCommsReqABCSImpl 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. Siebel CRM Web Services Reference Version 8.1/8.2 630
- 631. Siebel CRM Primary Web Services ■ UpdateCustomerSiebelJMSProducer Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 1335. Table 1335.UpdateCreditAlertSiebelCommsReqABCSImpl Service Object Data Object (Integration Object) For a description of the data objects for this Web service, see Table 1336. Methods For a description of the methods for this Web service, see Table 1337. UpdateCustomerSiebelJMSProducer Use this Web service to synchronize the data between the Siebel CRM and the external billing application for details relating to accounts, addresses, contacts, and billing profiles. Because this Web service uses an asynchronous call, a response message does not apply. UpdateCustomerSiebelJMSProducer Operations For a list of ope