CAPVRM Web Service

CAPVRM

Click here for a complete list of operations.

CAPIDValuation

Test

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

Parameter	Value
SubscriberID:
Password:
Database:
CAPID:
RegisteredDate:
Mileage:
StandardEquipmentRequired:

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 /vrm/capvrm.asmx HTTP/1.1
Host: soap.cap.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://soap.cap.co.uk/vrm/CAPIDValuation"

<?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:Body>
    <CAPIDValuation xmlns="https://soap.cap.co.uk/vrm">
      <SubscriberID>int</SubscriberID>
      <Password>string</Password>
      <Database>string</Database>
      <CAPID>int</CAPID>
      <RegisteredDate>dateTime</RegisteredDate>
      <Mileage>int</Mileage>
      <StandardEquipmentRequired>boolean</StandardEquipmentRequired>
    </CAPIDValuation>
  </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:Body>
    <CAPIDValuationResponse xmlns="https://soap.cap.co.uk/vrm">
      <CAPIDValuationResult>
        <Success>boolean</Success>
        <CAPIDLookup>
          <Success>boolean</Success>
          <IDFound>boolean</IDFound>
          <Database>string</Database>
          <CAPID>int</CAPID>
          <CAPcode>string</CAPcode>
          <CAPMan>string</CAPMan>
          <CAPRange>string</CAPRange>
          <CAPMod>string</CAPMod>
          <CAPDer>string</CAPDer>
          <ModIntroduced>int</ModIntroduced>
          <ModDiscontinued>int</ModDiscontinued>
          <DerIntroduced>dateTime</DerIntroduced>
          <DerDiscontinued>dateTime</DerDiscontinued>
          <FailReason>string</FailReason>
        </CAPIDLookup>
        <Valuation>
          <Success>boolean</Success>
          <ValuationDateMatch>boolean</ValuationDateMatch>
          <ValuationMileage>int</ValuationMileage>
          <Retail>int</Retail>
          <Clean>int</Clean>
          <Average>int</Average>
          <Below>int</Below>
          <FailReason>string</FailReason>
        </Valuation>
        <MileageOutOfBounds>boolean</MileageOutOfBounds>
        <StandardEquipment>
          <Success>boolean</Success>
          <EquipmentDateMatch>boolean</EquipmentDateMatch>
          <SEData>
            <SEDataItem xsi:nil="true" />
            <SEDataItem xsi:nil="true" />
          </SEData>
          <FailReason>string</FailReason>
        </StandardEquipment>
        <FailReason>string</FailReason>
      </CAPIDValuationResult>
    </CAPIDValuationResponse>
  </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 /vrm/capvrm.asmx HTTP/1.1
Host: soap.cap.co.uk
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:Body>
    <CAPIDValuation xmlns="https://soap.cap.co.uk/vrm">
      <SubscriberID>int</SubscriberID>
      <Password>string</Password>
      <Database>string</Database>
      <CAPID>int</CAPID>
      <RegisteredDate>dateTime</RegisteredDate>
      <Mileage>int</Mileage>
      <StandardEquipmentRequired>boolean</StandardEquipmentRequired>
    </CAPIDValuation>
  </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:Body>
    <CAPIDValuationResponse xmlns="https://soap.cap.co.uk/vrm">
      <CAPIDValuationResult>
        <Success>boolean</Success>
        <CAPIDLookup>
          <Success>boolean</Success>
          <IDFound>boolean</IDFound>
          <Database>string</Database>
          <CAPID>int</CAPID>
          <CAPcode>string</CAPcode>
          <CAPMan>string</CAPMan>
          <CAPRange>string</CAPRange>
          <CAPMod>string</CAPMod>
          <CAPDer>string</CAPDer>
          <ModIntroduced>int</ModIntroduced>
          <ModDiscontinued>int</ModDiscontinued>
          <DerIntroduced>dateTime</DerIntroduced>
          <DerDiscontinued>dateTime</DerDiscontinued>
          <FailReason>string</FailReason>
        </CAPIDLookup>
        <Valuation>
          <Success>boolean</Success>
          <ValuationDateMatch>boolean</ValuationDateMatch>
          <ValuationMileage>int</ValuationMileage>
          <Retail>int</Retail>
          <Clean>int</Clean>
          <Average>int</Average>
          <Below>int</Below>
          <FailReason>string</FailReason>
        </Valuation>
        <MileageOutOfBounds>boolean</MileageOutOfBounds>
        <StandardEquipment>
          <Success>boolean</Success>
          <EquipmentDateMatch>boolean</EquipmentDateMatch>
          <SEData>
            <SEDataItem xsi:nil="true" />
            <SEDataItem xsi:nil="true" />
          </SEData>
          <FailReason>string</FailReason>
        </StandardEquipment>
        <FailReason>string</FailReason>
      </CAPIDValuationResult>
    </CAPIDValuationResponse>
  </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 /vrm/capvrm.asmx/CAPIDValuation?SubscriberID=string&Password=string&Database=string&CAPID=string&RegisteredDate=string&Mileage=string&StandardEquipmentRequired=string HTTP/1.1
