CAPUsedValues


Click here for a complete list of operations.

GetUsedValuesForIDYearLetter

Returns a list of Used Values for a given ID, Year/Letter. If JustCurrent is true, the current Used Values will be returned - otherwise they will be taken from the given date. All dates passed should be the first of the month e.g. 2004/12/1. 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:
UsedValuesDate:
JustCurrent:
Year:
Letter:

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

<?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>
    <GetUsedValuesForIDYearLetter xmlns="https://soap.cap.co.uk/usedvalues">
      <Subscriber_ID>int</Subscriber_ID>
      <Password>string</Password>
      <Database>string</Database>
      <CAPID>int</CAPID>
      <UsedValuesDate>dateTime</UsedValuesDate>
      <JustCurrent>boolean</JustCurrent>
      <Year>int</Year>
      <Letter>string</Letter>
    </GetUsedValuesForIDYearLetter>
  </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>
    <GetUsedValuesForIDYearLetterResponse xmlns="https://soap.cap.co.uk/usedvalues">
      <GetUsedValuesForIDYearLetterResult>
        <Success>boolean</Success>
        <FailMessage>string</FailMessage>
        <Returned_DataSet>
          <xsd:schema>schema</xsd:schema>xml</Returned_DataSet>
      </GetUsedValuesForIDYearLetterResult>
    </GetUsedValuesForIDYearLetterResponse>
  </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>
    <GetUsedValuesForIDYearLetter xmlns="https://soap.cap.co.uk/usedvalues">
      <Subscriber_ID>int</Subscriber_ID>
      <Password>string</Password>
      <Database>string</Database>
      <CAPID>int</CAPID>
      <UsedValuesDate>dateTime</UsedValuesDate>
      <JustCurrent>boolean</JustCurrent>
      <Year>int</Year>
      <Letter>string</Letter>
    </GetUsedValuesForIDYearLetter>
  </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>
    <GetUsedValuesForIDYearLetterResponse xmlns="https://soap.cap.co.uk/usedvalues">
      <GetUsedValuesForIDYearLetterResult>
        <Success>boolean</Success>
        <FailMessage>string</FailMessage>
        <Returned_DataSet>
          <xsd:schema>schema</xsd:schema>xml</Returned_DataSet>
      </GetUsedValuesForIDYearLetterResult>
    </GetUsedValuesForIDYearLetterResponse>
  </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/GetUsedValuesForIDYearLetter?Subscriber_ID=string&Password=string&Database=string&CAPID=string&UsedValuesDate=string&JustCurrent=string&Year=string&Letter=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/GetUsedValuesForIDYearLetter 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&UsedValuesDate=string&JustCurrent=string&Year=string&Letter=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>