Auto Prompts - Response
Please see the Legend to understand the conventions used to document each element and attribute. Note that for responses, the XML elements are documented in the order that they appear in the response.
Element | Attributes |
---|---|
<outAUTO> | |
<Results> | |
<Description> | |
<XMLDetail>[] | |
<Proceeds> | |
<Auto> | |
<Price> | |
<Tax> | |
<LuxTax> | |
<PricePlusTax> | |
<CashDown> | |
<GrossTrade> | |
<Lien> | |
<Rebate> | |
<TotalDown> | |
<ServiceContract> | |
<TaxedFees> | |
<NonTaxedFees> | |
<TotalVehicleFees> |
🟥 <outAUTO>
Element Type | Data Type |
---|---|
Parent | - |
This is the root element of the XML response, and is required. This element simply acts as a container for all of the result child elements.
Attributes: None
🟥 <Results>
Element Type | Data Type |
---|---|
Parent | - |
This element contains child elements which describe the success or failure of the calculation, as well as any XML messages.
Attributes: None
🟥 <Results>
→<Description>
Element Type | Data Type |
---|---|
Data | Text |
If the calculation was completed successfully, then this element will contain
the value Successful Calculation
. Otherwise, this element will contain a
description of the problem encountered during the attempted computation.
Attributes: None
🟦 <Results>
→<XMLDetail>[]
Element Type | Data Type | Default |
---|---|---|
Data | Text | NULL |
The <XMLDetail>
elements are messages passed back to the calling application
which detail the status of the XML request. If the SCEX issues any warnings
regarding unrecognized elements or attributes, then each warning message will be
displayed in an <XMLDetail>
element.
Attributes: None
🟥 <Results>
→<Proceeds>
Element Type | Data Type | Values |
---|---|---|
Data | Currency | >0 |
The computed number which represents the dollar amount remaining after taking into account the vehicle price, down payment, trade-in, taxes, etc. This value could then be used as the proceeds amount for a loan calculation request.
Attributes: None
🟥 <Auto>
Element Type | Data Type |
---|---|
Parent | - |
This element contains child elements which contain the results of the auto prompts calculation.
Attributes: None
🟥 <Auto>
→<Price>
Element Type | Data Type |
---|---|
Data | Currency |
The vehicle price, as specified in the request.
Attributes: None
🟦 <Auto>
→<Tax>
Element Type | Data Type | Default |
---|---|---|
Data | Currency | 0 |
If the input requested that tax be computed, this element will contain the tax amount. Note that the two attributes Rate and Method will contain the same values as found in the input XML request.
Attributes: None
🟦 <Auto>
→<LuxTax>
Element Type | Data Type | Default |
---|---|---|
Data | Currency | 0 |
If luxury tax was calculated, then this element will contain the luxury tax amount. Note that the two attributes Rate and Threshold will contain the same values as found in the input XML request.
Attributes: None
🟥 <Auto>
→<PricePlusTax>
Element Type | Data Type |
---|---|
Data | Currency |
The vehicle price plus all computed taxes.
Attributes: None
🟦 <Auto>
→<CashDown>
Element Type | Data Type | Default |
---|---|---|
Data | Currency | 0 |
If a cash down payment was specified in the XML input request, then this element will hold its value. Otherwise, this element will not be displayed.
Attributes: None
🟦 <Auto>
→<GrossTrade>
Element Type | Data Type | Default |
---|---|---|
Data | Currency | 0 |
If a gross trade-in value was specified in the XML input request, then this element will hold its value. Otherwise, this element will not be displayed.
Attributes: None
🟦 <Auto>
→<Lien>
Element Type | Data Type | Default |
---|---|---|
Data | Currency | 0 |
If a lien amount was specified in the XML input request, then this element will hold its value. Otherwise, this element will not be displayed.
Attributes: None
🟦 <Auto>
→<Rebate>
Element Type | Data Type | Default |
---|---|---|
Data | Currency | 0 |
If a rebate amount was specified in the XML input request, then this element will hold its value. Otherwise, this element will not be displayed. Note that the ApplyToBalance attribute will contain the same value as found in the input XML request.
Attributes: None
🟦 <Auto>
→<TotalDown>
Element Type | Data Type | Default |
---|---|---|
Data | Currency | 0 |
This value of this element represents the total down payment for the vehicle. It is equal to the cash down plus gross trade-in, less the lien amount, and plus any rebate if it is applied to the balance.
Attributes: None
🟦 <Auto>
→<ServiceContract>
Element Type | Data Type | Default |
---|---|---|
Data | Currency | 0 |
If a service contract amount was specified in the XML input request, then this element will hold its value. Otherwise, this element will not be displayed.
Attributes: None
🟦 <Auto>
→<TaxedFees>
Element Type | Data Type | Default |
---|---|---|
Data | Currency | 0 |
If any taxed fees were included in the XML input request, then this element will hold its value. Otherwise, this element will not be displayed.
Attributes: None
🟦 <Auto>
→<NonTaxedFees>
Element Type | Data Type | Default |
---|---|---|
Data | Currency | 0 |
If any non-taxed fees were included in the XML input request, then this element will hold its value. Otherwise, this element will not be displayed.
Attributes: None
🟦 <Auto>
→<TotalVehicleFees>
Element Type | Data Type | Default |
---|---|---|
Data | Currency | 0 |
If present, this element holds the sum of the vehicle service contract, taxable fees, and non-taxable fees. If not present, the total of vehicle fees is zero.
Attributes: None