DataCollections

API change history

Data collection is an important task of EFSA and a fundamental component of many of its risk assessment activities. Transparency and openness regarding the way in which data are collected and analysed are underlying principles ofa EFSA Guidance on Data Exchange.

This API allows to retrieve the configurations of data collections.

GetDataCollectionList

This method is used to retrieve the list of data collections defined in the EFSA Data Collection Framework. The operation does not have any input parameters. The web service replies with a message containing a list of data collections as a string in XML format.

Try it

Request

Request URL

https://openapi.efsa.europa.eu/api/collections.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

GetDataCollectionList

text/xml

Sample
Schema

<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body>
    <GetDataCollectionList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://dcf-elect.efsa.europa.eu/" />
  </Body>
</Envelope>

<xsd:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://dcf-elect.efsa.europa.eu/" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="http://dcf-elect.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://dcf-elect.efsa.europa.eu/">
  <xsd:element name="GetDataCollectionList" type="tns:GetDataCollectionList" />
  <xsd:element name="GetDataCollectionListResponse" type="tns:GetDataCollectionListResponse" />
  <xsd:element name="GetFile" type="tns:GetFile" />
  <xsd:element name="GetFileResponse" type="tns:GetFileResponse" />
  <xsd:element name="GetResourceList" type="tns:GetResourceList" />
  <xsd:element name="GetResourceListResponse" type="tns:GetResourceListResponse" />
  <xsd:element name="datasetList" type="tns:datasetList" />
  <xsd:element name="datasetSummaryType" type="tns:datasetSummaryType" />
  <xsd:complexType name="GetResourceList">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="dataCollection" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetResourceListResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDatasetList">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="dataCollectionCode" type="xs:string" />
      <xsd:element minOccurs="0" name="status" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDatasetListResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:datasetList" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="datasetList">
    <xsd:sequence>
      <xsd:element maxOccurs="unbounded" minOccurs="0" name="dataset" nillable="true" type="tns:datasetSummaryType" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="datasetSummaryType">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="datasetId" type="xs:string" />
      <xsd:element minOccurs="0" name="senderDatasetId" type="xs:string" />
      <xsd:element minOccurs="0" name="datasetStatus" type="tns:datasetStatusType" />
      <xsd:element minOccurs="0" name="lastModifyingMessageId" type="xs:string" />
      <xsd:element minOccurs="0" name="lastValidationMessageId" type="xs:string" />
      <xsd:element minOccurs="0" name="lastMessageId" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="datasetStatusType">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="status" type="xs:string" />
      <xsd:element minOccurs="0" name="step" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="SendMessage">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="trxFileMessage" type="tns:TrxMessage" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="TrxMessage">
    <xsd:sequence>
      <xsd:element xmlns:ns1="http://www.w3.org/2005/05/xmlmime" minOccurs="0" name="fileHandler" ns1:expectedContentTypes="application/octet-stream" type="xs:base64Binary" />
      <xsd:element minOccurs="0" name="fileName" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="SendMessageResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:Receipt" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="Receipt">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="trxState" type="xs:string" />
      <xsd:element minOccurs="0" name="messageId" type="xs:string" />
      <xsd:element minOccurs="0" name="trxErr" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="Ping">
    <xsd:sequence />
  </xsd:complexType>
  <xsd:complexType name="PingResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:Receipt" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDatasetStatus">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="datasetId" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDatasetStatusResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:datasetStatusType" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetAck">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="messageId" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetAckResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:ackMessage" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="ackMessage">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="fileState" type="xs:string" />
      <xsd:element minOccurs="0" name="fileName" type="xs:string" />
      <xsd:element xmlns:ns2="http://www.w3.org/2005/05/xmlmime" minOccurs="0" name="fileHandler" ns2:expectedContentTypes="application/octet-stream" type="xs:base64Binary" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDataset">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="datasetId" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDatasetResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:datasetType" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="datasetType">
    <xsd:complexContent>
      <xsd:extension base="tns:fileData">
        <xsd:sequence />
      </xsd:extension>
    </xsd:complexContent>
  </xsd:complexType>
  <xsd:complexType name="fileData">
    <xsd:sequence>
      <xsd:element xmlns:ns3="http://www.w3.org/2005/05/xmlmime" minOccurs="0" name="rowData" ns3:expectedContentTypes="application/octet-stream" type="xs:base64Binary" />
      <xsd:element minOccurs="0" name="name" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetFile">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="trxResourceId" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetFileResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:fileResource" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="fileResource">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="fileState" type="xs:string" />
      <xsd:element minOccurs="0" name="fileName" type="xs:string" />
      <xsd:element xmlns:ns4="http://www.w3.org/2005/05/xmlmime" minOccurs="0" name="fileHandler" ns4:expectedContentTypes="application/octet-stream" type="xs:base64Binary" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetDataCollectionList">
    <xsd:sequence />
  </xsd:complexType>
  <xsd:complexType name="GetDataCollectionListResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" 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

