Apply Multiple Product Offers Operations
For a list of operations associated with this Web service, see the following table.
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 the following table.
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 the following table.
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 the following table.
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 the following table.
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 |