Publication API
This API provides operations for submission of notices for publication and their follow-up
Endpoints
Notice
convert
POST /api/v2/notice/notices/convert
Convert an XML notice in the old TED XML format to an eForms notice.
Responses
| 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. - No Enotices2 account found for the EU login account identified by provided TED API key. |
<<>> |
getValidationReport
GET /api/v2/notice/notices/{businessId}/validation-report
Retrieve the notice validation report.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Provides the notice validation report in SVRL (Schematron Validation Report Language) format. |
|
400 |
Missing Authorization header in request |
|
401 |
The provided TED API key doesn't exist or it is invalid. |
|
404 |
Notice or notice report was not found. |
|
500 |
Possible issues: - The provided TED API key cannot be currently validated. - No Enotices2 account found for the EU login account identified by provided TED API key. |
searchProceduresEsentool
GET /api/v2/notice/notices/search-esentool
Search procedures.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
All notices based on filters. Even if 0 results. |
|
400 |
Missing Authorization header in request |
|
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. - No Enotices2 account found for the EU login account identified by provided TED API key. |
stopPublicationEsentool
POST /api/v2/notice/notices/{businessId}/stop-publication-esentool
Stop the notice publication.
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The publication of the notice has been stopped. |
|
400 |
Missing Authorization header in request |
|
401 |
The provided TED API key doesn't exist or it is invalid. |
|
403 |
Possible issues: - Notice publication cannot be stopped |
|
404 |
Notice was not found. |
|
500 |
Possible issues: - The provided TED API key cannot be currently validated. - No Enotices2 account found for the EU login account identified by provided TED API key. |
submitNotice
POST /api/v2/notice/notices/submit
Submit XML notice
Responses
| 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. |
|
400 |
Possible issues: - Missing Authorization header in request - Notice with the same noticeId and versionId already exists. - Notice cannot be created (parsing errors) |
|
401 |
The provided TED API key doesn't exist or it is invalid. |
|
404 |
Possible issues: - No compatible SDK version found |
|
500 |
Possible issues: - The provided TED API key cannot be currently validated. - No Enotices2 account found for the EU login account identified by provided TED API key. |
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. |
||
noticeAuthor |
String |
the notice author. |
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. |
Metadata
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
noticeAuthorEmail |
String |
the notice author email. |
||
noticeAuthorLocale |
String |
the notice author locale. |
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: |
|
noticeAuthor |
String |
the notice author |