Skip to content

UiGenerateResponse

Namespace Pain001.Sdk.

The answer to POST /api/v1/ui/generate.

Positional properties

Property Description
Success Whether the XML was generated.
Message The result message.
Filename A suggested name for the XML file.
Xml The generated XML document, on success.
ValidationErrors The blocking row-level errors, on failure.
SchemeViolations The blocking scheme-rulebook violations, on failure.

Remarks

Pain001Client.GenerateAsync returns it only with UiGenerateResponse.Success true and UiGenerateResponse.Xml set. The same shape, with the findings, is Pain001GenerationRefusedException.Response on a refusal.

Methods

UiGenerateResponse(Boolean, String, String, String, IReadOnlyList<RowError>, IReadOnlyList<JsonElement>)

The answer to POST /api/v1/ui/generate.

Parameter Description
Success Whether the XML was generated.
Message The result message.
Filename A suggested name for the XML file.
Xml The generated XML document, on success.
ValidationErrors The blocking row-level errors, on failure.
SchemeViolations The blocking scheme-rulebook violations, on failure.

Pain001Client.GenerateAsync returns it only with UiGenerateResponse.Success true and UiGenerateResponse.Xml set. The same shape, with the findings, is Pain001GenerationRefusedException.Response on a refusal.

Properties

Filename

A suggested name for the XML file.

Message

The result message.

SchemeViolations

The blocking scheme-rulebook violations, on failure.

Success

Whether the XML was generated.

ValidationErrors

The blocking row-level errors, on failure.

Xml

The generated XML document, on success.

All types