Form Container

The Form Container is the root element of the form and holds information about the form and its elements.

{
    "form_identifier": string,
    "elements": Array<FormElement>,
    "version": string
}

The form_identifier Property

since v1.0.0

Each form has a unique identifying form_identifier property which is checked server side.

The elements Property

since v1.0.0

The elements property contains all elements of the form. The sorting of the elements suggests an order for a vertical layout, so the first element is suggested to be above the second element, etc.

The version Property

since v1.0.0

The version property follows the semantic versioning specification and defines the interoperability for the API client. The API client should check this version and abort if the version is unsupported (i.e. on major-changes).

Example

{
    "version":"1.0.0",
    "form_identifier":"9a11b19e-077e-4715-904a-a9a2cc891837",
    "elements": [...]
}

Changelog


1.0.0 - 01.02.2019

  • initial version

results matching ""

    No results matching ""