Sample Deal Creation Request and Response in the XML Format

Using the below example, you can create the deal for 0074771343 person.

Sample Deal Creation Request in the XML Format

<C1-DealCreationUpdateIWS>
    <actionFlag>ADD</actionFlag>
        <dealDetails>
        <dealEntityDetails>
            <personId>0074771343</personId>
        </dealEntityDetails>
        <dealIdentifier>EXISTINGPER1</dealIdentifier>
        <dealEntityType>EPER</dealEntityType>
        <contractedDealFlag>false</contractedDealFlag>
        <currency>USD</currency>
        <dealTypeCode>APRTESNEW</dealTypeCode>
        <startDate>2022-02-26</startDate>
        <simulationTypeFlag>CUST</simulationTypeFlag>
        <reviewFrequency>6</reviewFrequency>
        <dealDescription>deal descript</dealDescription>
        <dealVersionDescription>version desc</dealVersionDescription>
        <dealFrequency>12</dealFrequency>
        <skipReferenceFlag>true</skipReferenceFlag>
        <priceSelectionDate>2022-02-22</priceSelectionDate>
        <usagePeriod>12</usagePeriod>
        <includeHierarchyFlag>true</includeHierarchyFlag>
        <templateFlag>false</templateFlag>
    </dealDetails>
    <dealCharacteristics>
        <characteristicType>ZZ-DLCHR</characteristicType>
        <effectiveDate>2021-06-01</effectiveDate>
        <characteristicValue>7266725883</characteristicValue>
    </dealCharacteristics>
    <dealTermsAndConditionsDetails>
        <termsAndConditionsList>
            <termsAndCondition>TEST SPE CR</termsAndCondition>
            <termsAndConditionText>new tc</termsAndConditionText>
        </termsAndConditionsList> 
        <termsAndConditionsList>
             <termsAndCondition>TEST_TC8</termsAndCondition>
            <termsAndConditionText>Test changedaaaa</termsAndConditionText>
        </termsAndConditionsList> 
        <adhocTermsAndCondition>DOCH DESC</adhocTermsAndCondition>
    </dealTermsAndConditionsDetails>
    <productDetailsList>
        <productCode>AUT_MPD1_BUSS1</productCode>
    </productDetailsList>
    <productDetailsList>
        <productCode>AUT_MPD_930_TECH</productCode>
    </productDetailsList>
    <productDetailsList>
        <productCode>AUT_MPD_CA_TECH</productCode>
    </productDetailsList>
    <productDetailsList>
        <productCode>RTEST_BPTECT</productCode>
    </productDetailsList>
</C1-DealCreationUpdateIWS>
Note: If you do not want to enter the data in the list tags (i.e. tags where the type is set to list), you should not include them in the request. Adding empty list tags will give erroneous results.

Sample Deal Creation Response in the XML Format

<C1-DealCreationUpdateIWS>
    <actionFlag>UPD</actionFlag>
    <dealresponse>
        <message>Deal Created Successfully.</message>
    </dealresponse>
    <dealDetails>
        <dealEntityDetails>
            <personId>0074771343</personId>
        </dealEntityDetails>
        <dealIdentifier>EXISTINGPER1</dealIdentifier>
        <dealInformation>8896302706,Prod,Prerana,02-26-2022,United States Dollars,Contracted Deal-No,(1),EXISTINGPER1 ,deal descript,930-California Branch, , , ,Aparna RM only,Pending Simulation,Customer,System Default,Template-No,BKADMIN ,02-26-2022, , ,Biannually,Yearly, , , ,Skip Reference-Yes,Account,0074771343,Yearly, , ,02-22-2022, ,Skip Questionaire-Yes, ,Include Hierarchy-Yes</dealInformation>
        <dealId>8896302706</dealId>
        <modelId>0662805484</modelId>
        <dealEntityType>EPER</dealEntityType>
        <customerSegment></customerSegment>
        <customerTier></customerTier>
        <division>930</division>
        <accessGrp>***</accessGrp>
        <dealEntityId>0074771343</dealEntityId>
        <contractedDealFlag>false</contractedDealFlag>
        <currency>USD</currency>
        <dealTypeCode>APRTESNEW</dealTypeCode>
        <startDate>2022-02-26</startDate>
        <simulationTypeFlag>CUST</simulationTypeFlag>
        <reviewFrequency>6</reviewFrequency>
        <dealDescription>deal descript</dealDescription>
        <dealVersionDescription>version desc</dealVersionDescription>
        <dealFrequency>12</dealFrequency>
        <skipReferenceFlag>true</skipReferenceFlag>
        <priceSelectionDate>2022-02-22</priceSelectionDate>
        <usagePeriod>12</usagePeriod>
        <includeHierarchyFlag>true</includeHierarchyFlag>
        <status>PSML</status>
        <templateFlag>false</templateFlag>
    </dealDetails>
    <templateReferenceDetails>
        <copyBasicDetailsFlag>false</copyBasicDetailsFlag>
        <copyPricingFlag>false</copyPricingFlag>
        <copyUsageFlag>false</copyUsageFlag>
    </templateReferenceDetails>
    <dealCharacteristics>
        <characteristicType>ZZ-DLCHR</characteristicType>
        <effectiveDate>2021-06-01</effectiveDate>
        <characteristicValue>7266725883</characteristicValue>
    </dealCharacteristics>
    <dealTermsAndConditionsDetails>
        <termsAndConditionsList>
            <termsAndCondition>TEST SPE CR</termsAndCondition>
            <termsAndConditionText>new tc</termsAndConditionText>
        </termsAndConditionsList>
        <termsAndConditionsList>
            <termsAndCondition>TEST_TC8</termsAndCondition>
            <termsAndConditionText>Test changedaaaa</termsAndConditionText>
        </termsAndConditionsList> 
        <adhocTermsAndCondition>DOCH DESC</adhocTermsAndCondition>
    </dealTermsAndConditionsDetails>
    <productDetailsList>
        <productCode>AUT_MPD1_BUSS1</productCode>
    </productDetailsList>
    <productDetailsList>
        <productCode>AUT_MPD_930_TECH</productCode>
    </productDetailsList>
    <productDetailsList>
        <productCode>AUT_MPD_CA_TECH</productCode>
    </productDetailsList>
    <productDetailsList>
        <productCode>RTEST_BPTECT</productCode>
    </productDetailsList>
    <referenceDetails>
        <referUsageSw>false</referUsageSw>
        <referPriceSw>false</referPriceSw>
    </referenceDetails>
</C1-DealCreationUpdateIWS>
Note: We have given the above request and response samples to illustrate how the tags should be nested while sending a deal creation 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 creation request and response - tags in the XML format Deal Creation Request and Response - Tags in the XML Format