|
Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >
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 use the SelfServiceRegistration Web service, which also accepts an instance of the integration object SS_Contacts_IO. The SelfServiceRegistration Web service calls the SelfServiceRegistration workflow, which delegates the integration object to SelfServiceContact business service.
As a result, in Siebel Self-Service Applications, the SelfServiceContact Web service is most often used for the QueryPage operation. SelfServiceContact Operations
For a list of operations associated with this Web service, see Table 1020.
Table 1020. SelfServiceContact Operations
|
|
SelfServiceContactExecute |
Used to set the direction of a query on a business component. Valid values are ForwardOnly and Bidirectional. The default value is Bidirectional. The ForwardOnly value is more efficient than Bidirectional, and is recommended in cases where you must process a large number of records in the forward direction only (such as for report generation). For operations that are likely to return more than 10000 records, use ForwardOnly to avoid errors. For more information on executing queries, see the topic on the ExecuteQuery business component method in Siebel Object Interfaces Reference. |
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. |
Request Message Description: SelfServiceContactExecute
For a description of this request message, see Table 1021.
Table 1021. Request Message Description: SelfServiceContactExecute
|
|
|
ExecutionMode |
Used to set the direction of a query on a business component. Valid values are ForwardOnly and Bidirectional. The default value is Bidirectional. ForwardOnly is generally recommended over Bidirectional in cases where you must process a large number of records in the forward direction only (such as for report generation). For operations that are likely to return more than 10000 records it is recommended that you use ForwardOnly. For more information on executing queries, see the topic on the ExecuteQuery business component method in Integration Platform Technologies: Siebel Enterprise Application Integration. |
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 |
LIC Language Independent Code or LDC Language Dependent Code. |
String |
ViewMode |
The default view mode is All. The visibility mode is applied to the business object. Valid values are: Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All. NOTE: The ViewMode user property used on the integration object has priority over the ViewMode method argument.
|
Complex Type |
Contact |
Corresponds to a record in SS_Contacts_IO. Set the operation accordingly. If Contact details require an update, or if child elements such as Personal Address are present, use 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 the 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/ Name, PrimaryContactId, Type |
Details of the assigned account. |
String |
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 |
Response Message Description: SelfServiceContactExecute
For a description of this response message, see Table 1022.
Table 1022. Response Message Description: SelfServiceContactQueryExecute
|
|
|
SelfServiceContactExecute_Output |
Container element for the Execute 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. |
ListOfSSContact/Contact/Id, ModId |
ID and ModId of Inserted, or Updated Contact Record. |
String |
ListOfSSContact/Contact/ListOfAccount/Account/Id, Mod Id |
ID and ModId of Inserted, or Updated Account Record. |
String |
ListOfSSContact/Contact/ListOfCommunicationAddress/CommunicationAddress/Id, Mod Id |
ID and ModId of Inserted, or Updated CommunicationAddress Record. |
String |
Request Message Description: SelfServiceContactQueryPage
For a description of this request message, see Table 1023.
Table 1023. Request Message Description: SelfServiceContactQueryPage
|
|
|
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. |
ListOfSSContact/Contact |
Set contact information. |
Complex Type |
Contact/ Id |
Set the ID of the Contact as a 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 |
Contact /ListOfContactCommunicationAddress /ContactCommunicationAddress |
Contact communications address. |
String |
Contact /ListOfContactCommunicationAddress /ContactCommunicationAddress /AlternateEmailAddress |
Empty (Columns to be retrieved). Alternate Email Address of the contact. |
String |
Contact /ListOfContactCommunicationAddress /ContactCommunicationAddress /CommunicationAddressId |
Empty (Columns to be retrieved). 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 |
LIC Language Independent Code or LDC Language Dependent Code. |
String |
ViewMode |
All. |
Complex Type |
Response Message Description: SelfServiceContactQueryPage
For a description of this response message, see Table 1024.
Table 1024. Response Message Description: SelfServiceContactQueryPage
|
|
|
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. |
ListOfSSContact/Contact |
Set contact information. |
Complex Type |
Contact/ Id |
ID of the Contact being queried. |
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 |
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 |
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 1025.
Table 1025. SelfServiceContact Service Object
|
|
|
SelfServiceContact |
BusinessService |
CSSEAIUIDataService |
Data Object (Integration Object)
For a description of data objects for this Web service, see Table 1026.
Table 1026. SelfServiceContact Data Object
|
|
SS_Contacts_IO |
SS_Contacts_IO |
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: ...\SelfServiceContact\SelfServiceContactQueryPage_request.xml
Response (SelfServiceContactQueryPage)
See the following file to view the sample code: ...\SelfServiceContact\SelfServiceContactQueryPage_request.xml
Request (SelfServiceContactExecute)
See the following file to view the sample code: ...\SelfServiceContact\SelfServiceContactExecute_request.xml
Response (SelfServiceContactExecute)
See the following file to view the sample code: ...\SelfServiceContact\SelfServiceContactExecute_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. ...\SelfServiceContact\SelfServiceContact.wsdl
|
