{ "columns": [ "description", "http_method", "operation_id", "parameters", "path", "request_body", "responses", "security", "summary", "tags" ], "rows": [ { "description": "\n", "http_method": "POST", "operation_id": "submitNotice", "parameters": null, "path": "/v3/notices/submit", "request_body": "{\"content\":{\"multipart/form-data\":{\"schema\":{\"$ref\":\"#/components/schemas/NoticeSubmitRequest\"}}},\"required\":true}", "responses": "{\"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", "security": "[{\"token\":[]}]", "summary": "Submit XML notice", "tags": "[\"Publication\"]" }, { "description": "- Performs schematron validation on a provided notice and returns a detailed report.The notice content must be submitted as a base64 string.\n- 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.\n", "http_method": "POST", "operation_id": "validate", "parameters": null, "path": "/v3/notices/validate", "request_body": "{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NoticeValidationRequest\"}}},\"required\":true}", "responses": "{\"200\":{\"content\":{\"application/xml\":{\"example\":\"\\n \\n \\n \\n\\n \\n
\\n
1 Buyer
\\n
\\n \\n\\n\"}},\"description\":\"OK\"},\"202\":{\"content\":{\"application/pdf\":{\"examples\":{\"Rendering under processing\":{\"description\":\"Me", "security": "[{\"token\":[]}]", "summary": "Get HTML or PDF rendering of a notice sent in the request body.", "tags": "[\"Visualisation\"]" }, { "description": "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.", "http_method": "POST", "operation_id": "renderNoticeWithCallback", "parameters": null, "path": "/v3/notices/render-async", "request_body": "{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NoticeRenderAsyncRequest\"}}},\"required\":true}", "responses": "{\"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", "security": "[{\"token\":[]}]", "summary": "Get HTML or PDF rendering of a notice sent in the request body.", "tags": "[\"Visualisation\"]" }, { "description": "Converts an XML notice from the old TED XML format to a partial eForms notice.", "http_method": "POST", "operation_id": "convertNotice", "parameters": null, "path": "/v3/notices/convert", "request_body": "{\"content\":{\"application/xml\":{\"schema\":{\"items\":{\"format\":\"byte\",\"type\":\"string\"},\"type\":\"array\"}}},\"required\":true}", "responses": "{\"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", "security": "[{\"token\":[]}]", "summary": "Convert an XML notice", "tags": "[\"Conversion\"]" }, { "description": "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.", "http_method": "POST", "operation_id": "renewApiKey", "parameters": "[{\"description\":\"The token received in the notification email.\",\"example\":\"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\"in\":\"path\",\"name\":\"token\",\"required\":true,\"schema\":{\"type\":\"string\"}}]", "path": "/v3/api-keys/{token}/renew", "request_body": null, "responses": "{\"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\"}}", "security": "[{\"token\":[]}]", "summary": "Renew the user API Key", "tags": "[\"Developer Operations\"]" }, { "description": "
    \n
  • Stops the ongoing publication process for a notice identified by a given businessId.\n
  • If the notice's status is SUBMITTED, its status is changed to STOPPED and it's withdrawn from publication.\n
  • If the notice's status is not SUBMITTED, there is no effect.\n
\n", "http_method": "POST", "operation_id": "stopPublication", "parameters": "[{\"description\":\"The notice business identifier (notice identifier - version).\",\"example\":\"3fa85f64-5717-4562-b3fc-2c963f66afa6-01\",\"in\":\"path\",\"name\":\"businessId\",\"required\":true,\"schema\":{\"type\":\"string\"}}]", "path": "/v3/notices/{businessId}/stop-publication", "request_body": null, "responses": "{\"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", "security": "[{\"token\":[]}]", "summary": "Stop the notice publication", "tags": "[\"Publication\"]" } ] }