Webservices API

This is the alfa version of TED Web API catalogue.

The TED Web API Catalogue provides the list of web service interfaces offered by the Publications Office related to the management and publication of public procurement data (eNotification and eAccess).

The purpose of the TED Web API Catalogue is to facilitate discovery, understanding and access to APIs. For each API its short description as an endpoint and a set of service methods, enabling machine to machine integration in eNotification and eAccess domain, exposed via that endpoint is provided below.

In order to allow us to improve the service, we invite the consumers to discover the catalogue and suggest improvements of the documentation (e.g. further information to show, whether an increase of detail would be helpful and which information may be obsolete).

For any request for improvement or for any new service request, please contact the TED helpdesk.

Webservices Endpoints

List of Webservices endpoints

This is a list of all the endpoints that make the services available via web. The list provides endpoint ID, endpoint name, endpoint description with some additional explanatory notes (if applicable), messaging communication protocol used with the endpoint and a list of methods with links to the description of the respective method.

Documentation is made available for each endpoint in the form of PDF documents - Technical Specification Document. The documents can be downloaded to discover more technical details of an endpoint and its methods.



ID Name Description Protocol Methods
TEDAPI_002 eSentool Production
Documentation
This set of notice submission and service follow_up methods is used in full operations. REST Submit Notice
Get Notice Information
Render Notice
Search Notice
TEDAPI_003 eSentool Qualification
Documentation
This set of notice submission and service follow-up methods is used for qualification purpose only. REST Submit Notice
Search Notice
Get Notice Information
Render Notice
TEDAPI_004 eNoticeService
Documentation
Set of notice submission, service follow-up methods and methods to get notices created with eNotices application - provided in SOAP messaging protocol. SOAP Submit Notice
Get Notice Status
Parse Notice
Get Notice Report
Get Notices Report
Generate PDF Regulation
Generate PDF TED
Generate HTML TED
Get Notice Before Publication
Get Notices Before Publication
TEDAPI_005 TED NoticeViewer
Documentation
To visualize a notice in PDF or HTML. Applicable to all data standards operated on TED and to all statuses of a notice, i.e. as long as the structure and value data type is correct, incomplete notice will be visualized too. SOAP Notice Viewer
TEDAPI_001 TEDAPI
Documentation
Services exposed via common endpoint, not necessarily related in terms of business capabilities. REST Get Notice Information
Post Import Notice
TEDAPI_010 eTendering CfT List Service
Documentation
Simple service in the eTendering website that provides basic information about published calls for tenders. This service is intended to allow Contracting Authorities to display information about their calls for tenders on their own websites. HTTP/GET Get CfT List

Web Services Methods

List of methods

This is a list of methods which are currently made available via web and operated on the TED endpoints. The list provides method ID, method name, method description with some notes (if applicable), input and output overview, data standard applicable (if any) and a link to the respective service endpoint.

Documentation that describes technical details of each method is available with the respective API endpoint description.



