UsedCarWSX Web Service

UsedCarWSX

Click here for a complete list of operations.

HistoricalAddDeductsByFullYear

Retrieve historical add deducts

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
sCountryCode:
sFrequencyCode:
sYear:
sGroupNumber:
sVIN:
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 /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/HistoricalAddDeductsByFullYear"

<?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>
    <HistoricalAddDeductsByFullYear xmlns="https://blackbookws.com/UsedCarWSX">
      <sCountryCode>string</sCountryCode>
      <sFrequencyCode>string</sFrequencyCode>
      <sYear>string</sYear>
      <sGroupNumber>string</sGroupNumber>
      <sVIN>string</sVIN>
      <dHistoricalDate>dateTime</dHistoricalDate>
    </HistoricalAddDeductsByFullYear>
  </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>
    <HistoricalAddDeductsByFullYearResponse xmlns="https://blackbookws.com/UsedCarWSX">
      <HistoricalAddDeductsByFullYearResult>
        <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>
      </HistoricalAddDeductsByFullYearResult>
    </HistoricalAddDeductsByFullYearResponse>
  </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>
    <HistoricalAddDeductsByFullYear xmlns="https://blackbookws.com/UsedCarWSX">
      <sCountryCode>string</sCountryCode>
      <sFrequencyCode>string</sFrequencyCode>
      <sYear>string</sYear>
      <sGroupNumber>string</sGroupNumber>
      <sVIN>string</sVIN>
      <dHistoricalDate>dateTime</dHistoricalDate>
    </HistoricalAddDeductsByFullYear>
  </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>
    <HistoricalAddDeductsByFullYearResponse xmlns="https://blackbookws.com/UsedCarWSX">
      <HistoricalAddDeductsByFullYearResult>
        <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>
      </HistoricalAddDeductsByFullYearResult>
    </HistoricalAddDeductsByFullYearResponse>
  </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/HistoricalAddDeductsByFullYear?sCountryCode=string&sFrequencyCode=string&sYear=string&sGroupNumber=string&sVIN=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"?>
<ArrayOfBBAddDeduct xmlns="https://blackbookws.com/UsedCarWSX">
  <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>
</ArrayOfBBAddDeduct>

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

sCountryCode=string&sFrequencyCode=string&sYear=string&sGroupNumber=string&sVIN=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"?>
<ArrayOfBBAddDeduct xmlns="https://blackbookws.com/UsedCarWSX">
  <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>
</ArrayOfBBAddDeduct>