Catalogues

API change history

Catalogues (Harmonized controlled terminology) are a key element in the process of data validation and reporting. A harmonized terminology is used to collect and analyse data in a coherent way with the aim to support scientific research.

This API allows to retrieve the catalogues published on Data Collection Framework.

ExportCatalogueFile

Export functionalities are supported by the method ExportCatalogueFile which differentiates the operation through the exportType parameter. In case that parameter is not provided or mistyped then the web service replies with the fault message: Operation not supported

Export catalogue

In order to export a catalogue the ExportCatalogueFile method must be invoked passing as parameters the catalogueCode and specifying “catalogFullDefinition” in the exportType parameter. The catalogueVersion is optional and can only contain a published version (even if deprecated). The default - if not provided – is the last published version. Please note that in this case the fileType “XML” must be passed. The web service replies with a message containing in attachment the xml export file. In case the catalogue is not published the web service replies with the following fault: Fault occurred while processing. In case a non-existing version is passed, the web service replies with the following fault: Catalogue version does not exist. In case the passed version does not have the proper format (e.g. 1.0 major or 1.1 minor), the web service replies with the following fault: Version format not correct.

Export the release note for a catalogue

In order to export the release note of a catalogue version, the ExportCatalogueFile method must be invoked passing as parameters the catalogueCode and specifying “releaseNote” in the exportType parameter. The catalogueVersion is optional and if it is not provided the last published version is considered. Please note that in this case the fileType “XML” must be passed. The web service replies with a message containing in attachment the zipped export file. If the catalogue has never been published and the catalogueVersion is not provided then the web service replies with the following fault: Fault occurred while processing. If the catalogue has been published and the catalogueVersion is provided in the right format (X.Y) then the web service checks whether the version exists. If not, it replies with the following fault: Catalogue version does not exist. If the catalogue has been published and the catalogueVersion is provided in the wrong format (X.Y.Z) then the web service replies with the following fault: Version format not correct.

Export a hierarchy

In order to export a hierarchy, even if deprecated, the ExportCatalogueFile method must be invoked passing as parameters the catalogueCode and specifying “hierarchyDefinition” in the exportType parameter. The catalogue must be published and the catalogueCode parameter must be passed in the format catalogCode.hierarchyCode. If the hierarchyCode is missing the master hierarchy is considered. The catalogueVersion is optional and if it is not provided the last published catalogue version is considered. Please note that the fileType “XML” must be passed. The web service replies with a message containing in attachment the xml export file. If the catalogue is not published the web service replies with the following fault: Fault occurred while processing. If the catalogue has been published but the hierarchy has been added after the publication, then the web service replies with the a fault similar to the following one: CM_CATc_T02C194_CATHIERCODE_T02C194e_1_0.xml does not exist. If the catalogue has been published and the catalogueVersion is provided in the right format (X.Y) then the web service checks whether the version exists. If not it replies with the following fault: Catalogue version does not exist. If the catalogue has been published and the catalogueVersion is provided in the wrong format (X.Y.Z) then the web service replies with the following fault: version format not correct.

Export a group

In order to export a group of hierarchies the ExportCatalogueFile method must be invoked passing as parameters the group code and specifying “group” in the exportType parameter. Please note that the fileType “XML” must be passed. The other parameters are ignored. The web service replies with a message containing in attachment the zip file of the exported hierarchies. Please remember that a hierarchy, even if deprecated, is exported only if it is included in a published or deprecated catalogue. If the master hierarchy is included, then any other hierarchies assigned to the group are omitted. If the provided group does not exist, the web service replies with the following fault: group does not exist.

Try it

Request

Request URL

https://openscaie-dev.azure-api.net/api/catalogues.soap

Request headers

Content-Type (optional)

string

Media type of the body sent to the API.
SOAPAction (optional)
Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.

Request body

ExportCatalogueFile

text/xml

Sample
Schema

<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body>
    <ExportCatalogueFile xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://ws.catalog.dc.efsa.europa.eu/">
      <catalogueCode xmlns="">GENDER</catalogueCode>
      <catalogueVersion xmlns="">2.4</catalogueVersion>
      <exportType xmlns="">catalogFullDefinition</exportType>
      <group xmlns="">?</group>
      <dcCode xmlns="">?</dcCode>
      <fileType xmlns="">XML</fileType>
    </ExportCatalogueFile>
  </Body>
</Envelope>