ID Method Description Requested input parameter Result responses Data standard Endpoint
TEDWS_001 Get Notice Information To retrieve an extract of notice content of an unpublished or published F02 (contract notice) sent in the format 2.0.9, using the temporary reference number (reception ID) of the contract notice
NOTE: The name shall not be confused with Get Notice Information service of eSentool. While this service provide content of a notice (its extract), the one in eSentool provides metadata.
reception_id notice_information R2.0.9 TEDAPI
TEDWS_002 Post Import Notice To create a new notice with provisional data in eNotices by and upload of a draft content of a notice in format 2.0.9
NOTE: notice_information has significantly different structure from the notice_infortion object used with eSentool services.
importNotice notice_information R2.0.9 TEDAPI
TEDWS_003 Submit Notice To request a publication of a procurement notice in OJ S (formatted as a document in 2.0.8 or 2.0.9 standard). The notice gets validated (structure, individual values, value consistency, business rules) and if it passes the validation it is accepted to start the publication process. notice notice_information R2.0.9
R2.0.8
eSentool Production
TEDWS_004 Get Notice Information To retrieve the most recent information about a notice and about its publication process. submission_id notice_information eSentool Production
TEDWS_005 Render Notice To convert a file/notice structured with 2.0.8 or 2.0.9 format (eSender variant only) into a requested format (PDF / HTML) and layout (TED, Regulation - PDF only) notice or submission_id, format, language simple_result with B64 encoded conversion result R2.0.9
R2.0.8
eSentool Production
TEDWS_006 Search Notice To provide the file(s)/notice(s) status and its (their) publication data, if any. status, receivedFrom, receivedTo, pageSize, page, sort page_result R2.0.9
R2.0.8
eSentool Production
TEDWS_007 Submit Notice To validate a notice (structure, individual values, value consistency, business rules) and to get qualified for submission of OJS publication request with valid notices under 2.0.9 standard. notice notice_information R2.0.9
R2.0.8
eSentool Qualification
TEDWS_026 Get CfT List To provide a list of published CfT (Calls for Tenders). The list can be filtered by name of CA, status of CfT and by language.
NOTE: Max result is limited to a 1000. There is a representative case of successful implementation of use of this service - by EDA agency.
status, caName, lang title, reference, status, startDate, closingDate, url, caName eTendering CfT List Service
TEDWS_008 Get Notice Information To test the service to retrieve the most recent information about a notice and about its publication process. submission_id notice_information eSentool Qualification
TEDWS_009 Render Notice To test the service to convert a file/notice into a requested format (PDF / HTML) and layout (TED, Regulation - PDF only). notice or submission_id, format, language simple_result with B64 encoded conversion result R2.0.9
R2.0.8
eSentool Qualification
TEDWS_010 Search Notice To test the service to provide the file(s)/notice(s) status and its (their) publication data, if any. status, receivedFrom, receivedTo, pageSize, page, sort page_result eSentool Qualification
TEDWS_011 Submit Notice To request a publication of a procurement notice in OJ S (formatted as a document in 2.0.8 standard or 2.0.7 standard, eSender variant). notice : an XML file encoded in base64 submission id, notice status eNoticeService
TEDWS_012 Get Notice Status To retrieve the status of a notice, which is identified via submission id. submission id notice status eNoticeService
TEDWS_013 Parse Notice To parse and validate an XML notice and generate a report that represents the parsing’s result. notice : an XML file, encoded in base64 parsing result : Parsing successful message eNoticeService
TEDWS_014 Get Notice Report To retrieve a notice report by providing the submission id of the notice and getting the result in form of a generated report contains the form type, the language, the no_doc_ext, the status, the official title; the no_doc_ojs, the OJS number, the submission date, the TED link, the publication date, and the report date of the notice. submission id notice report, publication info eNoticeService
TEDWS_015 Get Notices Report To retrieve a report for a set of notices which meet input search criteria. submission date interval, publication date interval, status code notices report [notice report, publication info, ted links] eNoticeService
TEDWS_016 Generate PDF Regulation To retrieve a PDF version of a notice as encoded in the forms of the eNotices application. The PDF is generated by the PDF Generator of the eNotices application. The user could provide the submission id of a notice already submit in the TED-WS application or an XML file of a notice. notice OR submission id pdf - B64 encoded eNoticeService
TEDWS_017 Generate PDF TED To retrieve a PDF version of a notice as displayed in the TED website. The PDF is generated by the TED-Services Viewer. The user could provide the submission id of a notice already submit in the TED-WS application or an XML file of a notice. notice OR submission id, language, cover page pdf - B64 encoded eNoticeService
TEDWS_018 Generate HTML TED To retrieve a HTML version of a notice as displayed in the TED website. The HTML is generated by the TED-Services Viewer. The user could provide the submission id of a notice already submit in the TED-WS application or an XML file of a notice. notice OR submission id, language, cover page html - B64 encoded eNoticeService
TEDWS_019 Get Notice Before Publication To retrieve a notice created with eNotices application. The user enters its eNotices login credentials, and the notice id of the notice in eNotices. The 'notice id' argument represents an internal identifier of a notice assigned by eNotices application and it is retrieved via "Get Notices Before Publication" method.
NOTE: The notice ID value is not available with XML of a notice exported from eNotices (neither with iXML nor with oXML), but it can be read out of a URL while user works with a notice within eNotices application (ex. https://simap.europa.eu/enotices/noticeInformation.do?id=4172231#
login name, password, notice id notice - b64 encoded XML eNoticeService
TEDWS_020 Get Notices Before Publication To retrieve a list of notices, created with eNotices, which match the input search criteria. The user provides its eNotices login credentials, Date from and Date to (date of notice creation within eNotices). The response is the list of notices created within the time frame defined by the aforementioned dates. login name, password, date from, date to notices before publication : a list of notices. Each entry contains the notice id, the official title, the notice status; the notice title and the form type of the notice eNoticeService
TEDWS_021 Notice Viewer To convert 2.0.9 notices (all variants - eSender, internal, exported) into PDF or HTML format with a TED form layout. There is no business validation, i.e. incomplete notices, however with a valid structure according to applicable data standards, are rendered into above mentioned formats. NoticeViewerRequest NoticeViewerResponse R2.0.9
R2.0.8
TED NoticeViewer