Skip to main content

Semantic Treehouse API (0.9.0)

Download OpenAPI specification:Download

License: MIT

TODO

evalidator

APIs to consume the validator functionality via the Semantic Treehouse platform

Get information about which specifications can be used to validate

header Parameters
Access-Token
string

Responses

Response samples

Content type
application/json
{
  • "maxUploadSize": "256M",
  • "projects": [
    ]
}

Get content of schematron specification

path Parameters
objectId
required
string

Identifier of the schematron specification object

header Parameters
Access-Token
string

Responses

Get schematron specification of business rules that are maintained in Semantic Treehouse

path Parameters
syntaxBindingId
required
string

Identifier of the syntax binding

header Parameters
Access-Token
string

Responses

Get schematron specification for codelists constraints that are maintained in Semantic Treehouse

path Parameters
syntaxBindingId
required
string

Identifier of the syntax binding

header Parameters
Access-Token
string

Responses

Get example message for given syntax binding

path Parameters
syntaxBindingId
required
string

Identifier of the syntax binding

exampleId
required
string

Identifier of the example

header Parameters
Access-Token
string

Responses

Validate a message according to message specifications

path Parameters
syntaxBindingId
required
string

Identifier of the syntax binding

query Parameters
skipSchematronIds
string
Example: skipSchematronIds=123,456,789

Comma separated list of schematron specification identifiers that should not be included in the validation

header Parameters
Access-Token
string
Request Body schema: application/xml
object

Responses

Request samples

Content type
application/xml
<xml></xml>

Response samples

Content type
application/json
{
  • "xml_valid": true,
  • "schema_valid": true,
  • "br_valid": true,
  • "xml_errors": {
    },
  • "br_result": {
    },
  • "svrl_reports": [
    ]
}