download Web Service

download

Click here for a complete list of operations.

DownloadConsumerFolder

Schema Input: Click here to open the XML Schema (XSD) validation file for the Input Data.

Schema Output: Click here to open the XML Schema (XSD) validation file for the Output Data.

Test

The test form is only available for requests from the local machine.

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 /index.gaas/2024-05/download.asmx HTTP/1.1
Host: index.hcisolutions.ch
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.hcisolutions.ch/index/DownloadConsumerFolder"

<?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>
    <DownloadConsumerFolderInput xmlns="http://www.hcisolutions.ch/index">
      <INDEX>string</INDEX>
      <FROMDATE>date</FROMDATE>
      <FILTER>bytes</FILTER>
      <QS>boolean</QS>
    </DownloadConsumerFolderInput>
  </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>
    <CONSUMERFOLDER CREATION_DATETIME="dateTime" PROD_DATE="dateTime" VALID_DATE="dateTime" RELEASE="string" xmlns="http://www.hcisolutions.ch/index">
      <CFOLDER DT="dateTime">
        <FOLDERID>int</FOLDERID>
        <LANGUAGE>
          <LANG>string</LANG>
          <TITLE>string</TITLE>
          <SUMMARY>string</SUMMARY>
          <SUMMARYSRC>string</SUMMARYSRC>
          <CONTENT>xml</CONTENT>
          <CONTENTSRC>string</CONTENTSRC>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
        </LANGUAGE>
        <LANGUAGE>
          <LANG>string</LANG>
          <TITLE>string</TITLE>
          <SUMMARY>string</SUMMARY>
          <SUMMARYSRC>string</SUMMARYSRC>
          <CONTENT>xml</CONTENT>
          <CONTENTSRC>string</CONTENTSRC>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
        </LANGUAGE>
        <DEL>boolean</DEL>
      </CFOLDER>
      <CFOLDER DT="dateTime">
        <FOLDERID>int</FOLDERID>
        <LANGUAGE>
          <LANG>string</LANG>
          <TITLE>string</TITLE>
          <SUMMARY>string</SUMMARY>
          <SUMMARYSRC>string</SUMMARYSRC>
          <CONTENT>xml</CONTENT>
          <CONTENTSRC>string</CONTENTSRC>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
        </LANGUAGE>
        <LANGUAGE>
          <LANG>string</LANG>
          <TITLE>string</TITLE>
          <SUMMARY>string</SUMMARY>
          <SUMMARYSRC>string</SUMMARYSRC>
          <CONTENT>xml</CONTENT>
          <CONTENTSRC>string</CONTENTSRC>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
        </LANGUAGE>
        <DEL>boolean</DEL>
      </CFOLDER>
      <RESULT>
        <OK_ERROR>bytes</OK_ERROR>
        <NBR_RECORD>int</NBR_RECORD>
        <ERROR_CODE>string</ERROR_CODE>
        <MESSAGE>string</MESSAGE>
      </RESULT>
    </CONSUMERFOLDER>
  </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 /index.gaas/2024-05/download.asmx HTTP/1.1
Host: index.hcisolutions.ch
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>
    <DownloadConsumerFolderInput xmlns="http://www.hcisolutions.ch/index">
      <INDEX>string</INDEX>
      <FROMDATE>date</FROMDATE>
      <FILTER>bytes</FILTER>
      <QS>boolean</QS>
    </DownloadConsumerFolderInput>
  </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>
    <CONSUMERFOLDER CREATION_DATETIME="dateTime" PROD_DATE="dateTime" VALID_DATE="dateTime" RELEASE="string" xmlns="http://www.hcisolutions.ch/index">
      <CFOLDER DT="dateTime">
        <FOLDERID>int</FOLDERID>
        <LANGUAGE>
          <LANG>string</LANG>
          <TITLE>string</TITLE>
          <SUMMARY>string</SUMMARY>
          <SUMMARYSRC>string</SUMMARYSRC>
          <CONTENT>xml</CONTENT>
          <CONTENTSRC>string</CONTENTSRC>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
        </LANGUAGE>
        <LANGUAGE>
          <LANG>string</LANG>
          <TITLE>string</TITLE>
          <SUMMARY>string</SUMMARY>
          <SUMMARYSRC>string</SUMMARYSRC>
          <CONTENT>xml</CONTENT>
          <CONTENTSRC>string</CONTENTSRC>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
        </LANGUAGE>
        <DEL>boolean</DEL>
      </CFOLDER>
      <CFOLDER DT="dateTime">
        <FOLDERID>int</FOLDERID>
        <LANGUAGE>
          <LANG>string</LANG>
          <TITLE>string</TITLE>
          <SUMMARY>string</SUMMARY>
          <SUMMARYSRC>string</SUMMARYSRC>
          <CONTENT>xml</CONTENT>
          <CONTENTSRC>string</CONTENTSRC>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
        </LANGUAGE>
        <LANGUAGE>
          <LANG>string</LANG>
          <TITLE>string</TITLE>
          <SUMMARY>string</SUMMARY>
          <SUMMARYSRC>string</SUMMARYSRC>
          <CONTENT>xml</CONTENT>
          <CONTENTSRC>string</CONTENTSRC>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <LINK>
            <TITLE>string</TITLE>
            <URL>string</URL>
          </LINK>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
          <CFOLDERSRC>
            <SRC>string</SRC>
            <DSCR xsi:nil="true" />
            <CHAR xsi:nil="true" />
            <USAGE xsi:nil="true" />
            <INFO xsi:nil="true" />
            <ADDINFO xsi:nil="true" />
            <COMPDSCR xsi:nil="true" />
            <COMP xsi:nil="true" />
            <COMP xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <ALLERGEN xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
            <NUTRITION xsi:nil="true" />
          </CFOLDERSRC>
        </LANGUAGE>
        <DEL>boolean</DEL>
      </CFOLDER>
      <RESULT>
        <OK_ERROR>bytes</OK_ERROR>
        <NBR_RECORD>int</NBR_RECORD>
        <ERROR_CODE>string</ERROR_CODE>
        <MESSAGE>string</MESSAGE>
      </RESULT>
    </CONSUMERFOLDER>
  </soap12:Body>
</soap12:Envelope>