CAPUsedValues


Click here for a complete list of operations.

GetUsedValuesHistoryForIDYearLetter

Returns a list of Used Values for a given ID, Year/Letter between the dates set in MinDate and MaxDate. Results cached for 30 minutes.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
Subscriber_ID:
Password:
Database:
CAPID:
Year:
Letter:
MinDate:
MaxDate:

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 /usedvalues/capusedvalues.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/usedvalues/GetUsedValuesHistoryForIDYearLetter"

<?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>
    <GetUsedValuesHistoryForIDYearLetter xmlns="https://soap.cap.co.uk/usedvalues">
      <Subscriber_ID>int</Subscriber_ID>
      <Password>string</Password>
      <Database>string</Database>
      <CAPID>int</CAPID>
      <Year>int</Year>
      <Letter>string</Letter>
      <MinDate>dateTime</MinDate>
      <MaxDate>dateTime</MaxDate>
    </GetUsedValuesHistoryForIDYearLetter>
  </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>
    <GetUsedValuesHistoryForIDYearLetterResponse xmlns="https://soap.cap.co.uk/usedvalues">
      <GetUsedValuesHistoryForIDYearLetterResult>
        <Success>boolean</Success>
        <FailMessage>string</FailMessage>
        <Returned_DataSet>
          <xsd:schema>schema</xsd:schema>xml</Returned_DataSet>
      </GetUsedValuesHistoryForIDYearLetterResult>
    </GetUsedValuesHistoryForIDYearLetterResponse>
  </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 /usedvalues/capusedvalues.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>
    <GetUsedValuesHistoryForIDYearLetter xmlns="https://soap.cap.co.uk/usedvalues">
      <Subscriber_ID>int</Subscriber_ID>
      <Password>string</Password>
      <Database>string</Database>
      <CAPID>int</CAPID>
      <Year>int</Year>
      <Letter>string</Letter>
      <MinDate>dateTime</MinDate>
      <MaxDate>dateTime</MaxDate>
    </GetUsedValuesHistoryForIDYearLetter>
  </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>
    <GetUsedValuesHistoryForIDYearLetterResponse xmlns="https://soap.cap.co.uk/usedvalues">
      <GetUsedValuesHistoryForIDYearLetterResult>
        <Success>boolean</Success>
        <FailMessage>string</FailMessage>
        <Returned_DataSet>
          <xsd:schema>schema</xsd:schema>xml</Returned_DataSet>
      </GetUsedValuesHistoryForIDYearLetterResult>
    </GetUsedValuesHistoryForIDYearLetterResponse>
  </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 /usedvalues/capusedvalues.asmx/GetUsedValuesHistoryForIDYearLetter?Subscriber_ID=string&Password=string&Database=string&CAPID=string&Year=string&Letter=string&MinDate=string&MaxDate=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/usedvalues">
  <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 /usedvalues/capusedvalues.asmx/GetUsedValuesHistoryForIDYearLetter HTTP/1.1
Host: soap.cap.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Subscriber_ID=string&Password=string&Database=string&CAPID=string&Year=string&Letter=string&MinDate=string&MaxDate=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/usedvalues">
  <Success>boolean</Success>
  <FailMessage>string</FailMessage>
  <Returned_DataSet>
    <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</Returned_DataSet>
</CAPDataSetResult>