This method allows you to get the iSolver details.

/api/v1/forms/Isolver/{offerId}/{lobName}/{state}/{template}/{userId}/{businessEntityId}

Path Parameters

• offerId Integer Required

  Unique identifier of Offer.

• lobName String Required

  Name of Line of Business.

• state String Required

  Name of the State.

• businessEntityId Integer Required

  Unique identifier of Business Entity.

• userId Integer Required

  User who adds Schedules.

• template String Required

  Template name of Product.

Request Body Parameters

• Id String

  Id of Entity.

• Name String

  Name of Entity.

• Value String

  Value of Entity.

• Type String

  Type of Entity i.e., Form or Schedule or Coverage.

• Parent String

  Parent of Entity.

• ParentName String

  Parent name of Entity.

• RuleType Enum

  Rule type of Entity.

Response

• Forms Object

  Child Attributes

  • Id String

    Unique identifier of form.

  • Name String

    Name of the form.

  • DisplayName String

    Display Name of form.

  • Number String

    Indicates Form number.

  • SequenceNumber Integer

    Sequence number of forms.

  • Type String

    Type of form i.e., Mandatory or Optional.

  • IsSelected Boolean

    Indicates whether the form is selected or not.

  • IsVisible Boolean

    Indicates whether the form is visible on UI or not.

  • State String

    State Name of form.

  • RiskType String

    Risk type of form.

  • RequireAdditionalDetails Boolean

    Indicates whether the form has any additional details or not.

  • IsSubmit Boolean

    Indicates whether the form is submited or not.

  • IsAdded Boolean

    Indicates whether the form is added or not.

  • IsDeleted Boolean

    Indicates whether the form is deleted or not.

  • IsPolicyForm Boolean

    Indicates whether the form is policy level or not.

  • EditionDate String

    Edition date of form.

  • RuleType Enum

    Indicates whether form is UIRuleIndicator or ProductChoicesIndicator.

  • ProductChoicesIndicator Boolean

    Indicates whether the form is ProductChoicesIndicator or not.

  • UIRuleIndicator Boolean

    Indicates whether the form is UIRuleIndicator or not.

  • PremiumBearing String

    Premium bearing of form.

  • RiskIds List<String>

    Risk IDs of form.

