Sample Deal Update Request and Response in the JSON Format

Using the below example, you can update the deal 4524551669.

Sample Deal Update Request in the JSON Format

{
    "C1-DealCreationUpdateIWS":
    {
        "actionFlag" :"UPD",
        "dealDetails"
        {
            "dealIdentifier" :"DEALPRS2022PER23",
            "dealInformation" :"4524551669,CITI BANK,CORP,03-09-2022,United States Dollars,Contracted Deal-No,(1),DEALPRS2022PER23",
            "dealId" :"4524551669"
            "modelId" :"9202703256"
            "dealEntityType" :"PRSP",
            "customerSegment" :"COMM",
            "customerTier" :"T",
            "division" :"930",
            "accessGrp" :"***",
            "dealEntityId" :"0218803513",
            "contractedDealFlag" :"false",
            "currency" :"USD",
            "dealTypeCode" :"ANRMONLY",
            "startDate" :"2022-03-09",
            "endDate" :"2023-03-09",
            "simulationTypeFlag" :"CUST",
            "dealDescription" :"Deal Description update",
            "dealVersionDescription" :"Deal version description update",
            "dealFrequency" :"1",
            "skipReferenceFlag" :"true",
            "priceSelectionDate" :"2022-03-09",
            "usagePeriod" :"1",
            "includeHierarchyFlag" :"true",
            "status" :"PSML",
            "dealVersionStatus" :"",
            "templateFlag" :"false",
            "createdDate" :"2022-03-09"
        }
        "templateReferenceDetails"
        {
            "copyBasicDetailsFlag" :"false",
            "copyPricingFlag" :"false",
            "copyUsageFlag" :"false",
        }
        "dealCharacteristics"
        {
            "characteristicType" :"ABC",
            "effectiveDate" :"2021-03-09",
            "characteristicValue" :"5881231767",
        }
        "dealTermsAndConditionsDetails"
        {
            "termsAndConditionsList"
            {
                "description" :"T&C 1 Desc"
                "termsAndCondition" :"T&C 1"
                "termsAndConditionText" :"Adhoc Text"
            }
            "adhocTermsAndCondition" :"Adhoc Description",
        }
        "productDetailsList"
        {
            "productCode" :"IMA_BP1",
        }
        "productDetailsList"
        {
            "productCode" :"IMA_BP2",
        }
        "referenceDetails"
        {
            "referUsageSw" :"false",
            "referPriceSw" :"false",
            "includeChildHierarchy" :"false",
        }
    }
}

Note: If you do not want to enter the data in the list attributes (i.e. attributes where the type is set to list), you should not include them in the request. Adding empty list attributes will give erroneous results.

Sample Deal Update Response in the JSON Format

{
    "C1-DealCreationUpdateIWS":
    {
        "actionFlag" :"UPD",
        "dealResponse"
        {
        message" :"Deal Updated Successfully",
        }
        "dealDetails"
        {
            "dealIdentifier" :"DEALPRS2022PER23",
            "dealInformation" :"4524551669,CITI BANK,CORP,03-09-2022,United States Dollars,Contracted Deal-No,(1),DEALPRS2022PER23",
            "dealId" :"4524551669",
            "modelId" :"9202703256",
            "dealEntityType" :"PRSP",
            "customerSegment" :"COMM",
            "customerTier" :"T",
            "division" :"930",
            "accessGrp" :"***",
            "dealEntityId" :"0218803513",
            "contractedDealFlag" :"false",
            "currency" :"USD",
            "dealTypeCode" :"ANRMONLY",
            "startDate" :"2022-03-09",
            "endDate" :"2023-03-09",
            "simulationTypeFlag" :"CUST",
            "dealDescription" :"Deal Description update",
            "longDescription" :"Deal description update",
            "dealVersionDescription" :"Deal version description update",
            "dealFrequency" :"1",
            "skipReferenceFlag" :"true",
            "priceSelectionDate" :"2022-03-09",
            "usagePeriod" :"1",
            "includeHierarchyFlag" :"true",
            "status" :"PSML",
            "templateFlag" :"false",
            "createdDate" :"2022-03-09",
        }
        "templateReferenceDetails"
        {
            "copyBasicDetailsFlag" :"false",
            "copyPricingFlag" :"false",
            "copyUsageFlag" :"false",
        }
        "dealCharacteristics"
        {
            "characteristicType" :"ABC",
            "effectiveDate" :"2021-03-09",
            "characteristicValue" :"5881231767",
        }
        "dealTermsAndConditionsDetails"
        {
            "termsAndConditionsList"
            {
                "description" :"T&C 1 Desc"
                "termsAndCondition" :"T&C 1"
                "termsAndConditionText" :"Adhoc Text"
            }
            "adhocTermsAndCondition" :"Adhoc Description",
        }
        "productDetailsList"
        {
            "productCode" :"IMA_BP1",
        }
        {
            "productCode" :"IMA_BP2",
        }
        "referenceDetails"
        {
            "referUsageSw" :"false",
            "referPriceSw" :"false",
            "includeChildHierarchy" :"false",
        }
    }
}

Note: We have given the above request and response samples to illustrate how the attribute value pairs should be structured while sending a deal update request from the external system. However, you should not seamlessly use this request sample in your environment because the required pre-requisite data may not be available in your environment. In such case, the system will give erroneous results.

Related Topics

For more information on...	See...
Deal update request and response attribute/value pairs in the JSON format	Deal Update Request and Response - Attribute/Value Pairs in the JSON Format