Skip to main content

Get Proposal Form​

Retrieves Proposal Form based on unique productId,manufacturerId and version

Query Parameters
    productId Product id required
    manufacturerId Manufacturerid required
    version Version required
Responses

Successful Response


Schema
    reqId string required

    Request Id assigned by 1SB

    errors object[]

    This array contains error messages in case of an error

    data object required

    Section to carry the proposal form

    productId string required

    Product Id

    manufacturerId string required

    Manufacturer (insurer) Id

    productGroupId string required

    Product group of the product

    productGroupType string

    Product group type

    shorterJourney string

    Possible values: [YES, NO]

    Indicates whether the shorter proposal journey is enabled for the product

    fieldGroups object required

    This section carries multiple sub field groups (fieldGroups) and fields. Each field carries attributes which give additional information, such as

    • id : Unique internal identifier for the field configuration.
    • name : Technical name of the field used as a key in request and response payloads.
    • label : Display label of the field shown on the user interface.
    • type : Data/control type of the field (text, number, date, boolean, single-select, multi-select, checkbox, static).
    • input : Value captured on screen. Empty in Get Proposal Form; populated by AL while submitting the proposal.
    • min / max : Minimum / maximum allowed length of the input value.
    • order : Sequence number that determines the position of the field on the UI.
    • value : List of selectable values (Text / Value) for dropdown or option based fields.
    • entity : Master data entity from which the value list is sourced (e.g. GENDER, CITY, STATE).
    • default / defaultExp : Default value or JavaScript expression used to derive the default value at runtime (uses quoteInfo and formInfo objects).
    • mandatory : 0 = Optional, 1 = Mandatory, 2 = Mandatory and pre-filled from quote (non-editable), 3 = Optional and pre-filled from quote (non-editable).
    • pattern : Regular expression used to validate the input value.
    • validation / validationExp : Validation rule or JavaScript expression used to evaluate custom validation logic and message.
    • visibility : JavaScript expression that controls whether the field / section is visible on the UI.
    • description : Detailed explanation of the field's purpose.
    • mappingType : Defines how the field maps to insurer or internal system fields.
    • placeholder : Hint text displayed inside the input field.
    • fieldLevel / subType / dependentInput / extraValue : Optional attributes present only for specific fields (e.g. dependent inputs, array level fields).
    traceInfo object

    A section (field group) of the proposal form. A group contains fields and/or nested fieldGroups.

    id integer

    Unique internal identifier of the field group

    name string

    Technical name of the field group

    type string nullable

    Group type (e.g. array for repeating groups); null for normal sections

    label string

    Display label of the section

    order integer

    Display order of the section

    parent string nullable

    Parent group name, if any

    description string nullable

    Description of the section

    sizeOfArray nullable

    Number of repetitions when the group is an array

    validation string nullable

    Validation rule applied at section level

    validationExp string nullable

    JavaScript expression for section level validation

    visibility string nullable

    JavaScript expression controlling visibility of the section

    fieldLevel string nullable

    Field level indicator (present for specific groups only)

    fields object

    Fields of the section keyed by field name

    property name* SavingProposalFormField

    A single proposal form field with its UI, validation and visibility attributes.

    id integer required

    Unique internal identifier of the field

    name string required

    Technical name of the field

    type string required

    Possible values: [boolean, checkbox, date, multi-select, number, single-select, static, text]

    Data / control type of the field

    input string

    Value captured on screen. Empty in Get Proposal Form; filled by AL in Submit Proposal Form

    label string required

    Display label

    order integer required

    Display order within the section

    min integer nullable

    Minimum length of the input value

    max integer nullable

    Maximum length of the input value

    value object[] nullable

    Selectable values for dropdown / option based fields

  • Array [
  • Text string

    Display text

    Value string

    Value to be sent in input

  • ]
  • entity string nullable

    Master data entity of the value list

    default string nullable

    Default value or JavaScript expression used to derive the default value

    defaultExp string

    Expression used to derive the default value at runtime

    pattern string nullable

    Regular expression to validate the input

    mandatory integer required

    Possible values: [0, 1, 2, 3]

    0 = Optional, 1 = Mandatory, 2 = Mandatory and pre-filled from quote (non-editable), 3 = Optional and pre-filled from quote (non-editable)

    validation string

    Validation rule / JavaScript validation expression

    validationExp string

    Expression used to evaluate custom validation logic

    visibility string nullable

    JavaScript expression controlling field visibility

    description string nullable

    Detailed explanation of the field purpose

    mappingType string

    How the field maps to insurer / internal system fields

    placeholder string

    Hint text displayed inside the input field

    fieldLevel string

    Field level indicator (specific fields only)

    subType string

    Sub type of the field (specific fields only)

    dependentInput array

    Dependent inputs (specific fields only)

    extraValue string

    Additional value (specific fields only)

    fieldGroups object

    Nested sections keyed by group name

    distributor object

    A section (field group) of the proposal form. A group contains fields and/or nested fieldGroups.

    id integer

    Unique internal identifier of the field group

    name string

    Technical name of the field group

    type string nullable

    Group type (e.g. array for repeating groups); null for normal sections

    label string

    Display label of the section

    order integer

    Display order of the section

    parent string nullable

    Parent group name, if any

    description string nullable

    Description of the section

    sizeOfArray nullable

    Number of repetitions when the group is an array

    validation string nullable

    Validation rule applied at section level

    validationExp string nullable

    JavaScript expression for section level validation

    visibility string nullable

    JavaScript expression controlling visibility of the section

    fieldLevel string nullable

    Field level indicator (present for specific groups only)

    fields object

    Fields of the section keyed by field name

    property name* SavingProposalFormField

    A single proposal form field with its UI, validation and visibility attributes.

    id integer required

    Unique internal identifier of the field

    name string required

    Technical name of the field

    type string required

    Possible values: [boolean, checkbox, date, multi-select, number, single-select, static, text]

    Data / control type of the field

    input string

    Value captured on screen. Empty in Get Proposal Form; filled by AL in Submit Proposal Form

    label string required

    Display label

    order integer required

    Display order within the section

    min integer nullable

    Minimum length of the input value

    max integer nullable

    Maximum length of the input value

    value object[] nullable

    Selectable values for dropdown / option based fields

  • Array [
  • Text string

    Display text

    Value string

    Value to be sent in input

  • ]
  • entity string nullable

    Master data entity of the value list

    default string nullable

    Default value or JavaScript expression used to derive the default value

    defaultExp string

    Expression used to derive the default value at runtime

    pattern string nullable

    Regular expression to validate the input

    mandatory integer required

    Possible values: [0, 1, 2, 3]

    0 = Optional, 1 = Mandatory, 2 = Mandatory and pre-filled from quote (non-editable), 3 = Optional and pre-filled from quote (non-editable)

    validation string

    Validation rule / JavaScript validation expression

    validationExp string

    Expression used to evaluate custom validation logic

    visibility string nullable

    JavaScript expression controlling field visibility

    description string nullable

    Detailed explanation of the field purpose

    mappingType string

    How the field maps to insurer / internal system fields

    placeholder string

    Hint text displayed inside the input field

    fieldLevel string

    Field level indicator (specific fields only)

    subType string

    Sub type of the field (specific fields only)

    dependentInput array

    Dependent inputs (specific fields only)

    extraValue string

    Additional value (specific fields only)

    fieldGroups object

    Nested sections keyed by group name

    proposerDetails object

    A section (field group) of the proposal form. A group contains fields and/or nested fieldGroups.

    id integer

    Unique internal identifier of the field group

    name string

    Technical name of the field group

    type string nullable

    Group type (e.g. array for repeating groups); null for normal sections

    label string

    Display label of the section

    order integer

    Display order of the section

    parent string nullable

    Parent group name, if any

    description string nullable

    Description of the section

    sizeOfArray nullable

    Number of repetitions when the group is an array

    validation string nullable

    Validation rule applied at section level

    validationExp string nullable

    JavaScript expression for section level validation

    visibility string nullable

    JavaScript expression controlling visibility of the section

    fieldLevel string nullable

    Field level indicator (present for specific groups only)

    fields object

    Fields of the section keyed by field name

    property name* SavingProposalFormField

    A single proposal form field with its UI, validation and visibility attributes.

    id integer required

    Unique internal identifier of the field

    name string required

    Technical name of the field

    type string required

    Possible values: [boolean, checkbox, date, multi-select, number, single-select, static, text]

    Data / control type of the field

    input string

    Value captured on screen. Empty in Get Proposal Form; filled by AL in Submit Proposal Form

    label string required

    Display label

    order integer required

    Display order within the section

    min integer nullable

    Minimum length of the input value

    max integer nullable

    Maximum length of the input value

    value object[] nullable

    Selectable values for dropdown / option based fields

  • Array [
  • Text string

    Display text

    Value string

    Value to be sent in input

  • ]
  • entity string nullable

    Master data entity of the value list

    default string nullable

    Default value or JavaScript expression used to derive the default value

    defaultExp string

    Expression used to derive the default value at runtime

    pattern string nullable

    Regular expression to validate the input

    mandatory integer required

    Possible values: [0, 1, 2, 3]

    0 = Optional, 1 = Mandatory, 2 = Mandatory and pre-filled from quote (non-editable), 3 = Optional and pre-filled from quote (non-editable)

    validation string

    Validation rule / JavaScript validation expression

    validationExp string

    Expression used to evaluate custom validation logic

    visibility string nullable

    JavaScript expression controlling field visibility

    description string nullable

    Detailed explanation of the field purpose

    mappingType string

    How the field maps to insurer / internal system fields

    placeholder string

    Hint text displayed inside the input field

    fieldLevel string

    Field level indicator (specific fields only)

    subType string

    Sub type of the field (specific fields only)

    dependentInput array

    Dependent inputs (specific fields only)

    extraValue string

    Additional value (specific fields only)

    fieldGroups object

    Nested sections keyed by group name

    firstLifeAssuredDetails object

    A section (field group) of the proposal form. A group contains fields and/or nested fieldGroups.

    id integer

    Unique internal identifier of the field group

    name string

    Technical name of the field group

    type string nullable

    Group type (e.g. array for repeating groups); null for normal sections

    label string

    Display label of the section

    order integer

    Display order of the section

    parent string nullable

    Parent group name, if any

    description string nullable

    Description of the section

    sizeOfArray nullable

    Number of repetitions when the group is an array

    validation string nullable

    Validation rule applied at section level

    validationExp string nullable

    JavaScript expression for section level validation

    visibility string nullable

    JavaScript expression controlling visibility of the section

    fieldLevel string nullable

    Field level indicator (present for specific groups only)

    fields object

    Fields of the section keyed by field name

    property name* SavingProposalFormField

    A single proposal form field with its UI, validation and visibility attributes.

    id integer required

    Unique internal identifier of the field

    name string required

    Technical name of the field

    type string required

    Possible values: [boolean, checkbox, date, multi-select, number, single-select, static, text]

    Data / control type of the field

    input string

    Value captured on screen. Empty in Get Proposal Form; filled by AL in Submit Proposal Form

    label string required

    Display label

    order integer required

    Display order within the section

    min integer nullable

    Minimum length of the input value

    max integer nullable

    Maximum length of the input value

    value object[] nullable

    Selectable values for dropdown / option based fields

  • Array [
  • Text string

    Display text

    Value string

    Value to be sent in input

  • ]
  • entity string nullable

    Master data entity of the value list

    default string nullable

    Default value or JavaScript expression used to derive the default value

    defaultExp string

    Expression used to derive the default value at runtime

    pattern string nullable

    Regular expression to validate the input

    mandatory integer required

    Possible values: [0, 1, 2, 3]

    0 = Optional, 1 = Mandatory, 2 = Mandatory and pre-filled from quote (non-editable), 3 = Optional and pre-filled from quote (non-editable)

    validation string

    Validation rule / JavaScript validation expression

    validationExp string

    Expression used to evaluate custom validation logic

    visibility string nullable

    JavaScript expression controlling field visibility

    description string nullable

    Detailed explanation of the field purpose

    mappingType string

    How the field maps to insurer / internal system fields

    placeholder string

    Hint text displayed inside the input field

    fieldLevel string

    Field level indicator (specific fields only)

    subType string

    Sub type of the field (specific fields only)

    dependentInput array

    Dependent inputs (specific fields only)

    extraValue string

    Additional value (specific fields only)

    fieldGroups object

    Nested sections keyed by group name

    nomineeDetails object

    A section (field group) of the proposal form. A group contains fields and/or nested fieldGroups.

    id integer

    Unique internal identifier of the field group

    name string

    Technical name of the field group

    type string nullable

    Group type (e.g. array for repeating groups); null for normal sections

    label string

    Display label of the section

    order integer

    Display order of the section

    parent string nullable

    Parent group name, if any

    description string nullable

    Description of the section

    sizeOfArray nullable

    Number of repetitions when the group is an array

    validation string nullable

    Validation rule applied at section level

    validationExp string nullable

    JavaScript expression for section level validation

    visibility string nullable

    JavaScript expression controlling visibility of the section

    fieldLevel string nullable

    Field level indicator (present for specific groups only)

    fields object

    Fields of the section keyed by field name

    property name* SavingProposalFormField

    A single proposal form field with its UI, validation and visibility attributes.

    id integer required

    Unique internal identifier of the field

    name string required

    Technical name of the field

    type string required

    Possible values: [boolean, checkbox, date, multi-select, number, single-select, static, text]

    Data / control type of the field

    input string

    Value captured on screen. Empty in Get Proposal Form; filled by AL in Submit Proposal Form

    label string required

    Display label

    order integer required

    Display order within the section

    min integer nullable

    Minimum length of the input value

    max integer nullable

    Maximum length of the input value

    value object[] nullable

    Selectable values for dropdown / option based fields

  • Array [
  • Text string

    Display text

    Value string

    Value to be sent in input

  • ]
  • entity string nullable

    Master data entity of the value list

    default string nullable

    Default value or JavaScript expression used to derive the default value

    defaultExp string

    Expression used to derive the default value at runtime

    pattern string nullable

    Regular expression to validate the input

    mandatory integer required

    Possible values: [0, 1, 2, 3]

    0 = Optional, 1 = Mandatory, 2 = Mandatory and pre-filled from quote (non-editable), 3 = Optional and pre-filled from quote (non-editable)

    validation string

    Validation rule / JavaScript validation expression

    validationExp string

    Expression used to evaluate custom validation logic

    visibility string nullable

    JavaScript expression controlling field visibility

    description string nullable

    Detailed explanation of the field purpose

    mappingType string

    How the field maps to insurer / internal system fields

    placeholder string

    Hint text displayed inside the input field

    fieldLevel string

    Field level indicator (specific fields only)

    subType string

    Sub type of the field (specific fields only)

    dependentInput array

    Dependent inputs (specific fields only)

    extraValue string

    Additional value (specific fields only)

    fieldGroups object

    Nested sections keyed by group name

    payorDetails object

    A section (field group) of the proposal form. A group contains fields and/or nested fieldGroups.

    id integer

    Unique internal identifier of the field group

    name string

    Technical name of the field group

    type string nullable

    Group type (e.g. array for repeating groups); null for normal sections

    label string

    Display label of the section

    order integer

    Display order of the section

    parent string nullable

    Parent group name, if any

    description string nullable

    Description of the section

    sizeOfArray nullable

    Number of repetitions when the group is an array

    validation string nullable

    Validation rule applied at section level

    validationExp string nullable

    JavaScript expression for section level validation

    visibility string nullable

    JavaScript expression controlling visibility of the section

    fieldLevel string nullable

    Field level indicator (present for specific groups only)

    fields object

    Fields of the section keyed by field name

    property name* SavingProposalFormField

    A single proposal form field with its UI, validation and visibility attributes.

    id integer required

    Unique internal identifier of the field

    name string required

    Technical name of the field

    type string required

    Possible values: [boolean, checkbox, date, multi-select, number, single-select, static, text]

    Data / control type of the field

    input string

    Value captured on screen. Empty in Get Proposal Form; filled by AL in Submit Proposal Form

    label string required

    Display label

    order integer required

    Display order within the section

    min integer nullable

    Minimum length of the input value

    max integer nullable

    Maximum length of the input value

    value object[] nullable

    Selectable values for dropdown / option based fields

  • Array [
  • Text string

    Display text

    Value string

    Value to be sent in input

  • ]
  • entity string nullable

    Master data entity of the value list

    default string nullable

    Default value or JavaScript expression used to derive the default value

    defaultExp string

    Expression used to derive the default value at runtime

    pattern string nullable

    Regular expression to validate the input

    mandatory integer required

    Possible values: [0, 1, 2, 3]

    0 = Optional, 1 = Mandatory, 2 = Mandatory and pre-filled from quote (non-editable), 3 = Optional and pre-filled from quote (non-editable)

    validation string

    Validation rule / JavaScript validation expression

    validationExp string

    Expression used to evaluate custom validation logic

    visibility string nullable

    JavaScript expression controlling field visibility

    description string nullable

    Detailed explanation of the field purpose

    mappingType string

    How the field maps to insurer / internal system fields

    placeholder string

    Hint text displayed inside the input field

    fieldLevel string

    Field level indicator (specific fields only)

    subType string

    Sub type of the field (specific fields only)

    dependentInput array

    Dependent inputs (specific fields only)

    extraValue string

    Additional value (specific fields only)

    fieldGroups object

    Nested sections keyed by group name

    other object

    A section (field group) of the proposal form. A group contains fields and/or nested fieldGroups.

    id integer

    Unique internal identifier of the field group

    name string

    Technical name of the field group

    type string nullable

    Group type (e.g. array for repeating groups); null for normal sections

    label string

    Display label of the section

    order integer

    Display order of the section

    parent string nullable

    Parent group name, if any

    description string nullable

    Description of the section

    sizeOfArray nullable

    Number of repetitions when the group is an array

    validation string nullable

    Validation rule applied at section level

    validationExp string nullable

    JavaScript expression for section level validation

    visibility string nullable

    JavaScript expression controlling visibility of the section

    fieldLevel string nullable

    Field level indicator (present for specific groups only)

    fields object

    Fields of the section keyed by field name

    property name* SavingProposalFormField

    A single proposal form field with its UI, validation and visibility attributes.

    id integer required

    Unique internal identifier of the field

    name string required

    Technical name of the field

    type string required

    Possible values: [boolean, checkbox, date, multi-select, number, single-select, static, text]

    Data / control type of the field

    input string

    Value captured on screen. Empty in Get Proposal Form; filled by AL in Submit Proposal Form

    label string required

    Display label

    order integer required

    Display order within the section

    min integer nullable

    Minimum length of the input value

    max integer nullable

    Maximum length of the input value

    value object[] nullable

    Selectable values for dropdown / option based fields

  • Array [
  • Text string

    Display text

    Value string

    Value to be sent in input

  • ]
  • entity string nullable

    Master data entity of the value list

    default string nullable

    Default value or JavaScript expression used to derive the default value

    defaultExp string

    Expression used to derive the default value at runtime

    pattern string nullable

    Regular expression to validate the input

    mandatory integer required

    Possible values: [0, 1, 2, 3]

    0 = Optional, 1 = Mandatory, 2 = Mandatory and pre-filled from quote (non-editable), 3 = Optional and pre-filled from quote (non-editable)

    validation string

    Validation rule / JavaScript validation expression

    validationExp string

    Expression used to evaluate custom validation logic

    visibility string nullable

    JavaScript expression controlling field visibility

    description string nullable

    Detailed explanation of the field purpose

    mappingType string

    How the field maps to insurer / internal system fields

    placeholder string

    Hint text displayed inside the input field

    fieldLevel string

    Field level indicator (specific fields only)

    subType string

    Sub type of the field (specific fields only)

    dependentInput array

    Dependent inputs (specific fields only)

    extraValue string

    Additional value (specific fields only)

    fieldGroups object

    Nested sections keyed by group name

    payoutDetails object

    A section (field group) of the proposal form. A group contains fields and/or nested fieldGroups.

    id integer

    Unique internal identifier of the field group

    name string

    Technical name of the field group

    type string nullable

    Group type (e.g. array for repeating groups); null for normal sections

    label string

    Display label of the section

    order integer

    Display order of the section

    parent string nullable

    Parent group name, if any

    description string nullable

    Description of the section

    sizeOfArray nullable

    Number of repetitions when the group is an array

    validation string nullable

    Validation rule applied at section level

    validationExp string nullable

    JavaScript expression for section level validation

    visibility string nullable

    JavaScript expression controlling visibility of the section

    fieldLevel string nullable

    Field level indicator (present for specific groups only)

    fields object

    Fields of the section keyed by field name

    property name* SavingProposalFormField

    A single proposal form field with its UI, validation and visibility attributes.

    id integer required

    Unique internal identifier of the field

    name string required

    Technical name of the field

    type string required

    Possible values: [boolean, checkbox, date, multi-select, number, single-select, static, text]

    Data / control type of the field

    input string

    Value captured on screen. Empty in Get Proposal Form; filled by AL in Submit Proposal Form

    label string required

    Display label

    order integer required

    Display order within the section

    min integer nullable

    Minimum length of the input value

    max integer nullable

    Maximum length of the input value

    value object[] nullable

    Selectable values for dropdown / option based fields

  • Array [
  • Text string

    Display text

    Value string

    Value to be sent in input

  • ]
  • entity string nullable

    Master data entity of the value list

    default string nullable

    Default value or JavaScript expression used to derive the default value

    defaultExp string

    Expression used to derive the default value at runtime

    pattern string nullable

    Regular expression to validate the input

    mandatory integer required

    Possible values: [0, 1, 2, 3]

    0 = Optional, 1 = Mandatory, 2 = Mandatory and pre-filled from quote (non-editable), 3 = Optional and pre-filled from quote (non-editable)

    validation string

    Validation rule / JavaScript validation expression

    validationExp string

    Expression used to evaluate custom validation logic

    visibility string nullable

    JavaScript expression controlling field visibility

    description string nullable

    Detailed explanation of the field purpose

    mappingType string

    How the field maps to insurer / internal system fields

    placeholder string

    Hint text displayed inside the input field

    fieldLevel string

    Field level indicator (specific fields only)

    subType string

    Sub type of the field (specific fields only)

    dependentInput array

    Dependent inputs (specific fields only)

    extraValue string

    Additional value (specific fields only)

    fieldGroups object

    Nested sections keyed by group name

    ACR object

    A section (field group) of the proposal form. A group contains fields and/or nested fieldGroups.

    id integer

    Unique internal identifier of the field group

    name string

    Technical name of the field group

    type string nullable

    Group type (e.g. array for repeating groups); null for normal sections

    label string

    Display label of the section

    order integer

    Display order of the section

    parent string nullable

    Parent group name, if any

    description string nullable

    Description of the section

    sizeOfArray nullable

    Number of repetitions when the group is an array

    validation string nullable

    Validation rule applied at section level

    validationExp string nullable

    JavaScript expression for section level validation

    visibility string nullable

    JavaScript expression controlling visibility of the section

    fieldLevel string nullable

    Field level indicator (present for specific groups only)

    fields object

    Fields of the section keyed by field name

    property name* SavingProposalFormField

    A single proposal form field with its UI, validation and visibility attributes.

    id integer required

    Unique internal identifier of the field

    name string required

    Technical name of the field

    type string required

    Possible values: [boolean, checkbox, date, multi-select, number, single-select, static, text]

    Data / control type of the field

    input string

    Value captured on screen. Empty in Get Proposal Form; filled by AL in Submit Proposal Form

    label string required

    Display label

    order integer required

    Display order within the section

    min integer nullable

    Minimum length of the input value

    max integer nullable

    Maximum length of the input value

    value object[] nullable

    Selectable values for dropdown / option based fields

  • Array [
  • Text string

    Display text

    Value string

    Value to be sent in input

  • ]
  • entity string nullable

    Master data entity of the value list

    default string nullable

    Default value or JavaScript expression used to derive the default value

    defaultExp string

    Expression used to derive the default value at runtime

    pattern string nullable

    Regular expression to validate the input

    mandatory integer required

    Possible values: [0, 1, 2, 3]

    0 = Optional, 1 = Mandatory, 2 = Mandatory and pre-filled from quote (non-editable), 3 = Optional and pre-filled from quote (non-editable)

    validation string

    Validation rule / JavaScript validation expression

    validationExp string

    Expression used to evaluate custom validation logic

    visibility string nullable

    JavaScript expression controlling field visibility

    description string nullable

    Detailed explanation of the field purpose

    mappingType string

    How the field maps to insurer / internal system fields

    placeholder string

    Hint text displayed inside the input field

    fieldLevel string

    Field level indicator (specific fields only)

    subType string

    Sub type of the field (specific fields only)

    dependentInput array

    Dependent inputs (specific fields only)

    extraValue string

    Additional value (specific fields only)

    fieldGroups object

    Nested sections keyed by group name

    otpDetails object

    A section (field group) of the proposal form. A group contains fields and/or nested fieldGroups.

    id integer

    Unique internal identifier of the field group

    name string

    Technical name of the field group

    type string nullable

    Group type (e.g. array for repeating groups); null for normal sections

    label string

    Display label of the section

    order integer

    Display order of the section

    parent string nullable

    Parent group name, if any

    description string nullable

    Description of the section

    sizeOfArray nullable

    Number of repetitions when the group is an array

    validation string nullable

    Validation rule applied at section level

    validationExp string nullable

    JavaScript expression for section level validation

    visibility string nullable

    JavaScript expression controlling visibility of the section

    fieldLevel string nullable

    Field level indicator (present for specific groups only)

    fields object

    Fields of the section keyed by field name

    property name* SavingProposalFormField

    A single proposal form field with its UI, validation and visibility attributes.

    id integer required

    Unique internal identifier of the field

    name string required

    Technical name of the field

    type string required

    Possible values: [boolean, checkbox, date, multi-select, number, single-select, static, text]

    Data / control type of the field

    input string

    Value captured on screen. Empty in Get Proposal Form; filled by AL in Submit Proposal Form

    label string required

    Display label

    order integer required

    Display order within the section

    min integer nullable

    Minimum length of the input value

    max integer nullable

    Maximum length of the input value

    value object[] nullable

    Selectable values for dropdown / option based fields

  • Array [
  • Text string

    Display text

    Value string

    Value to be sent in input

  • ]
  • entity string nullable

    Master data entity of the value list

    default string nullable

    Default value or JavaScript expression used to derive the default value

    defaultExp string

    Expression used to derive the default value at runtime

    pattern string nullable

    Regular expression to validate the input

    mandatory integer required

    Possible values: [0, 1, 2, 3]

    0 = Optional, 1 = Mandatory, 2 = Mandatory and pre-filled from quote (non-editable), 3 = Optional and pre-filled from quote (non-editable)

    validation string

    Validation rule / JavaScript validation expression

    validationExp string

    Expression used to evaluate custom validation logic

    visibility string nullable

    JavaScript expression controlling field visibility

    description string nullable

    Detailed explanation of the field purpose

    mappingType string

    How the field maps to insurer / internal system fields

    placeholder string

    Hint text displayed inside the input field

    fieldLevel string

    Field level indicator (specific fields only)

    subType string

    Sub type of the field (specific fields only)

    dependentInput array

    Dependent inputs (specific fields only)

    extraValue string

    Additional value (specific fields only)

    fieldGroups object

    Nested sections keyed by group name

Loading...