• Schedules Object

  Child Attributes

  • Id String

    ID of Schedule.

  • Code String

    Code of Schedule.

  • Mode Enum

    Indicates new, edit or delete mode of Schedule.

  • Name String

    Name of Schedule.

  • DisplayName String

    Display name of Schedule.

  • HelpText String

    Displays Schedule information on UI.

  • IsMandatory Boolean

    Indicates whether theSchedule is mandatory or not.

  • CoverageType String

    Coverage type of Schedule.

  • FormType Enum

    Form type of Schedule.

  • StateName String

    State name of Schedule.

  • Cardinality Single

    It indicates whether Schedule cardinality is single or multiple.

  • FormNumber String

    Form number of Schedule.

  • FormId String

    Form ID of Schedule.

  • ScheduleDetalXML String

    Details XML for Schedule.

  • ScheduleData Object

    Schedule data.

  • Fields Object

    Child Attributes

    • Id String

      ID of field.

    • Name String

      Name of field.

    • DisplayName String

      Display name of field.

    • DomainTableName String

      Domain table name for field.

    • IsMandatory Boolean

      Indicates whether the field is mandatory or not.

    • SequenceNumber Integer

      Sequence number for field.

    • HelpText String

      Displays Schedule field information on UI.

    • OnChangeAction Boolean

      Performs any iSolver call.

    • Min String

      Min value of a field.

    • Max String

      Max value of a field.

    • DataType String

      Data type of a field i.e., Integer, String, or Boolean.

    • Type TextBox

      Indicates ControlType of a field i.e., textbox, DropDown, DateTime, CheckBox.

    • sourcetype Enum

      Displays as UserInput, Derived for field.

    • Format String

      Display as Currency, Percentage, or alphanumeric.

    • FactorGroupName String

      Factor group name of a field.

    • ParentGroupName String

      Parent factor group name of a field.

    • DefaultValue String

      Default value for a field.

    • RegexValidation String

      Displays any validations.

    • IsEnabled Boolean

      Indicates whether the user wants to enable field or not.

    • MaxLength Integer

      Max length of field.

    • IsVisible Boolean

      Indicates whether the user wants to make the field visible or not.

    • Value String

      Value for a field.

    • Values List<String>

      List of values for field.

    • Keys List<String>

      List of Key values for field.

    • RuleType Enum

      It indicates as ProductChoices, UIRule, or Both.

    • ProductChoicesIndicator Boolean

      Indicates whether the field is ProductChoice or not.

    • UIRuleIndicator Boolean

      Indicates whether the field is UIRule or not.

  • ScheduleCoverages Object

    Child Attributes

    • Id String

      ID of Schedule Coverage.

    • ParentId Integer

      Parent ID of Schedule coverage.

    • BusinessEntityId Integer

      BusinessEntityID of Schedule coverage.

    • OfferId Integer

      OfferID of Schedule coverage.

    • Name String

      Name of Schedule coverage.

    • Code String

      Code of Schedule coverage.

    • DisplayName String

      Display name of Schedule coverage.

    • SequenceNumber Integer

      Sequence number of Schedule coverage.

    • IsMandatory Boolean

      Indicates whether the Schedule coverage is mandatory or not.

    • IsSelected Boolean

      Indicates whether the Schedule coverage is selected or not.

    • IsEnabled Boolean

      Indicates whether the Schedule coverage is enabled or not.

    • IsVisible Boolean

      Indicates whether the Schedule coverage is visible or not.

    • Type String

      Type of Schedule coverage.

    • HelpText String

      Help text for Schedule coverage.

    • IsDirty Boolean

      Indicates whether the Schedule coverage is in edit mode or not.

    • DetailedXml String

      Detail XML of Schedule coverage.

    • Attributes Object

      Child Attributes

      • Id String

        ID of Attribute.

      • Name String

        Name of attribute.

      • DisplayName String

        Display name of Attribute.

      • Description String

        Description of attribute.

      • ControlType String

        Control type of attriute.

      • DataType String

        Data type of attribute.

      • UserValue String

        User value of attribute.

      • DefaultValue String

        Default value of attribute.

      • PriorValue String

        Prior value of attributes.

      • Values List<String>

        List of values for attribute.

      • DetailType String

        Detail type of attribute.

      • SourceType String

        Source type of attribute.

      • SequenceNumber Integer

        Sequence number of attribute.

      • HelpText String

        Help text for attribute.

      • IsDirty Boolean

        Indicates whether the attribute is in edit mode or not.

      • IsEnabled Boolean

        Indicates whether the attribute is enabled or not.

      • IsVisible Boolean

        Indicates whether the attribute is visible on UI or not.

      • IsActionable Boolean

        Indicates whether the user perform any iSolver call on attribute or not.

      • IsRequired Boolean

        Indicates whether the attribute is mandatory or not.

      • Format String

        Format of Attribute.

      • Min String

        Min value of attribute.

      • Max String

        Max value of attribute.

      • RuleType Enum

        Rule type of attribute.

      • ProductChoicesIndicator Boolean

        Indicates whether the attribute rule type is ProductChoiceIndicator or not.

      • UIRuleIndicator Boolean

        Indicates whether the attribute rule type is UIRuleIndicator or not.

      • MaxLength Integer

        Max length of attribute.

      • RegexValidation String

        Performs validation checks on attributes.

    • Symbols Object

      Child Attributes

      • Id String

        ID of Symbol.

      • Name String

        Name of Symbol.

      • DisplayName String

        Display name of Symbol.

      • Description String

        Description of Symbol.

      • ControlType String

        Control type of Symbol.

      • DataType String

        Data type of Symbol.

      • UserValue String

        User value of Symbol.

      • DefaultValue String

        Default value of Symbol.

      • PriorValue String

        Prior value of Symbol.

      • Values List<String>

        Values of Symbol.

      • DetailType String

        Detail type of Symbol.

      • SourceType String

        Source type of Symbol.

      • SequenceNumber Integer

        Sequence number of Symbol.

      • HelpText String

        Help text for Symbol.

      • IsDirty Boolean

        Indicates whether the Symbol is in edit mode or not.

      • IsEnabled Boolean

        Indicates whether the Symbol is enabled or not.

      • IsVisible Boolean

        Indicates whether the Symbol is visible on UI or not.

      • IsActionable Boolean

        Indicates whether the user perform any iSolver call on Symbol or not.

      • IsRequired Boolean

        Indicates whether the Symbol in mandatory or not.

      • Format String

        Format of Symbol.

      • Min String

        Min value of Symbol.

      • Max String

        Max value of Symbol

      • RuleType Enum

        Rule type of Symbol

      • ProductChoicesIndicator Boolean

        Indicates whether the Symbol rule type is ProductChoiceIndicator or not.

      • UIRuleIndicator Boolean

        Indicates whether the Symbol type is UIRuleIndicator or not.

      • MaxLength Integer

        Max length of Symbol.

      • RegexValidation String

        Used to check validations of Symbol.

    • Fields Object

      Child Attributes

      • Id String

        ID of field.

      • Name String

        Name of field.

      • DisplayName String

        Display name of field.

      • DomainTableName String

        Domain Table name of field.

      • IsMandatory Boolean

        Indicates whether the field is mandatory or not.

      • SequenceNumber Integer

        Sequence number of field.

      • HelpText String

        Help text for field.

      • OnChangeAction Boolean

        Performs any iSolver call.

      • Min String

        Min value of field.

      • Max String

        Max value of field.

      • DataType String

        Data type of fields.

      • Type TextBox

        Type of field.

      • sourcetype Enum

        Source type of field.

      • Format String

        Format of field.

      • FactorGroupName String

        Factor group name of field.

      • ParentGroupName String

        Parent Factor group name of field.

      • DefaultValue String

        Default value of field.

      • RegexValidation String

        Performs validation check.

      • IsEnabled Boolean

        Indicates whether the field is enabled or not.

      • MaxLength Integer

        Max length of field.

      • IsVisible Boolean

        Indicates whether the field ID is visible or not.

      • Value String

        Value of field.

      • Values List<String>

        List of values of field.

      • Keys List<String>

        Keys of field.

      • RuleType Enum

        Rule type of field.

      • ProductChoicesIndicator Boolean

        Indicates whether the field rule type is ProductChoiceIndicator or not.

      • UIRuleIndicator Boolean

        Indicates whether the field type is UIRuleIndicator or not.

  • • IsAdded Boolean

      Indicates whether the field type is UIRuleIndicator or not.

    • IsDeleted Boolean

      Indicates whether the Schedule coverage is deleted or not.

    • IsNewlyDeleted Boolean

      Indicates whether the Schedule coverage is newly added or not.

    • RuleType None

      Indicates whether the Schedule coverage is newly deleted or not.

    • ProductChoicesIndicator Boolean

      Rule type of Schedule coverage.

    • UIRuleIndicator Boolean

      Indicates whether the Schedule coverage rule type is ProductChoiceIndicator or not.

    • FullPath String

      Indicates whether the Schedule coverage type is UIRuleIndicator or not.

    • ScheduleFields Object

      Child Attributes

      • Field String

        Field of Schedule.

      • Title Integer

        Title of Schedule.

      • SequenceNumber Boolean

        Sequence number of Schedule field.

    • IsVisible Boolean

      Indicates whether the section is visible on UI or not.

    • SequenceNumber Integer

      Sequence number of section.

    • FullPath String

      Full path of section.

    • UIRuleIndicator Boolean

      Indicates whether the section type is UIRuleIndicator or not.

