Catalogues REST

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.

CatalogueFile

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

Request headers

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

Request body

{     
"ExportCatalogueFile": 
  { 			  
   "catalogueCode" : "GENDER", 			  
   "catalogueVersion" : "2.4", 			  
   "exportType" : "catalogFullDefinition", 			 
   "group" : "", 			  
   "dcCode" : "", 			  
   "fileType" : "XML" 		
  }
}

Responses

200 OK

Representations

  {
    "ExportCatalogueFileResponse": {
      "return": {
        "filename": "GENDER_FULL_2_4.xml",
        "isZipped": "false",
        "filetype": "XML"
      }
    }
  }

Code samples

@ECHO OFF

curl -v -X POST "https://openapi.efsa.europa.eu/api/catalogues/catalogue-file"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://openapi.efsa.europa.eu/api/catalogues/catalogue-file?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://openapi.efsa.europa.eu/api/catalogues/catalogue-file");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://openapi.efsa.europa.eu/api/catalogues/catalogue-file?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://openapi.efsa.europa.eu/api/catalogues/catalogue-file";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://openapi.efsa.europa.eu/api/catalogues/catalogue-file');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('openapi.efsa.europa.eu')
    conn.request("POST", "/api/catalogues/catalogue-file?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('openapi.efsa.europa.eu')
    conn.request("POST", "/api/catalogues/catalogue-file?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://openapi.efsa.europa.eu/api/catalogues/catalogue-file')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body