Visualisation API

Abstract
This API provides operation to get HTML or PDF rendering of a notice

Endpoints

NoticeRenderController

renderNotice

POST /v1/render

Get HTML or PDF rendering of a notice sent in the request body.

Description
Parameters
Body Parameter
Name Description Required Default Pattern

NoticeRenderRequestDto

NoticeRenderRequestDto

X

Header Parameters
Name Description Required Default Pattern

X-API-Key

TED API key identifying the author of the request

X

null

Return Type
Content Type
  • text/html

  • application/pdf

Responses
Table 1. http response codes
Code Message Datatype

200

OK

[String]

400

Bad Request

<<>>

Samples

Models

NoticeRenderRequestDto

Notice Render Request

Field Name Required Type Description Format

file

X

String

XML notice encoded in base 64

language

X

String

Language used to render the notice * Notice labels: use the specified * Notice content: use the specified language when it exists in the XML notice otherwise use the first notice original language

Enum: bg, cs, da, de, el, en, es, et, fi, fr, ga, hu, it, lt, lv, mt, nl, pl, pt, ro, sk, sl, sv, hr,

format

X

String

Output format

Enum: PDF, HTML,

textToHighlight

String

Highlight specific text in the notice rendering

summary

Boolean

Render notice by displaying only the specific elements