POST /api/{version}/notice/submission/render

This operation allows rendering a notice in HTML or PDF formats. The notice could be provided with the notice parameter, or by specifying the submission_id of an existing notice.

Requires Authorization

The endpoint requires a Basic Auth in the http authorization header. For details, please see the Authentication section.

Request Information

URI Parameters

POST /notice/render

Body Parameters

Details of the request.

NameDescriptionTypeFormatMax lengthExample

notice

XML file base64 encoded

formData

[A-Za-z0-9+/=]+

4,294,967,295 characters

VEVEMTI6cGFzc3dvcmQ=

submission_id

The submission id received when the notice was submitted

formData

yyyymmdd-nnnnnn

11

20211025-123456

format

Indicates the format of the rendering, valid fields include:

  • HTML
  • PDF

formData

^[A-Z]{3,4}$

4

HTML

language

Optionally, the language of the rendering. The language must be specified in IS02. Default value: EN

formData

^[A-Z]{2}$

2

EN

coverPage

Indicate if cover page must be generated. Default value: true.

formData

boolean

5

true

Request Formats

application/x-www-form-urlencoded

Sample:
   notice=PD94bWwgdmVycT049IlIyLjAuOS5TMDIiDQp4bWxucz0idHJ1ay9SMi4wLjkuUzA2BDQogICAgICAgICAgICAgICA8Q09VTlRSWSTUVOVEFSWV9
   PD94bWwgdmVycT049IlIyLjAuOS5TMDIiDQp4bWxucz0idHJ1ay9SMi4wLjkuUzA2BDQogDSADECRTREA54R35CDSFSDICAgICAgICAgICAgICA8Q09VTl
   JFUE12KSOEM0LDSAPDEWMOVr...jkuUzA2BDQogICAgICAgICAgICAgI&format=HTML
		

Response Information

Resource Description

Upon successful request, a result parameter will be provided with a value containing a base64 string comprised of the formatted output.

Response Formats

In the case of wrong authorization header is provided.

application/json, text/json

Sample:
{
    "timestamp": "2018-06-21T00:00:00Z",
    "status": 400,
    "error": "Access Denied",
    "path": "/api/latest/notice/submission/submit"
}
		

200

In case of successful response a simple_result containing the rendered notice base64 encoded.

application/json, text/json

Sample:
{
  "result": "JVBERi0xLjQKJa…….KNzc0OTYKJSVFT0YK"
}
			

400

In case the received notice parameter is not valid Base64 scheme.
In case the notice parameter or the submission_id parameters are not specified.
In case the rendering format is not valid.
In case the language parameter is not valid.

application/json, text/json

Sample:
{
  "timestamp": "2015-06-17T08:20:30Z",
  "status": 400,
  "error": "Bad Request",
  "message": "invalid argument",
  "path": "/api/latest/notice/submission/render",
  "exception": "The input is not in valid Base64 scheme "
}
			

In case wrong parameter name provided

application/json, text/json

Sample:
{
  "timestamp": "2018-01-05T09:01:59Z",
  "status": 400,
  "error": "Bad Request",
  "message": "Request parameters unknown",
  "path": "/api/latest/notice/submission/render",
  "exception": "Request parameter 'formaT' is not recognised, allowed parameters are: submission_id, format,
coverPage, language, notice"
}
			

404

In case the related notice could not be found when the submission_id parameter is specified.

application/json, text/json

Sample:
{
  "timestamp": "2016-05-25T18:24:55Z",
  "status":404,
  "error": "Not Found",
  "message": "Notice not found",
  "path": "/api/latest/notice/submission/render"
}
                        

406

In case the Accept header is provided and set with a value different than ‘application/json’

application/json, text/json

Sample:
{
  "timestamp": "2016-05-25T18:24:55Z",
  "status":406,
  "error": "Not Acceptible",
  "message": "Not acceptable value for ‘Accept’ header. Only ‘application/json’ format is supported",
  "path": "/api/latest/notice/submission/render"
}
                        

422

In case the notice parameter is not valid against the corresponding XSD.

application/json, text/json

Sample:
{
  "timestamp": "2016-05-25T18:24:55Z",
  "status":422,
  "error": "Unprocessable Entity",
  "message": "Notice not valid",
  "path": "/api/latest/notice/submission/render",
  "exception": "Line:2;Column:0;Error 1843:Element 'TED_ESENDERS': Character content other than whitespace is not allowed because the content type is 'element-only'.\n"
}
                        

503

In case the rendering service is not available.