CPIWSX


Click here for a complete list of operations.

TrendAnalysis

Retrieve vehicle trend analysis values

Test

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

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/TrendAnalysis"

<?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>
    <TrendAnalysis xmlns="https://www.blackbookws.com/CPIWSX">
      <sYear>string</sYear>
      <sMake>string</sMake>
      <sModel>string</sModel>
      <sAnnualOrMonthly>string</sAnnualOrMonthly>
      <dStartDate>dateTime</dStartDate>
      <dEndDate>dateTime</dEndDate>
    </TrendAnalysis>
  </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>
    <TrendAnalysisResponse xmlns="https://www.blackbookws.com/CPIWSX">
      <TrendAnalysisResult>
        <BBTrend>
          <frequency>string</frequency>
          <trend_year>int</trend_year>
          <trend_month>int</trend_month>
          <fair>decimal</fair>
          <good>decimal</good>
          <excl>decimal</excl>
        </BBTrend>
        <BBTrend>
          <frequency>string</frequency>
          <trend_year>int</trend_year>
          <trend_month>int</trend_month>
          <fair>decimal</fair>
          <good>decimal</good>
          <excl>decimal</excl>
        </BBTrend>
      </TrendAnalysisResult>
    </TrendAnalysisResponse>
  </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>
    <TrendAnalysis xmlns="https://www.blackbookws.com/CPIWSX">
      <sYear>string</sYear>
      <sMake>string</sMake>
      <sModel>string</sModel>
      <sAnnualOrMonthly>string</sAnnualOrMonthly>
      <dStartDate>dateTime</dStartDate>
      <dEndDate>dateTime</dEndDate>
    </TrendAnalysis>
  </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>
    <TrendAnalysisResponse xmlns="https://www.blackbookws.com/CPIWSX">
      <TrendAnalysisResult>
        <BBTrend>
          <frequency>string</frequency>
          <trend_year>int</trend_year>
          <trend_month>int</trend_month>
          <fair>decimal</fair>
          <good>decimal</good>
          <excl>decimal</excl>
        </BBTrend>
        <BBTrend>
          <frequency>string</frequency>
          <trend_year>int</trend_year>
          <trend_month>int</trend_month>
          <fair>decimal</fair>
          <good>decimal</good>
          <excl>decimal</excl>
        </BBTrend>
      </TrendAnalysisResult>
    </TrendAnalysisResponse>
  </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/TrendAnalysis?sYear=string&sMake=string&sModel=string&sAnnualOrMonthly=string&dStartDate=string&dEndDate=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"?>
<ArrayOfBBTrend xmlns="https://www.blackbookws.com/CPIWSX">
  <BBTrend>
    <frequency>string</frequency>
    <trend_year>int</trend_year>
    <trend_month>int</trend_month>
    <fair>decimal</fair>
    <good>decimal</good>
    <excl>decimal</excl>
  </BBTrend>
  <BBTrend>
    <frequency>string</frequency>
    <trend_year>int</trend_year>
    <trend_month>int</trend_month>
    <fair>decimal</fair>
    <good>decimal</good>
    <excl>decimal</excl>
  </BBTrend>
</ArrayOfBBTrend>

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/TrendAnalysis HTTP/1.1
Host: qa.blackbookws.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfBBTrend xmlns="https://www.blackbookws.com/CPIWSX">
  <BBTrend>
    <frequency>string</frequency>
    <trend_year>int</trend_year>
    <trend_month>int</trend_month>
    <fair>decimal</fair>
    <good>decimal</good>
    <excl>decimal</excl>
  </BBTrend>
  <BBTrend>
    <frequency>string</frequency>
    <trend_year>int</trend_year>
    <trend_month>int</trend_month>
    <fair>decimal</fair>
    <good>decimal</good>
    <excl>decimal</excl>
  </BBTrend>
</ArrayOfBBTrend>