Host: soap.cap.co.uk

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CAPIDValuationResult xmlns="https://soap.cap.co.uk/vrm">
  <Success>boolean</Success>
  <CAPIDLookup>
    <Success>boolean</Success>
    <IDFound>boolean</IDFound>
    <Database>string</Database>
    <CAPID>int</CAPID>
    <CAPcode>string</CAPcode>
    <CAPMan>string</CAPMan>
    <CAPRange>string</CAPRange>
    <CAPMod>string</CAPMod>
    <CAPDer>string</CAPDer>
    <ModIntroduced>int</ModIntroduced>
    <ModDiscontinued>int</ModDiscontinued>
    <DerIntroduced>dateTime</DerIntroduced>
    <DerDiscontinued>dateTime</DerDiscontinued>
    <FailReason>string</FailReason>
  </CAPIDLookup>
  <Valuation>
    <Success>boolean</Success>
    <ValuationDateMatch>boolean</ValuationDateMatch>
    <ValuationMileage>int</ValuationMileage>
    <Retail>int</Retail>
    <Clean>int</Clean>
    <Average>int</Average>
    <Below>int</Below>
    <FailReason>string</FailReason>
  </Valuation>
  <MileageOutOfBounds>boolean</MileageOutOfBounds>
  <StandardEquipment>
    <Success>boolean</Success>
    <EquipmentDateMatch>boolean</EquipmentDateMatch>
    <SEData>
      <SEDataItem>
        <SECode>int</SECode>
        <SEDescription>string</SEDescription>
        <SECategory>string</SECategory>
      </SEDataItem>
      <SEDataItem>
        <SECode>int</SECode>
        <SEDescription>string</SEDescription>
        <SECategory>string</SECategory>
      </SEDataItem>
    </SEData>
    <FailReason>string</FailReason>
  </StandardEquipment>
  <FailReason>string</FailReason>
</CAPIDValuationResult>

HTTP POST

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

POST /vrm/capvrm.asmx/CAPIDValuation HTTP/1.1
Host: soap.cap.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SubscriberID=string&Password=string&Database=string&CAPID=string&RegisteredDate=string&Mileage=string&StandardEquipmentRequired=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CAPIDValuationResult xmlns="https://soap.cap.co.uk/vrm">
  <Success>boolean</Success>
  <CAPIDLookup>
    <Success>boolean</Success>
    <IDFound>boolean</IDFound>
    <Database>string</Database>
    <CAPID>int</CAPID>
    <CAPcode>string</CAPcode>
    <CAPMan>string</CAPMan>
    <CAPRange>string</CAPRange>
    <CAPMod>string</CAPMod>
    <CAPDer>string</CAPDer>
    <ModIntroduced>int</ModIntroduced>
    <ModDiscontinued>int</ModDiscontinued>
    <DerIntroduced>dateTime</DerIntroduced>
    <DerDiscontinued>dateTime</DerDiscontinued>
    <FailReason>string</FailReason>
  </CAPIDLookup>
  <Valuation>
    <Success>boolean</Success>
    <ValuationDateMatch>boolean</ValuationDateMatch>
    <ValuationMileage>int</ValuationMileage>
    <Retail>int</Retail>
    <Clean>int</Clean>
    <Average>int</Average>
    <Below>int</Below>
    <FailReason>string</FailReason>
  </Valuation>
  <MileageOutOfBounds>boolean</MileageOutOfBounds>
  <StandardEquipment>
    <Success>boolean</Success>
    <EquipmentDateMatch>boolean</EquipmentDateMatch>
    <SEData>
      <SEDataItem>
        <SECode>int</SECode>
        <SEDescription>string</SEDescription>
        <SECategory>string</SECategory>
      </SEDataItem>
      <SEDataItem>
        <SECode>int</SECode>
        <SEDescription>string</SEDescription>
        <SECategory>string</SECategory>
      </SEDataItem>
    </SEData>
    <FailReason>string</FailReason>
  </StandardEquipment>
  <FailReason>string</FailReason>
</CAPIDValuationResult>