Publication API

Abstract
This API provides operations for submission of notices for publication and their follow-up

Access

  • Bearer Authentication

Endpoints

Notice

convert

POST /api/v2/notice/notices/convert

Convert an XML notice in the old TED XML format to an eForms notice.

Description
Parameters
Body Parameter
Name Description Required Default Pattern

ByteArray

[ByteArray]

X

Return Type
Content Type
  • application/xml

Responses
Table 1. http response codes
Code Message Datatype

200

The notice was successfully converted.

List[[ByteArray]]

400

Possible issues: - Missing Authorization header in request - The request body is incomplete or invalid.

<<>>

401

The provided TED API key doesn't exist or it is invalid.

<<>>

500

Possible issues: - The provided TED API key cannot be currently validated.

<<>>

Samples

getValidationReport

GET /api/v2/notice/notices/{businessId}/validation-report

Retrieve the notice validation report.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

businessId

The notice business identifier (notice identifier - version)

X

null

Return Type
Content Type
  • /

  • application/json

Responses
Table 2. http response codes
Code Message Datatype

200

Provides the notice validation report in SVRL (Schematron Validation Report Language) format.

[File]

400

Possible issues: - Missing Authorization header in request - Invalid business id.

ExceptionBody

401

The provided TED API key doesn't exist or it is invalid.

ExceptionBody

403

No Enotices2 account found for the EU login account identified by provided TED API key.

ExceptionBody

404

Notice or notice report was not found.

ExceptionBody

500

Possible issues: - The provided TED API key cannot be currently validated.

ExceptionBody

Samples

searchProceduresEsentool

GET /api/v2/notice/notices/search-esentool

Search procedures.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

page

Indicates the page number of the paginated result list

-

0

size

Indicates the size of the paginated result list

-

20

sortProperty

The property to use to sort the results

-

null

sortDirection

The sort direction, ascending (ASC) or descending (DESC)

-

null

searchNoticesEsentool

X

null

Return Type
Content Type
  • application/json

Responses
Table 3. http response codes
Code Message Datatype

200

All notices based on filters. Even if 0 results.

SearchNoticeResult

400

Missing Authorization header in request

ExceptionBody

401

The provided TED API key doesn't exist or it is invalid.

ExceptionBody

403

No Enotices2 account found for the EU login account identified by provided TED API key.

ExceptionBody

500

Possible issues: - The provided TED API key cannot be currently validated.

ExceptionBody

Samples

stopPublicationEsentool

POST /api/v2/notice/notices/{businessId}/stop-publication-esentool

Stop the notice publication.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

businessId

The notice business identifier (notice identifier - version)

X

null

Return Type
Content Type
  • application/json

Responses
Table 4. http response codes
Code Message Datatype

200

The publication of the notice has been stopped.

Notice

400

Possible issues: - Missing Authorization header in request - Invalid business id.

ExceptionBody

401

The provided TED API key doesn't exist or it is invalid.

ExceptionBody

403

Possible issues: - Notice publication cannot be stopped because it is not in SUBMITTED status. - No Enotices2 account found for the EU login account identified by provided TED API key.

ExceptionBody

404

Notice was not found.

ExceptionBody

423

Cannot acquire lock because notice is already locked.

ExceptionBody

500

Possible issues: - The provided TED API key cannot be currently validated. - Internal error while updating notice status.

ExceptionBody

Samples

submitNotice

POST /api/v2/notice/notices/submit

Submit XML notice

Description
Parameters
Form Parameters
Name Description Required Default Pattern

metadata

[Metadata]

X

null

notice

The notice XML content. [file]

X

null

Return Type
Content Type
  • application/json

Responses
Table 5. http response codes
Code Message Datatype

201

The notice is created. If CVS validation succeeds, the notice is submitted for publication. Otherwise, is not submitted for publication and report validation can be retrieved from 'validationReportUrl' response property.

CVSReport

400

Possible issues: - Missing Authorization header in request - Missing metadata - Missing notice - Missing noticeAuthorEmail - Missing noticeAuthorLocale - Notice with the same noticeId and versionId already exists. - noticeAuthorEmaill is not valid. - Notice parameter cannot be empty. - Notice cannot be parsed, it is not valid. - Could not find given procedure and cannot create new one for this type of notice. - Missing procedure id in the notice.

ExceptionBody

401

The provided TED API key doesn't exist or it is invalid.

ExceptionBody

403

No Enotices2 account found for the EU login account identified by provided TED API key.

ExceptionBody

404

Possible issues: - No compatible SDK version found

ExceptionBody

409

Possible issues: - Multiple objects are created/updated at the same time.

ExceptionBody

500

Possible issues: - The provided TED API key cannot be currently validated. - The CVS service is not available to validate the notice. - The CVS could not execute the validation.

ExceptionBody

Samples

Models

CVSReport

The CVS report details after the notice xml submission.

Field Name Required Type Description Format

validationReportUrl

String

the url to use to retrieve the CVS validation report

success

Boolean

the status of the submission. True if success, otherwise false.

ExceptionBody

The information related to the Exception that occurred.

Field Name Required Type Description Format

code

String

the exception code.

message

String

the exception message.

Notice

Field Name Required Type Description Format

id

UUID

the notice identifier (without the version).

uuid

versionId

String

the version identifier.

procedureId

UUID

the procedure identifier.

uuid

status

NoticeStatus

updatedAt

Date

The exact moment of the latest update of the notice by either user or system.

date-time

submittedAt

Date

The notice submission date/time.

date-time

publicationId

String

the notice publication identifier.

publicationDate

date

the notice publication date.

date

noticeType

String

the notice notice type.

legalBasis

String

the notice legal basis code.

languages

List of [string]

the notice languages.

noticeAuthor

String

The email is used to identify the person responsible for the notice, i.e. the Contracting Authority.

expectedPublicationDate

date

The notice expected publication date.

date

NoticeStatus

the notice status.

Field Name Required Type Description Format

SearchNotice

The information used in a notice search.

Field Name Required Type Description Format

id

UUID

the notice identifier (without the version).

uuid

versionId

String

the version identifier.

submittedAfter

Date

the minimum date/time value used to find notices submitted after this point.

date-time

submittedBefore

Date

the maximum date/time value used to find notices submitted before this point.

date-time

publishedAfter

Date

the minimum date/time value used to find notices published after this point.

date-time

publishedBefore

Date

the maximum date/time value used to find notices published before this point.

date-time

statuses

List of [string]

The list of status to include in the search: * DRAFT - The notice is being drafted. * SUBMITTED - The notice is successfully received, validated and sent to OP (received by TED-Monitor-2022). * STOPPED - Publication of the notice was stopped by the buyer/ eSender before publication and the request was accepted. * PUBLISHED - The notice is published online on TED. * PUBLISHING - Publication process in progress, i.e. the notice has been added to the daily export for TED. * DELETED - The notice has been deleted by front-end user. * NOT_PUBLISHED - The notice was received but not published on TED. * ARCHIVED - The notice has been archived by front-end user.

Enum:

noticeAuthor

String

the notice author

SearchNoticeResult

The information returned after a notice search.

Field Name Required Type Description Format

totalSize

Long

the total size of entities found.

int64

content

List of Notice

the content of entities found.