UsedCarWSX
Click here for a complete list of operations.
CurrentVINValuesWithHAV
Retrieve current values and history adjustments by VIN
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /usedcar/usedcarwsx.asmx HTTP/1.1
Host: qa.blackbookws.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://blackbookws.com/UsedCarWSX/CurrentVINValuesWithHAV"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<UserCredentials xmlns="https://blackbookws.com/UsedCarWSX">
<userid>string</userid>
<password>string</password>
<customer>string</customer>
<producttype>string</producttype>
<returncode>int</returncode>
<returnmessage>string</returnmessage>
</UserCredentials>
</soap:Header>
<soap:Body>
<CurrentVINValuesWithHAV xmlns="https://blackbookws.com/UsedCarWSX">
<sCountryCode>string</sCountryCode>
<sFrequencyCode>string</sFrequencyCode>
<sVIN>string</sVIN>
<iMileage>int</iMileage>
<sState>string</sState>
<iExtraCleanAddDeductAdj>int</iExtraCleanAddDeductAdj>
<iCleanAddDeductAdj>int</iCleanAddDeductAdj>
<iAverageAddDeductAdj>int</iAverageAddDeductAdj>
<iRoughAddDeductAdj>int</iRoughAddDeductAdj>
<bFillDrilldown>boolean</bFillDrilldown>
<bReturnMileage>boolean</bReturnMileage>
<bReturnAddDeducts>boolean</bReturnAddDeducts>
</CurrentVINValuesWithHAV>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<UserCredentials xmlns="https://blackbookws.com/UsedCarWSX">
<userid>string</userid>
<password>string</password>
<customer>string</customer>
<producttype>string</producttype>
<returncode>int</returncode>
<returnmessage>string</returnmessage>
</UserCredentials>
</soap:Header>
<soap:Body>
<CurrentVINValuesWithHAVResponse xmlns="https://blackbookws.com/UsedCarWSX">
<CurrentVINValuesWithHAVResult>
<valueArray>
<BBValueHAV>
<history_adj_whole_xclean>decimal</history_adj_whole_xclean>
<history_adj_whole_clean>decimal</history_adj_whole_clean>
<history_adj_whole_avg>decimal</history_adj_whole_avg>
<history_adj_whole_rough>decimal</history_adj_whole_rough>
<history_adj_retail_xclean>decimal</history_adj_retail_xclean>
<history_adj_retail_clean>decimal</history_adj_retail_clean>
<history_adj_retail_avg>decimal</history_adj_retail_avg>
<history_adj_retail_rough>decimal</history_adj_retail_rough>
<history_adj_tradein_clean>decimal</history_adj_tradein_clean>
<history_adj_tradein_avg>decimal</history_adj_tradein_avg>
<history_adj_tradein_rough>decimal</history_adj_tradein_rough>
</BBValueHAV>
<BBValueHAV>
<history_adj_whole_xclean>decimal</history_adj_whole_xclean>
<history_adj_whole_clean>decimal</history_adj_whole_clean>
<history_adj_whole_avg>decimal</history_adj_whole_avg>
<history_adj_whole_rough>decimal</history_adj_whole_rough>
<history_adj_retail_xclean>decimal</history_adj_retail_xclean>
<history_adj_retail_clean>decimal</history_adj_retail_clean>
<history_adj_retail_avg>decimal</history_adj_retail_avg>
<history_adj_retail_rough>decimal</history_adj_retail_rough>
<history_adj_tradein_clean>decimal</history_adj_tradein_clean>
<history_adj_tradein_avg>decimal</history_adj_tradein_avg>
<history_adj_tradein_rough>decimal</history_adj_tradein_rough>
</BBValueHAV>
</valueArray>
<mileageArray>
<BBMileage>
<vin_year>string</vin_year>
<beginrange>int</beginrange>
<endrange>int</endrange>
<extraclean>int</extraclean>
<clean>int</clean>
<average>int</average>
<rough>int</rough>
<finadv>int</finadv>
<mileage_cat>string</mileage_cat>
</BBMileage>
<BBMileage>
<vin_year>string</vin_year>
<beginrange>int</beginrange>
<endrange>int</endrange>
<extraclean>int</extraclean>
<clean>int</clean>
<average>int</average>
<rough>int</rough>
<finadv>int</finadv>
<mileage_cat>string</mileage_cat>
</BBMileage>
</mileageArray>
<addDeductArray>
<BBAddDeduct>
<uoc>string</uoc>
<description>string</description>
<groupnum>string</groupnum>
<extraclean>decimal</extraclean>
<clean>decimal</clean>
<average>decimal</average>
<rough>decimal</rough>
<auto>string</auto>
<res12>decimal</res12>
<res24>decimal</res24>
<res30>decimal</res30>
<res36>decimal</res36>
<res42>decimal</res42>
<res48>decimal</res48>
<res60>decimal</res60>
<res72>decimal</res72>
<fullyear>string</fullyear>
</BBAddDeduct>
<BBAddDeduct>
<uoc>string</uoc>
<description>string</description>
<groupnum>string</groupnum>
<extraclean>decimal</extraclean>
<clean>decimal</clean>
<average>decimal</average>
<rough>decimal</rough>
<auto>string</auto>
<res12>decimal</res12>
<res24>decimal</res24>
<res30>decimal</res30>
<res36>decimal</res36>
<res42>decimal</res42>
<res48>decimal</res48>
<res60>decimal</res60>
<res72>decimal</res72>
<fullyear>string</fullyear>
</BBAddDeduct>
</addDeductArray>
<modelnumberArray>
<BBModelNumber>
<full_uvc>string</full_uvc>
<model_number>string</model_number>
</BBModelNumber>
<BBModelNumber>
<full_uvc>string</full_uvc>
<model_number>string</model_number>
</BBModelNumber>
</modelnumberArray>
<years>
<years>
<year>string</year>
<year>string</year>
</years>
</years>
<makes>
<makes>
<make>string</make>
<make>string</make>
</makes>
</makes>
<models>
<models>
<model>string</model>
<model>string</model>
</models>
</models>
<series>
<series>
<vehseries>string</vehseries>
<vehseries>string</vehseries>
</series>
</series>
<styles>
<styles>
<style>string</style>
<style>string</style>
</styles>
</styles>
</CurrentVINValuesWithHAVResult>
</CurrentVINValuesWithHAVResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /usedcar/usedcarwsx.asmx HTTP/1.1
Host: qa.blackbookws.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<UserCredentials xmlns="https://blackbookws.com/UsedCarWSX">
<userid>string</userid>
<password>string</password>
<customer>string</customer>
<producttype>string</producttype>
<returncode>int</returncode>
<returnmessage>string</returnmessage>
</UserCredentials>
</soap12:Header>
<soap12:Body>
<CurrentVINValuesWithHAV xmlns="https://blackbookws.com/UsedCarWSX">
<sCountryCode>string</sCountryCode>
<sFrequencyCode>string</sFrequencyCode>
<sVIN>string</sVIN>
<iMileage>int</iMileage>
<sState>string</sState>
<iExtraCleanAddDeductAdj>int</iExtraCleanAddDeductAdj>
<iCleanAddDeductAdj>int</iCleanAddDeductAdj>
<iAverageAddDeductAdj>int</iAverageAddDeductAdj>
<iRoughAddDeductAdj>int</iRoughAddDeductAdj>
<bFillDrilldown>boolean</bFillDrilldown>
<bReturnMileage>boolean</bReturnMileage>
<bReturnAddDeducts>boolean</bReturnAddDeducts>
</CurrentVINValuesWithHAV>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<UserCredentials xmlns="https://blackbookws.com/UsedCarWSX">
<userid>string</userid>
<password>string</password>
<customer>string</customer>
<producttype>string</producttype>
<returncode>int</returncode>
<returnmessage>string</returnmessage>
</UserCredentials>
</soap12:Header>
<soap12:Body>
<CurrentVINValuesWithHAVResponse xmlns="https://blackbookws.com/UsedCarWSX">
<CurrentVINValuesWithHAVResult>
<valueArray>
<BBValueHAV>
<history_adj_whole_xclean>decimal</history_adj_whole_xclean>
<history_adj_whole_clean>decimal</history_adj_whole_clean>
<history_adj_whole_avg>decimal</history_adj_whole_avg>
<history_adj_whole_rough>decimal</history_adj_whole_rough>
<history_adj_retail_xclean>decimal</history_adj_retail_xclean>
<history_adj_retail_clean>decimal</history_adj_retail_clean>
<history_adj_retail_avg>decimal</history_adj_retail_avg>
<history_adj_retail_rough>decimal</history_adj_retail_rough>
<history_adj_tradein_clean>decimal</history_adj_tradein_clean>
<history_adj_tradein_avg>decimal</history_adj_tradein_avg>
<history_adj_tradein_rough>decimal</history_adj_tradein_rough>
</BBValueHAV>
<BBValueHAV>
<history_adj_whole_xclean>decimal</history_adj_whole_xclean>
<history_adj_whole_clean>decimal</history_adj_whole_clean>
<history_adj_whole_avg>decimal</history_adj_whole_avg>
<history_adj_whole_rough>decimal</history_adj_whole_rough>
<history_adj_retail_xclean>decimal</history_adj_retail_xclean>
<history_adj_retail_clean>decimal</history_adj_retail_clean>
<history_adj_retail_avg>decimal</history_adj_retail_avg>
<history_adj_retail_rough>decimal</history_adj_retail_rough>
<history_adj_tradein_clean>decimal</history_adj_tradein_clean>
<history_adj_tradein_avg>decimal</history_adj_tradein_avg>
<history_adj_tradein_rough>decimal</history_adj_tradein_rough>
</BBValueHAV>
</valueArray>
<mileageArray>
<BBMileage>
<vin_year>string</vin_year>
<beginrange>int</beginrange>
<endrange>int</endrange>
<extraclean>int</extraclean>
<clean>int</clean>
<average>int</average>
<rough>int</rough>
<finadv>int</finadv>
<mileage_cat>string</mileage_cat>
</BBMileage>
<BBMileage>
<vin_year>string</vin_year>
<beginrange>int</beginrange>
<endrange>int</endrange>
<extraclean>int</extraclean>
<clean>int</clean>
<average>int</average>
<rough>int</rough>
<finadv>int</finadv>
<mileage_cat>string</mileage_cat>
</BBMileage>
</mileageArray>
<addDeductArray>
<BBAddDeduct>
<uoc>string</uoc>
<description>string</description>
<groupnum>string</groupnum>
<extraclean>decimal</extraclean>
<clean>decimal</clean>
<average>decimal</average>
<rough>decimal</rough>
<auto>string</auto>
<res12>decimal</res12>
<res24>decimal</res24>
<res30>decimal</res30>
<res36>decimal</res36>
<res42>decimal</res42>
<res48>decimal</res48>
<res60>decimal</res60>
<res72>decimal</res72>
<fullyear>string</fullyear>
</BBAddDeduct>
<BBAddDeduct>
<uoc>string</uoc>
<description>string</description>
<groupnum>string</groupnum>
<extraclean>decimal</extraclean>
<clean>decimal</clean>
<average>decimal</average>
<rough>decimal</rough>
<auto>string</auto>
<res12>decimal</res12>
<res24>decimal</res24>
<res30>decimal</res30>
<res36>decimal</res36>
<res42>decimal</res42>
<res48>decimal</res48>
<res60>decimal</res60>
<res72>decimal</res72>
<fullyear>string</fullyear>
</BBAddDeduct>
</addDeductArray>
<modelnumberArray>
<BBModelNumber>
<full_uvc>string</full_uvc>
<model_number>string</model_number>
</BBModelNumber>
<BBModelNumber>
<full_uvc>string</full_uvc>
<model_number>string</model_number>
</BBModelNumber>
</modelnumberArray>
<years>
<years>
<year>string</year>
<year>string</year>
</years>
</years>
<makes>
<makes>
<make>string</make>
<make>string</make>
</makes>
</makes>
<models>
<models>
<model>string</model>
<model>string</model>
</models>
</models>
<series>
<series>
<vehseries>string</vehseries>
<vehseries>string</vehseries>
</series>
</series>
<styles>
<styles>
<style>string</style>
<style>string</style>
</styles>
</styles>
</CurrentVINValuesWithHAVResult>
</CurrentVINValuesWithHAVResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /usedcar/usedcarwsx.asmx/CurrentVINValuesWithHAV?sCountryCode=string&sFrequencyCode=string&sVIN=string&iMileage=string&sState=string&iExtraCleanAddDeductAdj=string&iCleanAddDeductAdj=string&iAverageAddDeductAdj=string&iRoughAddDeductAdj=string&bFillDrilldown=string&bReturnMileage=string&bReturnAddDeducts=string HTTP/1.1 Host: qa.blackbookws.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<BBValuesHAV xmlns="https://blackbookws.com/UsedCarWSX">
<valueArray>
<BBValueHAV>
<history_adj_whole_xclean>decimal</history_adj_whole_xclean>
<history_adj_whole_clean>decimal</history_adj_whole_clean>
<history_adj_whole_avg>decimal</history_adj_whole_avg>
<history_adj_whole_rough>decimal</history_adj_whole_rough>
<history_adj_retail_xclean>decimal</history_adj_retail_xclean>
<history_adj_retail_clean>decimal</history_adj_retail_clean>
<history_adj_retail_avg>decimal</history_adj_retail_avg>
<history_adj_retail_rough>decimal</history_adj_retail_rough>
<history_adj_tradein_clean>decimal</history_adj_tradein_clean>
<history_adj_tradein_avg>decimal</history_adj_tradein_avg>
<history_adj_tradein_rough>decimal</history_adj_tradein_rough>
</BBValueHAV>
<BBValueHAV>
<history_adj_whole_xclean>decimal</history_adj_whole_xclean>
<history_adj_whole_clean>decimal</history_adj_whole_clean>
<history_adj_whole_avg>decimal</history_adj_whole_avg>
<history_adj_whole_rough>decimal</history_adj_whole_rough>
<history_adj_retail_xclean>decimal</history_adj_retail_xclean>
<history_adj_retail_clean>decimal</history_adj_retail_clean>
<history_adj_retail_avg>decimal</history_adj_retail_avg>
<history_adj_retail_rough>decimal</history_adj_retail_rough>
<history_adj_tradein_clean>decimal</history_adj_tradein_clean>
<history_adj_tradein_avg>decimal</history_adj_tradein_avg>
<history_adj_tradein_rough>decimal</history_adj_tradein_rough>
</BBValueHAV>
</valueArray>
<mileageArray>
<BBMileage>
<vin_year>string</vin_year>
<beginrange>int</beginrange>
<endrange>int</endrange>
<extraclean>int</extraclean>
<clean>int</clean>
<average>int</average>
<rough>int</rough>
<finadv>int</finadv>
<mileage_cat>string</mileage_cat>
</BBMileage>
<BBMileage>
<vin_year>string</vin_year>
<beginrange>int</beginrange>
<endrange>int</endrange>
<extraclean>int</extraclean>
<clean>int</clean>
<average>int</average>
<rough>int</rough>
<finadv>int</finadv>
<mileage_cat>string</mileage_cat>
</BBMileage>
</mileageArray>
<addDeductArray>
<BBAddDeduct>
<uoc>string</uoc>
<description>string</description>
<groupnum>string</groupnum>
<extraclean>decimal</extraclean>
<clean>decimal</clean>
<average>decimal</average>
<rough>decimal</rough>
<auto>string</auto>
<res12>decimal</res12>
<res24>decimal</res24>
<res30>decimal</res30>
<res36>decimal</res36>
<res42>decimal</res42>
<res48>decimal</res48>
<res60>decimal</res60>
<res72>decimal</res72>
<fullyear>string</fullyear>
</BBAddDeduct>
<BBAddDeduct>
<uoc>string</uoc>
<description>string</description>
<groupnum>string</groupnum>
<extraclean>decimal</extraclean>
<clean>decimal</clean>
<average>decimal</average>
<rough>decimal</rough>
<auto>string</auto>
<res12>decimal</res12>
<res24>decimal</res24>
<res30>decimal</res30>
<res36>decimal</res36>
<res42>decimal</res42>
<res48>decimal</res48>
<res60>decimal</res60>
<res72>decimal</res72>
<fullyear>string</fullyear>
</BBAddDeduct>
</addDeductArray>
<modelnumberArray>
<BBModelNumber>
<full_uvc>string</full_uvc>
<model_number>string</model_number>
</BBModelNumber>
<BBModelNumber>
<full_uvc>string</full_uvc>
<model_number>string</model_number>
</BBModelNumber>
</modelnumberArray>
<years>
<years>
<year>string</year>
<year>string</year>
</years>
</years>
<makes>
<makes>
<make>string</make>
<make>string</make>
</makes>
</makes>
<models>
<models>
<model>string</model>
<model>string</model>
</models>
</models>
<series>
<series>
<vehseries>string</vehseries>
<vehseries>string</vehseries>
</series>
</series>
<styles>
<styles>
<style>string</style>
<style>string</style>
</styles>
</styles>
</BBValuesHAV>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /usedcar/usedcarwsx.asmx/CurrentVINValuesWithHAV HTTP/1.1 Host: qa.blackbookws.com Content-Type: application/x-www-form-urlencoded Content-Length: length sCountryCode=string&sFrequencyCode=string&sVIN=string&iMileage=string&sState=string&iExtraCleanAddDeductAdj=string&iCleanAddDeductAdj=string&iAverageAddDeductAdj=string&iRoughAddDeductAdj=string&bFillDrilldown=string&bReturnMileage=string&bReturnAddDeducts=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<BBValuesHAV xmlns="https://blackbookws.com/UsedCarWSX">
<valueArray>
<BBValueHAV>
<history_adj_whole_xclean>decimal</history_adj_whole_xclean>
<history_adj_whole_clean>decimal</history_adj_whole_clean>
<history_adj_whole_avg>decimal</history_adj_whole_avg>
<history_adj_whole_rough>decimal</history_adj_whole_rough>
<history_adj_retail_xclean>decimal</history_adj_retail_xclean>
<history_adj_retail_clean>decimal</history_adj_retail_clean>
<history_adj_retail_avg>decimal</history_adj_retail_avg>
<history_adj_retail_rough>decimal</history_adj_retail_rough>
<history_adj_tradein_clean>decimal</history_adj_tradein_clean>
<history_adj_tradein_avg>decimal</history_adj_tradein_avg>
<history_adj_tradein_rough>decimal</history_adj_tradein_rough>
</BBValueHAV>
<BBValueHAV>
<history_adj_whole_xclean>decimal</history_adj_whole_xclean>
<history_adj_whole_clean>decimal</history_adj_whole_clean>
<history_adj_whole_avg>decimal</history_adj_whole_avg>
<history_adj_whole_rough>decimal</history_adj_whole_rough>
<history_adj_retail_xclean>decimal</history_adj_retail_xclean>
<history_adj_retail_clean>decimal</history_adj_retail_clean>
<history_adj_retail_avg>decimal</history_adj_retail_avg>
<history_adj_retail_rough>decimal</history_adj_retail_rough>
<history_adj_tradein_clean>decimal</history_adj_tradein_clean>
<history_adj_tradein_avg>decimal</history_adj_tradein_avg>
<history_adj_tradein_rough>decimal</history_adj_tradein_rough>
</BBValueHAV>
</valueArray>
<mileageArray>
<BBMileage>
<vin_year>string</vin_year>
<beginrange>int</beginrange>
<endrange>int</endrange>
<extraclean>int</extraclean>
<clean>int</clean>
<average>int</average>
<rough>int</rough>
<finadv>int</finadv>
<mileage_cat>string</mileage_cat>
</BBMileage>
<BBMileage>
<vin_year>string</vin_year>
<beginrange>int</beginrange>
<endrange>int</endrange>
<extraclean>int</extraclean>
<clean>int</clean>
<average>int</average>
<rough>int</rough>
<finadv>int</finadv>
<mileage_cat>string</mileage_cat>
</BBMileage>
</mileageArray>
<addDeductArray>
<BBAddDeduct>
<uoc>string</uoc>
<description>string</description>
<groupnum>string</groupnum>
<extraclean>decimal</extraclean>
<clean>decimal</clean>
<average>decimal</average>
<rough>decimal</rough>
<auto>string</auto>
<res12>decimal</res12>
<res24>decimal</res24>
<res30>decimal</res30>
<res36>decimal</res36>
<res42>decimal</res42>
<res48>decimal</res48>
<res60>decimal</res60>
<res72>decimal</res72>
<fullyear>string</fullyear>
</BBAddDeduct>
<BBAddDeduct>
<uoc>string</uoc>
<description>string</description>
<groupnum>string</groupnum>
<extraclean>decimal</extraclean>
<clean>decimal</clean>
<average>decimal</average>
<rough>decimal</rough>
<auto>string</auto>
<res12>decimal</res12>
<res24>decimal</res24>
<res30>decimal</res30>
<res36>decimal</res36>
<res42>decimal</res42>
<res48>decimal</res48>
<res60>decimal</res60>
<res72>decimal</res72>
<fullyear>string</fullyear>
</BBAddDeduct>
</addDeductArray>
<modelnumberArray>
<BBModelNumber>
<full_uvc>string</full_uvc>
<model_number>string</model_number>
</BBModelNumber>
<BBModelNumber>
<full_uvc>string</full_uvc>
<model_number>string</model_number>
</BBModelNumber>
</modelnumberArray>
<years>
<years>
<year>string</year>
<year>string</year>
</years>
</years>
<makes>
<makes>
<make>string</make>
<make>string</make>
</makes>
</makes>
<models>
<models>
<model>string</model>
<model>string</model>
</models>
</models>
<series>
<series>
<vehseries>string</vehseries>
<vehseries>string</vehseries>
</series>
</series>
<styles>
<styles>
<style>string</style>
<style>string</style>
</styles>
</styles>
</BBValuesHAV>