|
Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >
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
|
|
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
|
|
SelfServiceAccountExecute_Input |
Container element for the Execute Operation request. |
ListOfSSAccount |
Corresponds to an instance of SS_Account_IO. |
ListOfSSAccount/ Account |
Set operation accordingly. If account details need to 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. |
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
|
|
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 / ListOfBusinessAddress |
Container element for the list of created or updated business address of the account. |
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. |
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
|
|
SelfServiceAccountQueryPage_Input |
Container element for the QueryPage Operation 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. |
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
|
|
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. |
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. |
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress |
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. |
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. 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
|
|
|
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
|
|
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: ...\SelfServiceAccount\SelfServiceAccountExecute_request.xml
Response (SelfServiceAccountExecute)
See the following file to view the sample code: ...\SelfServiceAccount\SelfServiceAccountExecute_response.xml
Request (SelfServiceAccountQueryPage)
See the following file to view the sample code: ...\SelfServiceAccount\SelfServiceAccountQueryPage_request.xml
Response (SelfServiceAccountQueryPage)
See the following file to view the sample code: ...\SelfServiceAccount\SelfServiceAccountQueryPage_response.xml
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. ...\SelfServiceAccountQueryPage\SelfServiceAccount.wsdl
|
