TruckWSX Web Service

TruckWSX

Click here for a complete list of operations.

ApplyCurrentAdjustments

Apply current vehicle valuation adjustments

Test

The test form is only available for requests from the local machine.

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 /truck/truckwsx.asmx HTTP/1.1
Host: qa.blackbookws.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.blackbookws.com/TruckWSX/ApplyCurrentAdjustments"

<?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://www.blackbookws.com/TruckWSX">
      <userid>string</userid>
      <password>string</password>
      <customer>string</customer>
      <producttype>string</producttype>
      <returncode>int</returncode>
      <returnmessage>string</returnmessage>
    </UserCredentials>
  </soap:Header>
  <soap:Body>
    <ApplyCurrentAdjustments xmlns="https://www.blackbookws.com/TruckWSX">
      <values>
        <country>string</country>
        <frequency>string</frequency>
        <vehicle_id>decimal</vehicle_id>
        <year>string</year>
        <make>string</make>
        <model>string</model>
        <style>string</style>
        <full_vin>string</full_vin>
        <full_uvc>string</full_uvc>
        <model_number>string</model_number>
        <manufacturer>string</manufacturer>
        <veh_class>string</veh_class>
        <mileage_category>string</mileage_category>
        <mileage_category_desc>string</mileage_category_desc>
        <price_includes>string</price_includes>
        <actualdate>string</actualdate>
        <msrp>decimal</msrp>
        <whole_avg>decimal</whole_avg>
        <whole_rough>decimal</whole_rough>
        <retail_avg>decimal</retail_avg>
        <finadv>decimal</finadv>
        <base_whole_avg>decimal</base_whole_avg>
        <base_whole_rough>decimal</base_whole_rough>
        <base_retail_avg>decimal</base_retail_avg>
        <base_finadv>decimal</base_finadv>
        <mileage_adj_whole_avg>decimal</mileage_adj_whole_avg>
        <mileage_adj_whole_rough>decimal</mileage_adj_whole_rough>
        <mileage_adj_retail_avg>decimal</mileage_adj_retail_avg>
        <mileage_adj_finadv>decimal</mileage_adj_finadv>
        <ad_adj_whole_avg>decimal</ad_adj_whole_avg>
        <ad_adj_whole_rough>decimal</ad_adj_whole_rough>
        <ad_adj_retail_avg>decimal</ad_adj_retail_avg>
        <ad_adj_finadv>decimal</ad_adj_finadv>
        <gvw>string</gvw>
        <gcw>string</gcw>
        <cylinders>string</cylinders>
        <base_hp>string</base_hp>
        <engine_liters>string</engine_liters>
        <transmission>string</transmission>
        <market>string</market>
        <descriptionScore>string</descriptionScore>
        <bborgdesc>string</bborgdesc>
        <bbmoddesc>string</bbmoddesc>
        <custorgdesc>string</custorgdesc>
        <custmoddesc>string</custmoddesc>
        <custmodnumber>string</custmodnumber>
        <matchingwords>string</matchingwords>
      </values>
      <iMileage>int</iMileage>
      <iAverageAddDeductAdj>int</iAverageAddDeductAdj>
      <iRoughAddDeductAdj>int</iRoughAddDeductAdj>
    </ApplyCurrentAdjustments>
  </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://www.blackbookws.com/TruckWSX">
      <userid>string</userid>
      <password>string</password>
      <customer>string</customer>
      <producttype>string</producttype>
      <returncode>int</returncode>
      <returnmessage>string</returnmessage>
    </UserCredentials>
  </soap:Header>
  <soap:Body>
    <ApplyCurrentAdjustmentsResponse xmlns="https://www.blackbookws.com/TruckWSX">
      <ApplyCurrentAdjustmentsResult>
        <country>string</country>
        <frequency>string</frequency>
        <vehicle_id>decimal</vehicle_id>
        <year>string</year>
        <make>string</make>
        <model>string</model>
        <style>string</style>
        <full_vin>string</full_vin>
        <full_uvc>string</full_uvc>
        <model_number>string</model_number>
        <manufacturer>string</manufacturer>
        <veh_class>string</veh_class>
        <mileage_category>string</mileage_category>
        <mileage_category_desc>string</mileage_category_desc>
        <price_includes>string</price_includes>
        <actualdate>string</actualdate>
        <msrp>decimal</msrp>
        <whole_avg>decimal</whole_avg>
        <whole_rough>decimal</whole_rough>
        <retail_avg>decimal</retail_avg>
        <finadv>decimal</finadv>
        <base_whole_avg>decimal</base_whole_avg>
        <base_whole_rough>decimal</base_whole_rough>
        <base_retail_avg>decimal</base_retail_avg>
        <base_finadv>decimal</base_finadv>
        <mileage_adj_whole_avg>decimal</mileage_adj_whole_avg>
        <mileage_adj_whole_rough>decimal</mileage_adj_whole_rough>
        <mileage_adj_retail_avg>decimal</mileage_adj_retail_avg>
        <mileage_adj_finadv>decimal</mileage_adj_finadv>
        <ad_adj_whole_avg>decimal</ad_adj_whole_avg>
        <ad_adj_whole_rough>decimal</ad_adj_whole_rough>
        <ad_adj_retail_avg>decimal</ad_adj_retail_avg>
        <ad_adj_finadv>decimal</ad_adj_finadv>
        <gvw>string</gvw>
        <gcw>string</gcw>
        <cylinders>string</cylinders>
        <base_hp>string</base_hp>
        <engine_liters>string</engine_liters>
        <transmission>string</transmission>
        <market>string</market>
        <descriptionScore>string</descriptionScore>
        <bborgdesc>string</bborgdesc>
        <bbmoddesc>string</bbmoddesc>
        <custorgdesc>string</custorgdesc>
        <custmoddesc>string</custmoddesc>
        <custmodnumber>string</custmodnumber>
        <matchingwords>string</matchingwords>
      </ApplyCurrentAdjustmentsResult>
    </ApplyCurrentAdjustmentsResponse>
  </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 /truck/truckwsx.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://www.blackbookws.com/TruckWSX">
      <userid>string</userid>
      <password>string</password>
      <customer>string</customer>
      <producttype>string</producttype>
      <returncode>int</returncode>
      <returnmessage>string</returnmessage>
    </UserCredentials>
  </soap12:Header>
  <soap12:Body>
    <ApplyCurrentAdjustments xmlns="https://www.blackbookws.com/TruckWSX">
      <values>
        <country>string</country>
        <frequency>string</frequency>
        <vehicle_id>decimal</vehicle_id>
        <year>string</year>
        <make>string</make>
        <model>string</model>
        <style>string</style>
        <full_vin>string</full_vin>
        <full_uvc>string</full_uvc>
        <model_number>string</model_number>
        <manufacturer>string</manufacturer>
        <veh_class>string</veh_class>
        <mileage_category>string</mileage_category>
        <mileage_category_desc>string</mileage_category_desc>
        <price_includes>string</price_includes>
        <actualdate>string</actualdate>
        <msrp>decimal</msrp>
        <whole_avg>decimal</whole_avg>
        <whole_rough>decimal</whole_rough>
        <retail_avg>decimal</retail_avg>
        <finadv>decimal</finadv>
        <base_whole_avg>decimal</base_whole_avg>
        <base_whole_rough>decimal</base_whole_rough>
        <base_retail_avg>decimal</base_retail_avg>
        <base_finadv>decimal</base_finadv>
        <mileage_adj_whole_avg>decimal</mileage_adj_whole_avg>
        <mileage_adj_whole_rough>decimal</mileage_adj_whole_rough>
        <mileage_adj_retail_avg>decimal</mileage_adj_retail_avg>
        <mileage_adj_finadv>decimal</mileage_adj_finadv>
        <ad_adj_whole_avg>decimal</ad_adj_whole_avg>
        <ad_adj_whole_rough>decimal</ad_adj_whole_rough>
        <ad_adj_retail_avg>decimal</ad_adj_retail_avg>
        <ad_adj_finadv>decimal</ad_adj_finadv>
        <gvw>string</gvw>
        <gcw>string</gcw>
        <cylinders>string</cylinders>
        <base_hp>string</base_hp>
        <engine_liters>string</engine_liters>
        <transmission>string</transmission>
        <market>string</market>
        <descriptionScore>string</descriptionScore>
        <bborgdesc>string</bborgdesc>
        <bbmoddesc>string</bbmoddesc>
        <custorgdesc>string</custorgdesc>
        <custmoddesc>string</custmoddesc>
        <custmodnumber>string</custmodnumber>
        <matchingwords>string</matchingwords>
      </values>
      <iMileage>int</iMileage>
      <iAverageAddDeductAdj>int</iAverageAddDeductAdj>
      <iRoughAddDeductAdj>int</iRoughAddDeductAdj>
    </ApplyCurrentAdjustments>
  </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://www.blackbookws.com/TruckWSX">
      <userid>string</userid>
      <password>string</password>
      <customer>string</customer>
      <producttype>string</producttype>
      <returncode>int</returncode>
      <returnmessage>string</returnmessage>
    </UserCredentials>
  </soap12:Header>
  <soap12:Body>
    <ApplyCurrentAdjustmentsResponse xmlns="https://www.blackbookws.com/TruckWSX">
      <ApplyCurrentAdjustmentsResult>
        <country>string</country>
        <frequency>string</frequency>
        <vehicle_id>decimal</vehicle_id>
        <year>string</year>
        <make>string</make>
        <model>string</model>
        <style>string</style>
        <full_vin>string</full_vin>
        <full_uvc>string</full_uvc>
        <model_number>string</model_number>
        <manufacturer>string</manufacturer>
        <veh_class>string</veh_class>
        <mileage_category>string</mileage_category>
        <mileage_category_desc>string</mileage_category_desc>
        <price_includes>string</price_includes>
        <actualdate>string</actualdate>
        <msrp>decimal</msrp>
        <whole_avg>decimal</whole_avg>
        <whole_rough>decimal</whole_rough>
        <retail_avg>decimal</retail_avg>
        <finadv>decimal</finadv>
        <base_whole_avg>decimal</base_whole_avg>
        <base_whole_rough>decimal</base_whole_rough>
        <base_retail_avg>decimal</base_retail_avg>
        <base_finadv>decimal</base_finadv>
        <mileage_adj_whole_avg>decimal</mileage_adj_whole_avg>
        <mileage_adj_whole_rough>decimal</mileage_adj_whole_rough>
        <mileage_adj_retail_avg>decimal</mileage_adj_retail_avg>
        <mileage_adj_finadv>decimal</mileage_adj_finadv>
        <ad_adj_whole_avg>decimal</ad_adj_whole_avg>
        <ad_adj_whole_rough>decimal</ad_adj_whole_rough>
        <ad_adj_retail_avg>decimal</ad_adj_retail_avg>
        <ad_adj_finadv>decimal</ad_adj_finadv>
        <gvw>string</gvw>
        <gcw>string</gcw>
        <cylinders>string</cylinders>
        <base_hp>string</base_hp>
        <engine_liters>string</engine_liters>
        <transmission>string</transmission>
        <market>string</market>
        <descriptionScore>string</descriptionScore>
        <bborgdesc>string</bborgdesc>
        <bbmoddesc>string</bbmoddesc>
        <custorgdesc>string</custorgdesc>
        <custmoddesc>string</custmoddesc>
        <custmodnumber>string</custmodnumber>
        <matchingwords>string</matchingwords>
      </ApplyCurrentAdjustmentsResult>
    </ApplyCurrentAdjustmentsResponse>
  </soap12:Body>
</soap12:Envelope>