CPIWSX


Click here for a complete list of operations.

HistoricalValues

Retrieve historical values by vehicle description

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sYear:
sMake:
sModel:
bFillDrilldown:
dHistoricalDate:

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

<?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/CPIWSX">
      <userid>string</userid>
      <password>string</password>
      <customer>string</customer>
      <producttype>string</producttype>
      <returncode>int</returncode>
      <returnmessage>string</returnmessage>
    </UserCredentials>
  </soap:Header>
  <soap:Body>
    <HistoricalValues xmlns="https://www.blackbookws.com/CPIWSX">
      <sYear>string</sYear>
      <sMake>string</sMake>
      <sModel>string</sModel>
      <bFillDrilldown>boolean</bFillDrilldown>
      <dHistoricalDate>dateTime</dHistoricalDate>
    </HistoricalValues>
  </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/CPIWSX">
      <userid>string</userid>
      <password>string</password>
      <customer>string</customer>
      <producttype>string</producttype>
      <returncode>int</returncode>
      <returnmessage>string</returnmessage>
    </UserCredentials>
  </soap:Header>
  <soap:Body>
    <HistoricalValuesResponse xmlns="https://www.blackbookws.com/CPIWSX">
      <HistoricalValuesResult>
        <value>
          <country>string</country>
          <frequency>string</frequency>
          <year>string</year>
          <make>string</make>
          <model>string</model>
          <fair>decimal</fair>
          <good>decimal</good>
          <excl>decimal</excl>
          <actualdate>dateTime</actualdate>
          <make_cd>string</make_cd>
          <full_uvc>string</full_uvc>
        </value>
        <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>
      </HistoricalValuesResult>
    </HistoricalValuesResponse>
  </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 /cpi/cpiwsx.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/CPIWSX">
      <userid>string</userid>
      <password>string</password>
      <customer>string</customer>
      <producttype>string</producttype>
      <returncode>int</returncode>
      <returnmessage>string</returnmessage>
    </UserCredentials>
  </soap12:Header>
  <soap12:Body>
    <HistoricalValues xmlns="https://www.blackbookws.com/CPIWSX">
      <sYear>string</sYear>
      <sMake>string</sMake>
      <sModel>string</sModel>
      <bFillDrilldown>boolean</bFillDrilldown>
      <dHistoricalDate>dateTime</dHistoricalDate>
    </HistoricalValues>
  </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/CPIWSX">
      <userid>string</userid>
      <password>string</password>
      <customer>string</customer>
      <producttype>string</producttype>
      <returncode>int</returncode>
      <returnmessage>string</returnmessage>
    </UserCredentials>
  </soap12:Header>
  <soap12:Body>
    <HistoricalValuesResponse xmlns="https://www.blackbookws.com/CPIWSX">
      <HistoricalValuesResult>
        <value>
          <country>string</country>
          <frequency>string</frequency>
          <year>string</year>
          <make>string</make>
          <model>string</model>
          <fair>decimal</fair>
          <good>decimal</good>
          <excl>decimal</excl>
          <actualdate>dateTime</actualdate>
          <make_cd>string</make_cd>
          <full_uvc>string</full_uvc>
        </value>
        <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>
      </HistoricalValuesResult>
    </HistoricalValuesResponse>
  </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 /cpi/cpiwsx.asmx/HistoricalValues?sYear=string&sMake=string&sModel=string&bFillDrilldown=string&dHistoricalDate=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"?>
<BBValues xmlns="https://www.blackbookws.com/CPIWSX">
  <value>
    <country>string</country>
    <frequency>string</frequency>
    <year>string</year>
    <make>string</make>
    <model>string</model>
    <fair>decimal</fair>
    <good>decimal</good>
    <excl>decimal</excl>
    <actualdate>dateTime</actualdate>
    <make_cd>string</make_cd>
    <full_uvc>string</full_uvc>
  </value>
  <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>
</BBValues>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /cpi/cpiwsx.asmx/HistoricalValues HTTP/1.1
Host: qa.blackbookws.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sYear=string&sMake=string&sModel=string&bFillDrilldown=string&dHistoricalDate=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<BBValues xmlns="https://www.blackbookws.com/CPIWSX">
  <value>
    <country>string</country>
    <frequency>string</frequency>
    <year>string</year>
    <make>string</make>
    <model>string</model>
    <fair>decimal</fair>
    <good>decimal</good>
    <excl>decimal</excl>
    <actualdate>dateTime</actualdate>
    <make_cd>string</make_cd>
    <full_uvc>string</full_uvc>
  </value>
  <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>
</BBValues>