• Coverages Object

• CoverageDetail Object

• Messages Object

  Child Attributes

  • Id String

    ID of Message.

  • Type String

    Type of Message.

  • DisplayText String

    Display text of Message.

 {
  "Id": "string",
  "Name": "string",
  "Value": "string",
  "Type": "string",
  "Parent": "string",
  "ParentName": "string",
  "RuleType": "None"
}

 {
  "Forms": [
    {
      "Id": "BEN513923^CommercialPropertyOptionalForm1",
      "Name": "CommercialPropertyOptionalForm1",
      "DisplayName": "Commercial Property Optional Form 1",
      "Number": "CP OP 01",
      "SequenceNumber": 80268,
      "Type": "Optional",
      "DocUrl": null,
      "IsSelected": false,
      "IsVisible": true,
      "State": [
        "OK"
      ],
      "RiskType": [
        {
          "RiskType": "CommercialProperty",
          "DisplayName": "CommercialProperty"
        }
      ],
      "RequireAdditionalDetails": true,
      "IsSubmit": false,
      "IsAdded": true,
      "IsDeleted": false,
      "IsPolicyForm": true,
      "EditionDate": "01 02",
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "PremiumBearing": "No",
      "RiskIds": null
    },
    {
      "Id": "BEN513925^CommercialPropertyEarthquakeAndVolcanicEruptionEndorsementSubLimitForm",
      "Name": "CommercialPropertyEarthquakeAndVolcanicEruptionEndorsementSubLimitForm",
      "DisplayName": "Earthquake And Volcanic Eruption Endorsement (Sub-Limit Form)",
      "Number": "CP 10 45",
      "SequenceNumber": 16500,
      "Type": "Mandatory",
      "DocUrl": null,
      "IsSelected": false,
      "IsVisible": true,
      "State": [
        "OK"
      ],
      "RiskType": [
        {
          "RiskType": "CommercialPropertyStructure",
          "DisplayName": "CommercialPropertyStructure"
        }
      ],
      "RequireAdditionalDetails": true,
      "IsSubmit": false,
      "IsAdded": true,
      "IsDeleted": false,
      "IsPolicyForm": false,
      "EditionDate": "10 12",
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "PremiumBearing": "Yes",
      "RiskIds": [
        "BEN513925^CommercialPropertyEarthquakeAndVolcanicEruptionEndorsementSubLimitForm"
      ]
    },
    {
      "Id": "BEN513927^CommercialPropertyHigherLimitsOccupClass",
      "Name": "CommercialPropertyHigherLimitsOccupClass",
      "DisplayName": "Higher Limits",
      "Number": "CP 04 08",
      "SequenceNumber": 26100,
      "Type": "Mandatory",
      "DocUrl": null,
      "IsSelected": false,
      "IsVisible": false,
      "State": [
        "OK"
      ],
      "RiskType": [
        {
          "RiskType": "CommercialPropertyOccupClass",
          "DisplayName": "CommercialPropertyOccupClass"
        }
      ],
      "RequireAdditionalDetails": true,
      "IsSubmit": false,
      "IsAdded": true,
      "IsDeleted": false,
      "IsPolicyForm": false,
      "EditionDate": "10 12",
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "PremiumBearing": "No",
      "RiskIds": [
        "BEN513927^CommercialPropertyHigherLimitsOccupClass"
      ]
    },
    {
      "Id": "BEN513923^CPConditionallyOptionalForm10",
      "Name": "CPConditionallyOptionalForm10",
      "DisplayName": "CP Conditionally Optional Form 10",
      "Number": "CP OP  10",
      "SequenceNumber": 80290,
      "Type": "Optional",
      "DocUrl": null,
      "IsSelected": false,
      "IsVisible": true,
      "State": [
        "OK"
      ],
      "RiskType": [
        {
          "RiskType": "CommercialProperty",
          "DisplayName": "CommercialProperty"
        }
      ],
      "RequireAdditionalDetails": false,
      "IsSubmit": false,
      "IsAdded": false,
      "IsDeleted": true,
      "IsPolicyForm": true,
      "EditionDate": "01 08",
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "PremiumBearing": "No",
      "RiskIds": null
    },
    {
      "Id": "BEN513923^CommercialPropertyOptionalForm2",
      "Name": "CommercialPropertyOptionalForm2",
      "DisplayName": "Commercial Property Optional Form 2",
      "Number": "CP OP 02",
      "SequenceNumber": 80269,
      "Type": "Optional",
      "DocUrl": null,
      "IsSelected": false,
      "IsVisible": true,
      "State": [
        "OK"
      ],
      "RiskType": [
        {
          "RiskType": "CommercialProperty",
          "DisplayName": "CommercialProperty"
        }
      ],
      "RequireAdditionalDetails": false,
      "IsSubmit": false,
      "IsAdded": true,
      "IsDeleted": false,
      "IsPolicyForm": true,
      "EditionDate": "01 02",
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "PremiumBearing": "No",
      "RiskIds": null
    },
    {
      "Id": "BEN513923^CommercialPropertyOptionalForm5",
      "Name": "CommercialPropertyOptionalForm5",
      "DisplayName": "Commercial Property Optional Form 5",
      "Number": "CP OP 05",
      "SequenceNumber": 80272,
      "Type": "Optional",
      "DocUrl": null,
      "IsSelected": false,
      "IsVisible": true,
      "State": [
        "OK"
      ],
      "RiskType": [
        {
          "RiskType": "CommercialProperty",
          "DisplayName": "CommercialProperty"
        }
      ],
      "RequireAdditionalDetails": true,
      "IsSubmit": false,
      "IsAdded": true,
      "IsDeleted": false,
      "IsPolicyForm": true,
      "EditionDate": "01 02",
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "PremiumBearing": "No",
      "RiskIds": null
    }
  ],
  "Schedules": [
    {
      "Id": null,
      "Code": null,
      "Mode": "Add",
      "Name": "CommercialPropertyOptionalForm1Schedule",
      "DisplayName": "Commercial Property Optional Form 1 Schedule",
      "Output": null,
      "HelpText": null,
      "IsMandatory": false,
      "CoverageType": null,
      "FormType": "Mandatory",
      "StateName": null,
      "Cardinality": "Single",
      "FormNumber": null,
      "FormId": null,
      "ScheduleDetalXML": null,
      "ScheduleData": null,
      "Fields": null,
      "ScheduleCoverages": null,
      "ScheduleFields": null,
      "IsVisible": false,
      "SequenceNumber": 0,
      "FullPath": "Policy.CommercialProperty.CommercialPropertyOptionalForm1.CommercialPropertyOptionalForm1Schedule",
      "UIRuleIndicator": false
    }
  ],
  "Coverages": [
    {
      "Id": "BEN513923^CommercialPropertyOptionalForm1^CommercialPropertyOptionalForm1Endorsement",
      "ParentId": null,
      "BusinessEntityId": 0,
      "OfferId": 0,
      "Name": "CommercialPropertyOptionalForm1Endorsement",
      "Code": "BEN513923^CommercialPropertyOptionalForm1^CommercialPropertyOptionalForm1Endorsement",
      "DisplayName": "Commercial Property Optional Form 1 Endorsement",
      "SequenceNumber": 80278,
      "IsMandatory": false,
      "IsSelected": false,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": null,
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": null,
      "Attributes": null,
      "IsActionable": false,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": [
        {
          "Id": "BEN513923^CommercialPropertyOptionalForm1^CommercialPropertyOptionalForm1Endorsement~Limit",
          "Name": "Limit",
          "DisplayName": "Limit",
          "DomainTableName": null,
          "IsMandatory": true,
          "SequenceNumber": 302,
          "IsDeviation": false,
          "IsRequest": false,
          "HelpText": "",
          "OnChangeAction": true,
          "Min": "",
          "Max": "",
          "DataType": "Integer",
          "Type": "TextBox",
          "sourcetype": 0,
          "Format": null,
          "FactorGroupName": null,
          "ParentGroupName": null,
          "DefaultValue": null,
          "RegexValidation": null,
          "IsEnabled": true,
          "MaxLength": 0,
          "IsVisible": true,
          "Value": "",
          "Values": [],
          "Keys": null,
          "RuleType": 1,
          "ProductChoicesIndicator": true,
          "UIRuleIndicator": false
        }
      ],
      "IsAdded": true,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 0,
      "ProductChoicesIndicator": true,
      "UIRuleIndicator": false,
      "FullPath": "Policy.CommercialProperty.CommercialPropertyOptionalForm1.CommercialPropertyOptionalForm1Endorsement"
    }
  ],
  "Details": [
    {
      "Id": "BEN513923^CommercialPropertyOptionalForm1^CommercialPropertyOptionalForm1Endorsement~Limit",
      "Name": "Limit",
      "DisplayName": "Limit",
      "Description": null,
      "ControlType": "TextBox",
      "DataType": "Integer",
      "UserValue": null,
      "DefaultValue": null,
      "PriorValue": null,
      "Values": null,
      "DetailType": null,
      "SourceType": null,
      "SequenceNumber": 0,
      "HelpText": "",
      "IsDirty": false,
      "IsEnabled": true,
      "IsVisible": true,
      "IsActionable": true,
      "IsRequired": true,
      "Format": null,
      "Min": "",
      "Max": "",
      "RuleType": 0,
      "ProductChoicesIndicator": true,
      "UIRuleIndicator": false,
      "MaxLength": 0,
      "RegexValidation": null
    }
  ],
  "Messages": []
}