UsedCarWSX


Click here for a complete list of operations.

CurrentCanadianMileageByFullYear

Retrieve current Canadian mileage adjustments

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sFrequencyCode:
sYear:
sMileageCategory:
iMileage:

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

<?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>
    <CurrentCanadianMileageByFullYear xmlns="https://blackbookws.com/UsedCarWSX">
      <sFrequencyCode>string</sFrequencyCode>
      <sYear>string</sYear>
      <sMileageCategory>string</sMileageCategory>
      <iMileage>int</iMileage>
    </CurrentCanadianMileageByFullYear>
  </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>
    <CurrentCanadianMileageByFullYearResponse xmlns="https://blackbookws.com/UsedCarWSX">
      <CurrentCanadianMileageByFullYearResult>
        <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>
      </CurrentCanadianMileageByFullYearResult>
    </CurrentCanadianMileageByFullYearResponse>
  </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>
    <CurrentCanadianMileageByFullYear xmlns="https://blackbookws.com/UsedCarWSX">
      <sFrequencyCode>string</sFrequencyCode>
      <sYear>string</sYear>
      <sMileageCategory>string</sMileageCategory>
      <iMileage>int</iMileage>
    </CurrentCanadianMileageByFullYear>
  </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>
    <CurrentCanadianMileageByFullYearResponse xmlns="https://blackbookws.com/UsedCarWSX">
      <CurrentCanadianMileageByFullYearResult>
        <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>
      </CurrentCanadianMileageByFullYearResult>
    </CurrentCanadianMileageByFullYearResponse>
  </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/CurrentCanadianMileageByFullYear?sFrequencyCode=string&sYear=string&sMileageCategory=string&iMileage=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"?>
<ArrayOfBBMileage xmlns="https://blackbookws.com/UsedCarWSX">
  <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>
</ArrayOfBBMileage>

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

sFrequencyCode=string&sYear=string&sMileageCategory=string&iMileage=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfBBMileage xmlns="https://blackbookws.com/UsedCarWSX">
  <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>
</ArrayOfBBMileage>