Choice Field API

This document contains the Choice (radio button) field API format and a list of supported attributes.

Choice field

<field type=”radio” name=”string” search=”boolean” value=”string” roleId=”id”/>

Choice Field/Radio button attributes

  • type — define if this field is radio type, mandatory attribute.

  • name — string, length from 1 up to 128 symbols, restricted symbols &, “, <, >, field name used for fill in on envelope, unique for document, mandatory attribute.

  • value — string, length from 1 up to 128 symbols, restricted symbols &, “, <, >, field value used for fill in value on envelope, unique for group name, mandatory attribute.

  • search — boolean, defines if field is searchable on envelope search or not, if not set default value false, optional attribute.

  • roleId — id of the role who should fill field on envelope, mandatory attribute.

For one group any amount of choice options can be created, but only one of them can be selected in the envelope.