<xsd:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://ws.catalog.dc.efsa.europa.eu/" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="http://ws.catalog.dc.efsa.europa.eu/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:ns1="http://schemas.xmlsoap.org/soap/http" xmlns:apim-wsdltns="http://ws.catalog.dc.efsa.europa.eu/">
  <xsd:element name="ExportCatalogueFile" type="tns:ExportCatalogueFile" />
  <xsd:element name="ExportCatalogueFileResponse" type="tns:ExportCatalogueFileResponse" />
  <xsd:element name="getCatalogueGroupList" type="tns:getCatalogueGroupList" />
  <xsd:element name="getCatalogueGroupListResponse" type="tns:getCatalogueGroupListResponse" />
  <xsd:element name="getCatalogueList" type="tns:getCatalogueList" />
  <xsd:element name="getCatalogueListResponse" type="tns:getCatalogueListResponse" />
  <xsd:complexType name="getCatalogueList">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="arg0" type="xs:string" />
      <xsd:element minOccurs="0" name="arg1" type="xs:string" />
      <xsd:element minOccurs="0" name="arg2" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getCatalogueListResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getCatalogueGroupList">
    <xsd:sequence />
  </xsd:complexType>
  <xsd:complexType name="getCatalogueGroupListResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="ExportCatalogueFile">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="catalogueCode" type="xs:string" />
      <xsd:element minOccurs="0" name="catalogueVersion" type="xs:string" />
      <xsd:element minOccurs="0" name="exportType" type="xs:string" />
      <xsd:element minOccurs="0" name="group" type="xs:string" />
      <xsd:element minOccurs="0" name="dcCode" type="xs:string" />
      <xsd:element minOccurs="0" name="fileType" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="ExportCatalogueFileResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:catalogueFile" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="catalogueFile">
    <xsd:sequence>
      <xsd:element xmlns:ns2="http://www.w3.org/2005/05/xmlmime" minOccurs="0" name="fileHandler" ns2:expectedContentTypes="application/octet-stream" type="xs:base64Binary" />
      <xsd:element minOccurs="0" name="filename" type="xs:string" />
      <xsd:element name="isZipped" type="xs:boolean" />
      <xsd:element minOccurs="0" name="filetype" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="WsUploadException" type="tns:WsUploadException" />
  <xsd:complexType name="WsUploadException">
    <xsd:sequence />
  </xsd:complexType>
</xsd:schema>

Responses

200 OK

ExportCatalogueFileResponse

Representations

text/xml

Sample
Schema

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:ExportCatalogueFileResponse xmlns:ns2="http://ws.catalog.dc.efsa.europa.eu/">
            <return>
                <fileHandler>
                    <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:448809ed-ac88-42ca-a7d6-c88c92716074-1452@cxf.apache.org" />
                </fileHandler>
                <filename>GENDER_FULL_2_4.xml</filename>
                <isZipped>false</isZipped>
                <filetype>XML</filetype>
            </return>
        </ns2:ExportCatalogueFileResponse>
    </soap:Body>
</soap:Envelope>

<xsd:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://ws.catalog.dc.efsa.europa.eu/" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="http://ws.catalog.dc.efsa.europa.eu/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:ns1="http://schemas.xmlsoap.org/soap/http" xmlns:apim-wsdltns="http://ws.catalog.dc.efsa.europa.eu/">
  <xsd:element name="ExportCatalogueFile" type="tns:ExportCatalogueFile" />
  <xsd:element name="ExportCatalogueFileResponse" type="tns:ExportCatalogueFileResponse" />
  <xsd:element name="getCatalogueGroupList" type="tns:getCatalogueGroupList" />
  <xsd:element name="getCatalogueGroupListResponse" type="tns:getCatalogueGroupListResponse" />
  <xsd:element name="getCatalogueList" type="tns:getCatalogueList" />
  <xsd:element name="getCatalogueListResponse" type="tns:getCatalogueListResponse" />
  <xsd:complexType name="getCatalogueList">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="arg0" type="xs:string" />
      <xsd:element minOccurs="0" name="arg1" type="xs:string" />
      <xsd:element minOccurs="0" name="arg2" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getCatalogueListResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getCatalogueGroupList">
    <xsd:sequence />
  </xsd:complexType>
  <xsd:complexType name="getCatalogueGroupListResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="ExportCatalogueFile">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="catalogueCode" type="xs:string" />
      <xsd:element minOccurs="0" name="catalogueVersion" type="xs:string" />
      <xsd:element minOccurs="0" name="exportType" type="xs:string" />
      <xsd:element minOccurs="0" name="group" type="xs:string" />
      <xsd:element minOccurs="0" name="dcCode" type="xs:string" />
      <xsd:element minOccurs="0" name="fileType" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="ExportCatalogueFileResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:catalogueFile" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="catalogueFile">
    <xsd:sequence>
      <xsd:element xmlns:ns2="http://www.w3.org/2005/05/xmlmime" minOccurs="0" name="fileHandler" ns2:expectedContentTypes="application/octet-stream" type="xs:base64Binary" />
      <xsd:element minOccurs="0" name="filename" type="xs:string" />
      <xsd:element name="isZipped" type="xs:boolean" />
      <xsd:element minOccurs="0" name="filetype" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="WsUploadException" type="tns:WsUploadException" />
  <xsd:complexType name="WsUploadException">
    <xsd:sequence />
  </xsd:complexType>
</xsd:schema>