Disconnecting a Promotion

When you use the Siebel REST API to cancel a promotion, the Siebel application disconnects an existing promotion asset. If the promotion commitment is breached, then a penalty line item is created during this process. Any components that can exist outside of the promotion either are disconnected, or are retained based on the value of Component Prompt Action input.

The following request disconnects a promotion:

• URI: http://ServerName:port/siebel/v1.0/service/Workflow Process Manager/RunProcess

• HTTP Method: POST

• Content-Type: application/json

• Authorization: Basic

• Request body:

   	    {
  	"body": {
  		"ProcessName": "SISOMDisconnectWebService-Order",
  		"Due Date": "9/17/2020",
  		"AssetIntegrationId": "88-1WNT2N",
  		"AccountId": "88-1WNT23",
  		"Sync": "Y",
  		"AssetPromptAction": {
  			"IntObjectFormat": "Siebel Hierarchical",
  			"MessageId": "",
  			"IntObjectName": "ISS Promotion Component Prompt Action",
  			"MessageType": "Integration Object",
  			"ListOfISS Promotion Component Prompt Action": {
  				"Asset": [
  					{
  						"Asset Integration Id": "88-1WNT2S",
  						"Component Prompt Action": "Disconnect"
  					},
  					{
  						"Asset Integration Id": "88-1WNT2W",
  						"Component Prompt Action": "Disconnect"
  					}
  				]
  			}
  		}
  	}
  }
  

For a description of the request message associated with this API, see the following table.

Name	Description
Process Name	One of the following processes is required: SISOMDisconnectWebService-Order SISOMDisconnectWebService-Quote
Due Date	Optional. The default value is today's date, plus one day. Disconnection date of the promotion.
AssetIntegrationId	Required. Integration ID of the bundle promotion asset you disconnect.
AccountId	Required. Account ID associated with the asset.
EligibilityMode	Optional. Valid values are 0, 1, or 2. If set to 0, then the procedure is not run. If set to 1, then the procedure is run, and all ineligible products are displayed with messages. If set to 2, then the procedure is run, and all ineligible products are not included in selections.
AssetPromptAction:ListOfISS Promotion Component Prompt Action:Asset:AssetIntegrationId	Required for prompt components. Integration ID of promotion component with the Prompt Action code.
AssetPromptAction:ListOfISS Promotion Component Prompt Action:Asset:Component Prompt Action	Required for prompt components. Disconnect or Modify. If the value is Disconnect, then the asset is disconnected. If the value is Modify, then the asset is continued.
Sync	Optional. The default value is Y. If Sync is N, quote or order is created in-memory and sent as response without committing to the database. If Sync is Y or omitted in the request, existing behavior of database commit continues.

Here are the response details for a successful request:

• HTTP Code: 200

• Content-Type: application/json

• Response body:

      	                    {
  	"ActiveDocumentId": "88-1WO67Z",
  	"Error Code": "",
  	"Error Message": "",
  	"SiebelMessage": {
  		"IntObjectFormat": "Siebel Hierarchical",
  		"MessageId": "88-26HTT",
  		"IntObjectName": "PDS Order",
  		"MessageType": "Integration Object",
  		"Header": {
  			"Id": "88-1WO67Z",
  			"Line Item": [
  				{
  					"Product Structure Type": "None",
  					"Asset Status": "Active",
  					"Name": "ND_SP2",
  					"Asset Integration Id": "88-1WNT2W",
  					"Action Code": "Delete",
  					"Id": "88-1WO69J"
  				},
  				{
  					"Product Structure Type": "None",
  					"Asset Status": "Active",
  					"Name": "ND_SP1",
  					"Asset Integration Id": "88-1WNT2S",
  					"Action Code": "Delete",
  					"Id": "88-1WO69K"
  				}
  			]
  		}
  	}
  }