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.

getCatalogueGroupList

This operation allows downloading the list of catalogue groups defined in the system. The operation does not have any input parameters. The web service replies with a message containing the list of Groups in XML format.

Try it

Request

Request URL

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • (optional)
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

getCatalogueGroupList

<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body>
    <getCatalogueGroupList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://ws.catalog.dc.efsa.europa.eu/" />
  </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

getCatalogueGroupListResponse

Representations

<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body>
    <getCatalogueGroupListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://ws.catalog.dc.efsa.europa.eu/">
      <return xmlns="">return1</return>
    </getCatalogueGroupListResponse>
  </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>