Bookshelf Home | Contents | Index | PDF     

Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >

Product Offer - Apply Multiple Product Offers

Use this web service to apply multiple product offers to generate a quote or an order. For more information about the business scenarios and product offers related to the Apply Multiple Product Offers web service, see Siebel Pricing Administration Guide.

Apply Multiple Product Offers Operations

For a list of operations associated with this Web service, see Table 897.

Table 897. Apply Multiple Product Offers Operations
Name
Description

ApplyMultipleOffersforOrder

Applies a product offer to an account whose type is set to Residential.

The input message requires the account ID and a list of the offer ID's, including the correct sequence number. 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 save the order structure in the Siebel database or generate the order in memory.

Optionally, the input message can include either the order ID or the complete order structure.

If the input message contains the order ID, then the web service updates the order structure in the Siebel database instead of creating a new order structure. If the input message contains the order structure, then the web service updates the order structure in memory instead of creating a new order structure.

ApplyMultipleOffersforQuote

Applies a product offer to an account of a type other than residential.

The input message requires the account ID and a list of offer ID's, including the correct sequence number. If the offer requires modification to the customer's asset, then the asset ID is also required.

The output message returns the complete quote structure. The user has the option to save the quote structure in the Siebel database or generate the quote structure in memory.

Optionally, the input message can include either the quote ID or the complete quote structure.

If the input message contains the quote ID, then the web service updates the quote structure in the Siebel database instead of creating a new quote structure. If the input message contains the quote structure, then the web service updates the quote structure in memory instead of creating a new quote.

Request Message Description: ApplyMultipleOffersforOrder

For a description of this request message, see Table 898

Table 898. Request Message: ApplyMultipleOffersforOrder
Name
Description
Type

ListOfRAFproductofferIO

Required. The list of offer ID's that have to be applied.

Integration object

SaveInstance

Required. Values are either Y or N. If the value is set to Y, then the order is saved to the Siebel database. If the value is set to N, then the order persists in memory.

String

AccountId

Required. The account ID on which the offer will be applied.

String

AssetId

Optional. The Asset ID on which the offer will be applied. The Asset ID is required if there is a modification to the customer's asset

String

DocId

Optional. The Order ID on which the offer will be applied.

If the DocId parameter is provided, the SaveInstance flag is set to Y internally and the order is saved to the Siebel database.

String

ListOfOrder

Optional. The complete order structure on which the offer will be applied.

If the ListOfOrder parameter is provided, the SaveInstance flag is set to N internally and the order is generated in memory.

The ApplyMultipleOffersforOrder web service accepts either the DocId parameter or the ListOfOrder parameter. The DocId parameter and the ListOfOrder parameter are mutually exclusive.

Integration object

Response Message Description: ApplyMultipleOffersforOrder

For a description of this response message, see Table 899.

Table 899. Response Message Description: ApplyMultipleOffersforOrder
Name
Description
Type

SIS OM Order using <ListOfOrder>

The order document structure that has been created.

When the order is generated in memory, the order ID value is set to NoId and the order name value is set to null.

Integration object

Mode

Specifies the document format and is set to the order.

String

Request Message Description: ApplyMultipleOffersforQuote

For a description of this request message, see Table 900.

Table 900. Request Message Description: ApplyMultipleOffersforQuote
Name
Description
Type

ListOfRAFproductofferIO

Required. The list of offer ID's that have to be applied.

Integration object

SaveInstance

Required. Possible values are Y or N. If the value is set to Y, then the quote is saved to the Siebel database. If the value is set to N, then the quote persists in memory.

String

AccountId

Required. The account ID on which the offer will be applied.

String

AssetId

Optional. The asset ID on which the offer will be applied. The Asset ID is required if there is a modification to the customer's asset.

String

DocId

Optional. The quote ID on which the offer will be applied.

If the DocId parameter is provided, then the SaveInstance flag is set to Y internally and the quote will be saved to the Siebel database.

String

ListOfQuote

Optional. The complete quote structure on which the offer will be applied.

If the ListOfQuote parameter is provided, the SaveInstance flag is set to N internally and the quote will be generated in memory.

The ApplyMultipleOffersforOrder web service accepts either the DocId parameter or the ListOfQuote parameter. The DocId parameter and the ListOfQuote parameter are mutually exclusive.

Integration object

Response Message Description: ApplyMultipleOffersforQuote

For a description of this response message, see Table 901.

Table 901. Response Message Description: ApplyMultipleOffersforQuote
Name
Description
Type

SIS OM Quote using <ListOfQuote>

The quote document structure that has been created.