GetDataCollectionListResponse

Representations

text/xml

Sample
Schema

<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body>
    <GetDataCollectionListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://dcf-elect.efsa.europa.eu/">
      <return xmlns="">list of data collections</return>
    </GetDataCollectionListResponse>
  </Body>
</Envelope>

<xsd:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://dcf-elect.efsa.europa.eu/" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="http://dcf-elect.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://dcf-elect.efsa.europa.eu/">
  <xsd:element name="GetDataCollectionList" type="tns:GetDataCollectionList" />
  <xsd:element name="GetDataCollectionListResponse" type="tns:GetDataCollectionListResponse" />
  <xsd:element name="GetFile" type="tns:GetFile" />
  <xsd:element name="GetFileResponse" type="tns:GetFileResponse" />
  <xsd:element name="GetResourceList" type="tns:GetResourceList" />
  <xsd:element name="GetResourceListResponse" type="tns:GetResourceListResponse" />
  <xsd:element name="datasetList" type="tns:datasetList" />
  <xsd:element name="datasetSummaryType" type="tns:datasetSummaryType" />
  <xsd:complexType name="GetResourceList">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="dataCollection" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetResourceListResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDatasetList">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="dataCollectionCode" type="xs:string" />
      <xsd:element minOccurs="0" name="status" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDatasetListResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:datasetList" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="datasetList">
    <xsd:sequence>
      <xsd:element maxOccurs="unbounded" minOccurs="0" name="dataset" nillable="true" type="tns:datasetSummaryType" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="datasetSummaryType">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="datasetId" type="xs:string" />
      <xsd:element minOccurs="0" name="senderDatasetId" type="xs:string" />
      <xsd:element minOccurs="0" name="datasetStatus" type="tns:datasetStatusType" />
      <xsd:element minOccurs="0" name="lastModifyingMessageId" type="xs:string" />
      <xsd:element minOccurs="0" name="lastValidationMessageId" type="xs:string" />
      <xsd:element minOccurs="0" name="lastMessageId" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="datasetStatusType">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="status" type="xs:string" />
      <xsd:element minOccurs="0" name="step" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="SendMessage">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="trxFileMessage" type="tns:TrxMessage" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="TrxMessage">
    <xsd:sequence>
      <xsd:element xmlns:ns1="http://www.w3.org/2005/05/xmlmime" minOccurs="0" name="fileHandler" ns1:expectedContentTypes="application/octet-stream" type="xs:base64Binary" />
      <xsd:element minOccurs="0" name="fileName" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="SendMessageResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:Receipt" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="Receipt">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="trxState" type="xs:string" />
      <xsd:element minOccurs="0" name="messageId" type="xs:string" />
      <xsd:element minOccurs="0" name="trxErr" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="Ping">
    <xsd:sequence />
  </xsd:complexType>
  <xsd:complexType name="PingResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:Receipt" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDatasetStatus">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="datasetId" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDatasetStatusResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:datasetStatusType" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetAck">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="messageId" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetAckResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:ackMessage" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="ackMessage">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="fileState" type="xs:string" />
      <xsd:element minOccurs="0" name="fileName" type="xs:string" />
      <xsd:element xmlns:ns2="http://www.w3.org/2005/05/xmlmime" minOccurs="0" name="fileHandler" ns2:expectedContentTypes="application/octet-stream" type="xs:base64Binary" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDataset">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="datasetId" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="getDatasetResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:datasetType" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="datasetType">
    <xsd:complexContent>
      <xsd:extension base="tns:fileData">
        <xsd:sequence />
      </xsd:extension>
    </xsd:complexContent>
  </xsd:complexType>
  <xsd:complexType name="fileData">
    <xsd:sequence>
      <xsd:element xmlns:ns3="http://www.w3.org/2005/05/xmlmime" minOccurs="0" name="rowData" ns3:expectedContentTypes="application/octet-stream" type="xs:base64Binary" />
      <xsd:element minOccurs="0" name="name" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetFile">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="trxResourceId" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetFileResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="tns:fileResource" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="fileResource">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="fileState" type="xs:string" />
      <xsd:element minOccurs="0" name="fileName" type="xs:string" />
      <xsd:element xmlns:ns4="http://www.w3.org/2005/05/xmlmime" minOccurs="0" name="fileHandler" ns4:expectedContentTypes="application/octet-stream" type="xs:base64Binary" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="GetDataCollectionList">
    <xsd:sequence />
  </xsd:complexType>
  <xsd:complexType name="GetDataCollectionListResponse">
    <xsd:sequence>
      <xsd:element minOccurs="0" name="return" type="xs:string" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="WsUploadException" type="tns:WsUploadException" />
  <xsd:complexType name="WsUploadException">
    <xsd:sequence />
  </xsd:complexType>
</xsd:schema>