Validation API

Abstract
This API provides operation to validate a notice and get the validation report

Endpoints

Validation

validate

POST /v1/notices/validation

Validate a notice

Description

Validate a notice sent in the request body. This operation returns a schematron validation report which describes all the tests performed.

Parameters
Body Parameter
Name Description Required Default Pattern

InputNoticeValidation

InputNoticeValidation

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
  • application/xml

  • application/json

Responses
Table 1. http response codes
Code Message Datatype

200

The report is returned.

<<>>

400

Possible issues: - The 'language' parameter is not valid. - The 'validationMode' parameter is not valid. The 'validationMode' parameter is not valid. - The rules are missing for the following version.

ErrorResponse

401

Possible issues: - Missing key in header: X-API-Key

ErrorResponse

403

Possible issues: - Invalid key in header: X-API-Key

ErrorResponse

Samples

Models

ErrorResponse

Error response

Field Name Required Type Description Format

errorCode

Integer

HTTP error code

int32

message

String

Error description

timestamp

String

Error timestamp in RFC 3339 format

InputNoticeValidation

Request parameters for validation

Field Name Required Type Description Format

notice

X

byte[]

Payload in base64 for the XML document

byte

language

String

Language to generate the SVRL report. 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]

validationMode

String

Specify the validation mode that will be applied, selecting the corresponding sub-group of the eForms SDK version.

Enum: dynamic, static,

eFormsSdkVersion

String

Specify the eForms SDK version to use for validating the XML document encoded in base64.