CapFutureValues


Click here for a complete list of operations.

GetPpmValuation

Returns a PPM Valuation for a given CAPID or CAPCode.
Only current vehicles for the dataset will return a PPM valuation.
If using the CAPCode then CAPId should be set to 0.
Date Format: yyyy/mm/dd.
If JustCurrent is true, the current Future Values PPM will be returned - otherwise they will be taken from the given dataset date.
Dataset Date: relates to the monthly edition, e.g. 2008/10/01 will use October 2008's data. This parameter needs to be populated even if JustCurrent is true.
All dates passed should be the first of the month e.g. 2004/12/01.
MonthsToValuation denotes how many months in the future from the PPMDate the valuation is for. This can be between 12 and 60.
Mleages are entered in full, e.g. 40850.
The results are cached for 30 minutes.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
subscriberId:
password:
database:
capid:
capCode:
datasetDate:
justCurrent:
monthsToValuation:
mileage:

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 /futurevalues/capfuturevalues.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/futurevalues/GetPpmValuation"

<?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>
    <GetPpmValuation xmlns="https://soap.cap.co.uk/futurevalues">
      <subscriberId>int</subscriberId>
      <password>string</password>
      <database>string</database>
      <capid>int</capid>
      <capCode>string</capCode>
      <datasetDate>dateTime</datasetDate>
      <justCurrent>boolean</justCurrent>
      <monthsToValuation>int</monthsToValuation>
      <mileage>int</mileage>
    </GetPpmValuation>
  </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>
    <GetPpmValuationResponse xmlns="https://soap.cap.co.uk/futurevalues">
      <GetPpmValuationResult>
        <Success>boolean</Success>
        <FailMessage>string</FailMessage>
        <Returned_DataSet>
          <xsd:schema>schema</xsd:schema>xml</Returned_DataSet>
      </GetPpmValuationResult>
    </GetPpmValuationResponse>
  </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 /futurevalues/capfuturevalues.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>
    <GetPpmValuation xmlns="https://soap.cap.co.uk/futurevalues">
      <subscriberId>int</subscriberId>
      <password>string</password>
      <database>string</database>
      <capid>int</capid>
      <capCode>string</capCode>
      <datasetDate>dateTime</datasetDate>
      <justCurrent>boolean</justCurrent>
      <monthsToValuation>int</monthsToValuation>
      <mileage>int</mileage>
    </GetPpmValuation>
  </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>
    <GetPpmValuationResponse xmlns="https://soap.cap.co.uk/futurevalues">
      <GetPpmValuationResult>
        <Success>boolean</Success>
        <FailMessage>string</FailMessage>
        <Returned_DataSet>
          <xsd:schema>schema</xsd:schema>xml</Returned_DataSet>
      </GetPpmValuationResult>
    </GetPpmValuationResponse>
  </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 /futurevalues/capfuturevalues.asmx/GetPpmValuation?subscriberId=string&password=string&database=string&capid=string&capCode=string&datasetDate=string&justCurrent=string&monthsToValuation=string&mileage=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"?>
<CAPDataSetResult xmlns="https://soap.cap.co.uk/futurevalues">
  <Success>boolean</Success>
  <FailMessage>string</FailMessage>
  <Returned_DataSet>
    <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</Returned_DataSet>
</CAPDataSetResult>

HTTP POST

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

POST /futurevalues/capfuturevalues.asmx/GetPpmValuation 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&capCode=string&datasetDate=string&justCurrent=string&monthsToValuation=string&mileage=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CAPDataSetResult xmlns="https://soap.cap.co.uk/futurevalues">
  <Success>boolean</Success>
  <FailMessage>string</FailMessage>
  <Returned_DataSet>
    <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</Returned_DataSet>
</CAPDataSetResult>