When the quote is generated in memory, the quote ID value is set to NoId and the quote name is set to null.

Integration object

Mode

Specifies the document format and is set to quote.

String

Apply Multiple Product Offers Application Interface

This topic describes the application objects called by the this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see Table 902.

Table 902. ApplyMultipleOffersforOrder Service Objects
Name
Boundary Object Type
Class

ApplyMultipleOffersforOrderPort

Workflow Process

RAF Apply Multiple Offer To Create Order Web Service

ApplyMultipleOffersforQuotePort

Workflow Process

RAF Apply Multiple Offer To Create Quote Web Service

Data Object (Integration Object)

For a description of data objects for this Web service, see Table 903.

Table 903. ApplyMultipleOffersforOrder Data Objects
Siebel Repository Name
External Name

RAFProductOfferIO

RAF Product Offer

SIS OM Order

MACD Performance Order

SIS OM Quote

MACD Performance Quote

Example Package for Product Offer - Apply Multiple Product Offers

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 (BuildYourOwnBundle)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\BuildYourOwnBundle - Request Message.txt

Response (BuildYourOwnBundle)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\BuildYourOwnBundle - Response Message.txt

Request (Change Plan - InMemory Upgrade)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Change Plan - InMemory Upgrade - Request Message.txt

Response (Change Plan - InMemory Upgrade)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Change Plan - InMemory Upgrade - Response Message.txt

Request (Existing Customer - Upsell Add-ons)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Existing Customer - Upsell Add-ons - Request Message.txt

Response (Existing Customer - Upsell Add-ons)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Existing Customer - Upsell Add-ons - Response Message.txt

Request (New Acquisition - Add Equipment)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - Add Equipment - Request Message.txt

Response (New Acquisition - Add Equipment)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - Add Equipment - Response Message.txt

Request (New Acquisition - InMemory)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - InMemory - Request Message.txt

Response (New Acquisition - InMemory)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - InMemory - Response Message.txt

Request (New Acquisition - SavetoDB)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - SavetoDB - Request Message .txt

Response (New Acquisition - SavetoDB)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - SavetoDB - Response Message .txt

Request (ReplaceSIM)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\ReplaceSIM - Request Message.txt

Response (ReplaceSIM)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\ReplaceSIM - Response Message.txt

Request (Validate Asset - International Calling Package)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Validate Asset - International Calling Package - Request Message.txt

Response (Validate Asset - International Calling Package)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Validate Asset - International Calling Package - Response Message.txt

Request (Validate Asset - Premium Voicemail)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Validate Asset - Premium Voicemail - Request Message.txt

Response (Validate Asset - Premium Voicemail)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Validate Asset - Premium Voicemail - Response Message.txt

Request (Modify_InMemory_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Modify_InMemory_ApplyMultipleOffersforQuote_Request.xml

Response (Modify_InMemory_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Modify_InMemory_ApplyMultipleOffersforQuote_Response.xml

Request (Modify_InMemory_WithQuoteStructure_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Modify_InMemory_WithQuoteStructure_ApplyMultipleOffersforQuote_Request.xml

Response (Modify_InMemory_WithQuoteStructure_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Modify_InMemory_WithQuoteStructure_ApplyMultipleOffersforQuote_Response.xml

Request (Modify_Sync_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Modify_Sync_ApplyMultipleOffersforQuote_Request.xml

Response (Modify_Sync_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Modify_Sync_ApplyMultipleOffersforQuote_Response.xml

Request (Modify_Sync_WithQuoteStructure_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Modify_Sync_WithQuoteStructure_ApplyMultipleOffersforQuote_Request.xml

Response (Modify_Sync_WithQuoteStructure_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Modify_Sync_WithQuoteStructure_ApplyMultipleOffersforQuote_Response.xml

Request (New_InMemory_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New_InMemory_ApplyMultipleOffersforQuote_Request.xml

Response (New_InMemory_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New_InMemory_ApplyMultipleOffersforQuote_Response.xml

Request (New_Sync_WithQuote_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New_Sync_WithQuote_ApplyMultipleOffersforQuote_Request.xml

Response (New_Sync_WithQuote_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New_Sync_WithQuote_ApplyMultipleOffersforQuote_Response.xml

Interface Description (WSDL) for Product Offer - Apply Multiple Product Offers

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.

See the following file to view the message schema:

...WSDL\Apply Multiple Product Offers Webservice.wsdl

...XSD\ RAFProductOfferIO.xsd

...XSD\SIS OM Order.xsd

...XSD\SIS OM Quote.xsd

      
Siebel CRM Web Services Reference Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.