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.

Arguments

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.
searchspec	Either AssetIntegrationId or searchspec is mandatory. We can pass searchspec based on any Asset BC field

Example of Input Arguments

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-3GIKUR",
        "Asset Integration Id": "88-3GIKV8",
        "searchspec": "[Integration Id]='88-3GIKV8'"
    }
}

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",
    "ListOfGetPromotionUpgradePaths": {
      "ISS Promotion Upgrade Aggregate VBC": [
        {
          "Duration": "Original Duration",
          "Compound Product Number": "",
          "Eligibility Reason": "",
          "Target Promotion Description": "PSR_Supremo Tripleplay",
          "Prorated Penalty": "67.5",
          "Asset Integration Id": "88-3GIKV8",
          "Original Promotion Name": "PSR_Supremo Dualplay",
          "Operation Id": "88-3FWLJO",
          "Prorate Plan Name": "10% for first 10 months",
          "Operation Name": "",
          "Exchange Date": "08/07/2025",
          "Prorate Plan Id": "88-231OX",
          "Original Promotion Id": "88-3C2L5B",
          "Operation Type": "",
          "Reason": "Upsell",
          "Commitment Start": "Original Start",
          "Adjusted Duration": "1 Years",
          "Penalty Amount": "75",
          "Target Promotion Name": "PSR_Supremo Tripleplay",
          "Display Commitment": "Y",
          "Target Promotion Id": "88-3C2ND3",
          "Account Id": "88-3GIKUR",
          "Commitment End": "08/07/2026",
          "Display Prorated Charge": "Y",
          "Currency Code": "",
          "Eligibility Status": "Y"
        },
        {
          "Duration": "Original Duration",
          "Compound Product Number": "",
          "Eligibility Reason": "",
          "Target Promotion Description": "",
          "Prorated Penalty": "0",
          "Asset Integration Id": "88-3GIKV8",
          "Original Promotion Name": "PSR_Supremo Dualplay",
          "Operation Id": "88-3GCLB9",
          "Prorate Plan Name": "10% for first 10 months",
          "Operation Name": "",
          "Exchange Date": "08/07/2025",
          "Prorate Plan Id": "88-231OX",
          "Original Promotion Id": "88-3C2L5B",
          "Operation Type": "",
          "Reason": "Upsell",
          "Commitment Start": "Original Start",
          "Adjusted Duration": "1 Years",
          "Penalty Amount": "",
          "Target Promotion Name": "TEST1",
          "Display Commitment": "Y",
          "Target Promotion Id": "88-3GCL87",
          "Account Id": "88-3GIKUR",
          "Commitment End": "08/07/2026",
          "Display Prorated Charge": "Y",
          "Currency Code": "",
          "Eligibility Status": "Y"
        },
        {
          "Duration": "Original Duration",
          "Compound Product Number": "",
          "Eligibility Reason": "",
          "Target Promotion Description": "",
          "Prorated Penalty": "0",
          "Asset Integration Id": "88-3GIKV8",
          "Original Promotion Name": "PSR_Supremo Dualplay",
          "Operation Id": "88-3GCO81",
          "Prorate Plan Name": "10% for first 10 months",
          "Operation Name": "",
          "Exchange Date": "08/07/2025",
          "Prorate Plan Id": "88-231OX",
          "Original Promotion Id": "88-3C2L5B",
          "Operation Type": "",
          "Reason": "Upsell",
          "Commitment Start": "Original Start",
          "Adjusted Duration": "1 Years",
          "Penalty Amount": "",
          "Target Promotion Name": "TEST_Quadplay",
          "Display Commitment": "Y",
          "Target Promotion Id": "88-3GCO50",
          "Account Id": "88-3GIKUR",
          "Commitment End": "08/07/2026",
          "Display Prorated Charge": "Y",
          "Currency Code": "",
          "Eligibility Status": "Y"
        },
        {
          "Duration": "Original Duration",
          "Compound Product Number": "",
          "Eligibility Reason": "",
          "Target Promotion Description": "",
          "Prorated Penalty": "0",
          "Asset Integration Id": "88-3GIKV8",
          "Original Promotion Name": "PSR_Supremo Dualplay",
          "Operation Id": "88-3FWLHV",
          "Prorate Plan Name": "10% for first 10 months",
          "Operation Name": "",
          "Exchange Date": "08/07/2025",
          "Prorate Plan Id": "88-231OX",
          "Original Promotion Id": "88-3C2L5B",
          "Operation Type": "",
          "Reason": "Upsell",
          "Commitment Start": "Original Start",
          "Adjusted Duration": "1 Years",
          "Penalty Amount": "",
          "Target Promotion Name": "PSR_Supremo Quadplay",
          "Display Commitment": "Y",
          "Target Promotion Id": "88-3C1AY3",
          "Account Id": "88-3GIKUR",
          "Commitment End": "08/07/2026",
          "Display Prorated Charge": "Y",
          "Currency Code": "",
          "Eligibility Status": "Y"
        },
        {
          "Duration": "Original Duration",
          "Compound Product Number": "",
          "Eligibility Reason": "",
          "Target Promotion Description": "",
          "Prorated Penalty": "0",
          "Asset Integration Id": "88-3GIKV8",
          "Original Promotion Name": "PSR_Supremo Dualplay",
          "Operation Id": "88-3GCMFQ",
          "Prorate Plan Name": "10% for first 10 months",
          "Operation Name": "",
          "Exchange Date": "08/07/2025",
          "Prorate Plan Id": "88-231OX",
          "Original Promotion Id": "88-3C2L5B",
          "Operation Type": "",
          "Reason": "Upsell",
          "Commitment Start": "Original Start",
          "Adjusted Duration": "1 Years",
          "Penalty Amount": "",
          "Target Promotion Name": "TEST2",
          "Display Commitment": "Y",
          "Target Promotion Id": "88-3GCMCP",
          "Account Id": "88-3GIKUR",
          "Commitment End": "08/07/2026",
          "Display Prorated Charge": "Y",
          "Currency Code": "",
          "Eligibility Status": "Y"
        }
      ]
    }
  }
}

Error Conditions

Error ID	Error Message Text	User Action/Resolution
SBL-ISS-50233	"One of the required input arguments 'Asset Integration Id' or 'searchspec' is not provided in input.(SBL-ISS-50233)"	Need to provide Asset Integration Id or seachspec or both parameters in the input
SBL-DAT-00125	"Required in argument 'Header Id' not supplied for 'GetPromotionUpgradePaths' method in Business Service 'ISS Promotion Management Service'(SBL-DAT-00125)"	Need to pass Header Id in the input
SBL-DAT-00125	"Required in argument 'Mode' not supplied for 'GetPromotionUpgradePaths' method in Business Service 'ISS Promotion Management Service'(SBL-DAT-00125)"}	Need to pass Mode Id in the input