UsedCarWSX


Click here for a complete list of operations.

ColorsByFullYear

Retrieve all vehicle colors

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sCountryCode:
sYear:
sGroupNumber:

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

<?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>
    <ColorsByFullYear xmlns="https://blackbookws.com/UsedCarWSX">
      <sCountryCode>string</sCountryCode>
      <sYear>string</sYear>
      <sGroupNumber>string</sGroupNumber>
    </ColorsByFullYear>
  </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>
    <ColorsByFullYearResponse xmlns="https://blackbookws.com/UsedCarWSX">
      <ColorsByFullYearResult>
        <colorArray>
          <BBColor>
            <vin_year>string</vin_year>
            <group_number>string</group_number>
            <category_name>string</category_name>
            <description>string</description>
            <swatch>string</swatch>
          </BBColor>
          <BBColor>
            <vin_year>string</vin_year>
            <group_number>string</group_number>
            <category_name>string</category_name>
            <description>string</description>
            <swatch>string</swatch>
          </BBColor>
        </colorArray>
        <colorCategories>
          <category>string</category>
          <category>string</category>
        </colorCategories>
      </ColorsByFullYearResult>
    </ColorsByFullYearResponse>
  </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>
    <ColorsByFullYear xmlns="https://blackbookws.com/UsedCarWSX">
      <sCountryCode>string</sCountryCode>
      <sYear>string</sYear>
      <sGroupNumber>string</sGroupNumber>
    </ColorsByFullYear>
  </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>
    <ColorsByFullYearResponse xmlns="https://blackbookws.com/UsedCarWSX">
      <ColorsByFullYearResult>
        <colorArray>
          <BBColor>
            <vin_year>string</vin_year>
            <group_number>string</group_number>
            <category_name>string</category_name>
            <description>string</description>
            <swatch>string</swatch>
          </BBColor>
          <BBColor>
            <vin_year>string</vin_year>
            <group_number>string</group_number>
            <category_name>string</category_name>
            <description>string</description>
            <swatch>string</swatch>
          </BBColor>
        </colorArray>
        <colorCategories>
          <category>string</category>
          <category>string</category>
        </colorCategories>
      </ColorsByFullYearResult>
    </ColorsByFullYearResponse>
  </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/ColorsByFullYear?sCountryCode=string&sYear=string&sGroupNumber=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"?>
<BBColors xmlns="https://blackbookws.com/UsedCarWSX">
  <colorArray>
    <BBColor>
      <vin_year>string</vin_year>
      <group_number>string</group_number>
      <category_name>string</category_name>
      <description>string</description>
      <swatch>string</swatch>
    </BBColor>
    <BBColor>
      <vin_year>string</vin_year>
      <group_number>string</group_number>
      <category_name>string</category_name>
      <description>string</description>
      <swatch>string</swatch>
    </BBColor>
  </colorArray>
  <colorCategories>
    <category>string</category>
    <category>string</category>
  </colorCategories>
</BBColors>

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

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

<?xml version="1.0" encoding="utf-8"?>
<BBColors xmlns="https://blackbookws.com/UsedCarWSX">
  <colorArray>
    <BBColor>
      <vin_year>string</vin_year>
      <group_number>string</group_number>
      <category_name>string</category_name>
      <description>string</description>
      <swatch>string</swatch>
    </BBColor>
    <BBColor>
      <vin_year>string</vin_year>
      <group_number>string</group_number>
      <category_name>string</category_name>
      <description>string</description>
      <swatch>string</swatch>
    </BBColor>
  </colorArray>
  <colorCategories>
    <category>string</category>
    <category>string</category>
  </colorCategories>
</BBColors>