Uses the Component:VDDealManagementType
This section allows the calling application to select the amount of data that is returned in the response. It is possible to limit the response to only the highest level incentives or to request the full detail of every available incentive within the deal.
Table 6.7. Fields and Components
Name | Description | Occurrence | Type | Data Type | User Notes |
---|---|---|---|---|---|
topOfDealOnlyInd |
Allows the calling application to restrict the results to Top of Deal programs. Top of Deal programs are the primary incentives that a buyer receives when purchasing or financing a vehicle (consumer cash, finance, lease). Setting the flag to true will exclude all stackable add-on programs from the results. | 1..1 | Field | xsd:boolean | |
alwaysStackableOnlyInd |
Allows the calling application to restrict the results to: Top of Deal programs, and Always Stackable incentives. | 1..1 | Field | xsd:boolean | |
bestDealOnlyInd |
Allows the calling application to restrict the results to one deal for each Purchase Type. Identifies the best deal based on the purchase type only | 1..1 | Field | xsd:boolean | |
ignoreGeoConflictInd |
Geography conflicts occur when the physical geographic areas corresponding to the customer’s zip code(s) specified on a Get Valid Deal Permutations request span more than one county. When this occurs, it is possible that the consumer may not be eligible for some of the incentives. Calling applications may choose to let IOM handle the conflict resolution or they may choose to deal with the conflict in an interactive way. | 1..1 | Field | xsd:boolean | |
calculateSamplePaymentInd |
The Get Valid Deals service can calculate a sample monthly payment based on the price of the vehicle under consideration and its associated incentives. The Calling Application needs to provide inputs to the calculation, such as MSRP and down payment, in the Request Sample Payment group. The incentives for each sample payment (interest rate, residuals, etc.) will be obtained from the data on the incentive program. If true include a sample payment in the result. This requires additional input data (e.g. vehicle MSRP, downpayment). If the flag is set to false, then a sample payment group will not be calculated and the samplePayment group will not be included in the Response. | 1..1 | Field | xsd:boolean |
The XML Sample provided here is an approximation of the generated XML for this component. Not all of the fields are required for implementation.
Example 6.7. VDDealManagement
<VDDealManagement> <topOfDealOnlyInd>......</topOfDealOnlyInd> [1..1] <alwaysStackableOnlyInd>......</alwaysStackableOnlyInd> [1..1] <bestDealOnlyInd>......</bestDealOnlyInd> [1..1] <ignoreGeoConflictInd>......</ignoreGeoConflictInd> [1..1] <calculateSamplePaymentInd>......</calculateSamplePaymentInd> [1..1] </VDDealManagement>