Publication API

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

Access

  • Bearer Authentication

Endpoints

Notice

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 1. http response codes
Code Message Datatype

200

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

[File]

404

Notice or notice report was not found.

<<>>

500

Possible issues: - TED API key is missing or is not valid. - No Enotices2 account found for the EU login account identified by provided TED API key. - Several versions of notice with given noticeId exist.

<<>>

Samples

searchProceduresEsentool

GET /api/notice/notices/search-esentool

Search procedures.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

page

the current page of results

-

0

size

the size of the page

-

20

sortProperty

the property to use to sort the results

-

null

sortDirection

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

-

ASC

searchNoticesEsentool

X

null

Content Type
  • /

  • application/json

Responses
Table 2. http response codes
Code Message Datatype

200

OK

EsentoolPageDtoEsentoolNoticeDto

500

Possible issues: - TED API key is missing or is not valid. - No Enotices2 account found for the EU login account identified by provided TED API key.

<<>>

Samples

stopPublicationEsentool

POST /api/notice/notices/{noticeId}/stop-publication-esentool

Request to stop the publication of a notice

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 3. http response codes
Code Message Datatype

200

The publication of the notice has been stopped.

EsentoolNoticeDto

403

Possible issues: - Notice publication cannot be stopped

<<>>

404

Notice was not found.

<<>>

500

Possible issues: - TED API key is missing or is not valid. - No Enotices2 account found for the EU login account identified by provided TED API key. - Several versions of notice with given noticeId exist.

<<>>

Samples

submitNotice

POST /api/notice/notices/submit

Submit XML notice

Description
Parameters
Form Parameters
Name Description Required Default Pattern

notice

[file]

X

null

esenderAuthor

[EsenderAuthor]

X

null

Content Type
  • application/json

Responses
Table 4. 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 'cvsLink' response property.

XmlNoticeSubmissionDto

404

Possible issues: - No compatible SDK version found

<<>>

500

Possible issues: - TED API key is missing or is not valid. - No Enotices2 account found for the EU login account identified by provided TED API key. - Notice cannot be created (parsing errors) - Notice with the same noticeId and versionId already exists.

<<>>

Samples

Models

EsentoolNoticeDto

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 notice updated date/time.

date-time

submittedAt

Date

the notice submitted 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.

EsentoolPageDtoEsentoolNoticeDto

Field Name Required Type Description Format

totalSize

Long

the total size of entities found.

int64

content

List of EsentoolNoticeDto

the content of entities found.

ExceptionBody

Field Name Required Type Description Format

code

String

the exception code.

message

String

the exception message.

NoticeStatus

the notice status.

Field Name Required Type Description Format

SearchNoticesEsentool

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

Enum:

XmlNoticeSubmissionDto

Field Name Required Type Description Format

cvsLink

String

the link to use to retrieve the CVS report

success

Boolean

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