| <ul>
<li>Creates a notice instance after validating the request.
<li>A notice with a valid and unique businessId that passes validation, receives status SUBMITTED and can be published.
<li>If validation fails, the notice receives a VALIDATION_FAILED status and the notice cannot be published.
<li>No instance is created if the notice cannot be parsed or if the businessId is not unique.
</ul>
| POST | submitNotice | | /v3/notices/submit | {"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/NoticeSubmitRequest"}}},"required":true} | {"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeSubmitResponse"}}},"description":"Notice created and validation report URL provided.\nIf \"success\": true, the notice was validated without errors and is ready for publication.\nIf \"success\": false, publication is blocked due to validation errors.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionBody"}}},"description":"Possible issues:\n- Missing Authorization header in | [{"token":[]}] | Submit XML notice | ["Publication"] |
| - Performs schematron validation on a provided notice and returns a detailed report.The notice content must be submitted as a base64 string.
- Optional parameters allow for specifying the language for error messages, the validation mode, and the eForms SDK version to validate against, with defaults for unspecified values.
| POST | validate | | /v3/notices/validate | {"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeValidationRequest"}}},"required":true} | {"200":{"content":{"application/xml":{"example":"<svrl:schematron-output xmlns:svrl=\"http://purl.oclc.org/dsdl/svrl\" title=\"eForms schematron rules\" phase=\"1\">\n <svrl:ns-prefix-in-attribute-values prefix=\"xs\" uri=\"http://www.w3.org/2001/XMLSchema\" />\n <svrl:ns-prefix-in-attribute-values prefix=\"sch\" uri=\"http://purl.oclc.org/dsdl/schematron\" />\n <svrl:ns-prefix-in-attribute-values prefix=\"cbc\" uri=\"urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2\ | [{"token":[]}] | Validate a notice | ["Validation"] |
| Returns content of the 'version-range.json' file as a JSON response body. | GET | sdk-range | | /v3/config/sdk-versions | | {"200":{"content":{"application/json":{"example":{"activeVersionRange":{"earliest":{"after":"1.12","before":"1.7","switchDate":"2025-04-30 23:59:00+02:00"},"excluded":{"after":["0.1"],"before":["0.1"],"switchDate":"2020-01-01 10:00:00+02:00"},"latest":{"after":"1.14","before":"1.12","switchDate":"2025-03-06 03:00:00+02:00"}},"updatedOn":"2025-02-12 10:00:00"},"schema":{"$ref":"#/components/schemas/SdkConfigDto"}}},"description":"The information on accepted SDK versions is returned."},"401":{"con | [{"token":[]}] | Return version-range.json | ["Developer Operations"] |
| - Generates a PDF or HTML version of an eForms notice.
- The notice content must be submitted as a base64-encoded string.
- The rendering includes mandatory language specification for field labels and text, with fallback to the notice's original language if needed.
- The rendering is based on the SDK version indicated within the notice content.
| POST | renderNotice | | /v3/notices/render | {"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeRenderRequest"}}},"required":true} | {"200":{"content":{"application/pdf":{"examples":{"PDF rendering of the notice":{"description":"PDF rendering of the notice"}}},"text/html":{"example":"<!DOCTYPE html>\n<html lang=\"en\">\n <body>\n <div class=\"content\">\n <div class=\"h2\" id=\"section1\">1 <span label-id=\"auxiliary|text|buyer\">Buyer</span></div>\n </div>\n </body>\n</html>\n"}},"description":"OK"},"202":{"content":{"application/pdf":{"examples":{"Rendering under processing":{"description":"Me | [{"token":[]}] | Get HTML or PDF rendering of a notice sent in the request body. | ["Visualisation"] |
| Generates a PDF or HTML version of an eForms notice in an asynchronous process and sends back the generated rendering at the specified call-back URL. | POST | renderNoticeWithCallback | | /v3/notices/render-async | {"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeRenderAsyncRequest"}}},"required":true} | {"200":{"content":{"text/plain":{"example":"Your request is being processed asynchronously, and the result will be returned to the following callback URL: \"https://example.test\""}},"description":"OK"},"400":{"content":{"application/json":{"example":{"errorCode":400,"message":"Invalid 'format' parameter value. Possible values are: [PDF, HTML].","timestamp":"2023-01-01 00:00:00+01:00"},"schema":{"$ref":"#/components/schemas/TedAppsErrorResponse"}}},"description":"Possible issues:\n- 'file', 'for | [{"token":[]}] | Get HTML or PDF rendering of a notice sent in the request body. | ["Visualisation"] |
| Converts an XML notice from the old TED XML format to a partial eForms notice. | POST | convertNotice | | /v3/notices/convert | {"content":{"application/xml":{"schema":{"items":{"format":"byte","type":"string"},"type":"array"}}},"required":true} | {"200":{"content":{"application/xml":{"schema":{"items":{"format":"byte","type":"string"},"type":"array"}}},"description":"The notice was successfully converted."},"400":{"description":"Possible issues:\n- Missing Authorization header in request.\n- The request body is incomplete or invalid.\n"},"401":{"description":"The provided API key doesn't exist or it is invalid."},"422":{"description":"Conversion for the given notice type is currently not supported."},"500":{"description":"Possible issues | [{"token":[]}] | Convert an XML notice | ["Conversion"] |
| Extends the validity of an active API Key. If the API Key is already inactive, a new one must be created. This endpoint is designed to be accessed indirectly, through the link provided in the email notification sent as the key approaches its expiration date. | POST | renewApiKey | [{"description":"The token received in the notification email.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","in":"path","name":"token","required":true,"schema":{"type":"string"}}] | /v3/api-keys/{token}/renew | | {"200":{"description":"The API Key validity has been extended."},"400":{"description":"Possible issues:\n- The token provided is invalid.\n- The token provided is not active anymore.\n"},"401":{"description":"Possible issues:\n- The API Key has expired or has been revoked.\n"}} | [{"token":[]}] | Renew the user API Key | ["Developer Operations"] |
| <ul>
<li>Stops the ongoing publication process for a notice identified by a given businessId.
<li>If the notice's status is SUBMITTED, its status is changed to STOPPED and it's withdrawn from publication.
<li>If the notice's status is not SUBMITTED, there is no effect.
</ul>
| POST | stopPublication | [{"description":"The notice business identifier (notice identifier - version).","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6-01","in":"path","name":"businessId","required":true,"schema":{"type":"string"}}] | /v3/notices/{businessId}/stop-publication | | {"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notice"}}},"description":"The publication of the notice has been stopped."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionBody"}}},"description":"Possible issues:\n- Missing Authorization header in request.\n- Invalid business id.\n"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionBody"}}},"description":"The provided API key doesn't exist or | [{"token":[]}] | Stop the notice publication | ["Publication"] |
Reviews
There are no reviews yet.