Returning a List of Upgrade or Downgrade Paths for a Promotion
A bundle promotion asset can be eligible for an upgrade or a downgrade to multiple target bundle promotions. This REST API allows you to fetch a list of those target promotions. When you use the Siebel REST API to fetch a list of upgrade or downgrade paths for a specific promotion, the Siebel application returns a list of possible upgrade and downgrade options for a specific promotion asset, as well as the eligibility, commitments and penalties associated with each option.
The following request returns a list of upgrades or downgrades for a specific promotion:
-
URI: http://ServerName:port/siebel/v1.0/service/ISS Promotion Management Service/GetPromotionUpgradePaths
-
HTTP Method: POST
-
Content-Type: application/json
-
Authorization: Basic
-
Request body:
{ "body": { "Mode": "Account", "Header Id": "88-1VG35J", "Asset Integration Id": "88-1VG364" } }
For a description of the request message associated with this API, see the following table.
Name | Description |
---|---|
Mode |
Required. Account |
Header Id |
Required. Account ID associated with the asset. |
AssetIntegrationId |
Required. Integration ID of the promotion asset you want to upgrade. |
Here are the response details for a successful request:
-
HTTP Code: 200
-
Content-Type: application/json
-
Response body:
{ "SiebelMessage": { "PARSEIONAME": "GetPromotionUpgradePaths", "IntObjectFormat": "Siebel Hierarchical", "MessageId": "", "Integration Object": "GetPromotionUpgradePaths", "MessageType": "Integration Object", "ISS Promotion Upgrade Aggregate VBC": [ { "Asset Integration Id": "88-1VFWUR", "Prorate Plan Name": "10% for first 10 months", "Original Promotion Id": "88-3N951", "Target Promotion Name": "500SRS_Tgt_Prom2", "Target Promotion Id": "88-3N95K", "Operation Id": "88-3N77D", }, { "Asset Integration Id": "88-1VFWUR", "Original Promotion Id": "88-3N951", "Target Promotion Name": "500SRS_Tgt_Prom3", "Target Promotion Id": "88-3N95T", "Operation Id": "88-3M83F", } ] } }