CAP Data Download Webservice


Click here for a complete list of operations.

List_ProductPackages

Returns a list of files which can be downloaded for a given Product ID. Product packages created after the date set in ReturnPackagesNewerThanDate will be returned.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SubscriberID:
Password:
ProductID:
ReturnPackagesNewerThanDate:

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 /datadownload/datadownload_webservice.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/datadownload/List_ProductPackages"

<?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>
    <List_ProductPackages xmlns="https://soap.cap.co.uk/datadownload">
      <SubscriberID>int</SubscriberID>
      <Password>string</Password>
      <ProductID>int</ProductID>
      <ReturnPackagesNewerThanDate>dateTime</ReturnPackagesNewerThanDate>
    </List_ProductPackages>
  </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>
    <List_ProductPackagesResponse xmlns="https://soap.cap.co.uk/datadownload">
      <List_ProductPackagesResult>
        <Success>boolean</Success>
        <Packages>
          <Package>
            <Package_Date>dateTime</Package_Date>
            <Package_Filename>string</Package_Filename>
            <Package_Size>long</Package_Size>
          </Package>
          <Package>
            <Package_Date>dateTime</Package_Date>
            <Package_Filename>string</Package_Filename>
            <Package_Size>long</Package_Size>
          </Package>
        </Packages>
        <FailMessage>string</FailMessage>
      </List_ProductPackagesResult>
    </List_ProductPackagesResponse>
  </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 /datadownload/datadownload_webservice.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>
    <List_ProductPackages xmlns="https://soap.cap.co.uk/datadownload">
      <SubscriberID>int</SubscriberID>
      <Password>string</Password>
      <ProductID>int</ProductID>
      <ReturnPackagesNewerThanDate>dateTime</ReturnPackagesNewerThanDate>
    </List_ProductPackages>
  </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>
    <List_ProductPackagesResponse xmlns="https://soap.cap.co.uk/datadownload">
      <List_ProductPackagesResult>
        <Success>boolean</Success>
        <Packages>
          <Package>
            <Package_Date>dateTime</Package_Date>
            <Package_Filename>string</Package_Filename>
            <Package_Size>long</Package_Size>
          </Package>
          <Package>
            <Package_Date>dateTime</Package_Date>
            <Package_Filename>string</Package_Filename>
            <Package_Size>long</Package_Size>
          </Package>
        </Packages>
        <FailMessage>string</FailMessage>
      </List_ProductPackagesResult>
    </List_ProductPackagesResponse>
  </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 /datadownload/datadownload_webservice.asmx/List_ProductPackages?SubscriberID=string&Password=string&ProductID=string&ReturnPackagesNewerThanDate=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"?>
<List_ProductPackages_Result xmlns="https://soap.cap.co.uk/datadownload">
  <Success>boolean</Success>
  <Packages>
    <Package>
      <Package_Date>dateTime</Package_Date>
      <Package_Filename>string</Package_Filename>
      <Package_Size>long</Package_Size>
    </Package>
    <Package>
      <Package_Date>dateTime</Package_Date>
      <Package_Filename>string</Package_Filename>
      <Package_Size>long</Package_Size>
    </Package>
  </Packages>
  <FailMessage>string</FailMessage>
</List_ProductPackages_Result>

HTTP POST

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

POST /datadownload/datadownload_webservice.asmx/List_ProductPackages HTTP/1.1
Host: soap.cap.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SubscriberID=string&Password=string&ProductID=string&ReturnPackagesNewerThanDate=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<List_ProductPackages_Result xmlns="https://soap.cap.co.uk/datadownload">
  <Success>boolean</Success>
  <Packages>
    <Package>
      <Package_Date>dateTime</Package_Date>
      <Package_Filename>string</Package_Filename>
      <Package_Size>long</Package_Size>
    </Package>
    <Package>
      <Package_Date>dateTime</Package_Date>
      <Package_Filename>string</Package_Filename>
      <Package_Size>long</Package_Size>
    </Package>
  </Packages>
  <FailMessage>string</FailMessage>
</List_ProductPackages_Result>