SaveForms

This method allows you to save Forms.

/api/v1/forms/SaveForms/{offerId}/{formName}/{formType}/{lobName}/{state}/{userId}/{template}/{isSaveAction}

Path Parameters

  • offerId Integer Required

    Unique identifier of Offer.

  • formName String Required

    Name of the Form.

  • formType StringRequired

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

  • lobName String Required

    Name of Line of Business.

  • state String Required

    Name of State.

  • userId Integer Required

    User who adds Schedules.

  • template String Required

    Template name of Product.

Request Body Parameters
  • Id Integer

    Unique IDentifier of form data.

  • UId String

    GUID of form data.

  • Code String

    Code of form data.

  • IsAttached Boolean

    Set as true if form is attached to any entity.

  • Mode Add

    Mode of form.

  • Type  Object

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

  • RiskType String

    Risk Type of form.

  • DisplayName String

    Display name of Form.

  • RiskCode String

    Risk code of form.

  • RiskName String

    Risk name of form.

  • Name String

    Name of the form.

  • Schedules Object

  • ScheduleData Object

  • Forms Object

Response
  • Forms Object

  • Schedules Object

  • Coverages Object

  • CoverageDetail Object

  • Messages Object

Request
 {
    "FormData": [{
    "Id": 266921,
    "UId": "8d0c4519-1240-419e-bf50-018723660ae5",
    "Code": null,
    "IsAttached": false,
    "Mode": "Add",
    "Type": {
    "RiskType": "CommercialProperty",
    "DisplayName": "CommercialProperty"
    },
    "RiskCode": "BEN512411",
    "RiskName": "CommercialProperty",
    "Name": null,
    "FormName": "CommercialPropertyZzDisclosurePursuantToTerrorismRiskInsAct2002",
    "Schedules": null,
    "Forms": null,
    "Fields": [{
    "Id": "BEN512411^CommercialPropertyZzDisclosurePursuantToTerrorismRiskInsAct2002~Premium",
    "Name": "Premium",
    "DisplayName": "Terrorism Premium (Certified Acts)",
    "DomainTableName": null,
    "IsMandatory": true,
    "SequenceNumber": 101,
    "IsDeviation": false,
    "IsRequest": false,
    "HelpText": "",
    "OnChangeAction": false,
    "Min": "",
    "Max": "",
    "DataType": "Decimal",
    "Type": "TextBox",
    "sourcetype": 0,
    "Format": null,
    "FactorGroupName": null,
    "ParentGroupName": null,
    "DefaultValue": null,
    "RegexValidation": null,
    "IsEnabled": true,
    "MaxLength": 0,
    "IsVisible": false,
    "Value": "",
    "Values": [],
    "Keys": null,
    "RuleType": 0,
    "ProductChoicesIndicator": false,
    "UIRuleIndicator": false
    }, {
    "Id": "BEN512411^CommercialPropertyZzDisclosurePursuantToTerrorismRiskInsAct2002~AdditionalInformation",
    "Name": "AdditionalInformation",
    "DisplayName": "Additional Information, if any, Concerning the Terrorism Premium",
    "DomainTableName": null,
    "IsMandatory": true,
    "SequenceNumber": 200,
    "IsDeviation": false,
    "IsRequest": false,
    "HelpText": "",
    "OnChangeAction": false,
    "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": "0",
    "Values": [],
    "Keys": null,
    "RuleType": 0,
    "ProductChoicesIndicator": false,
    "UIRuleIndicator": false
    }, {
    "Id": "BEN512411^CommercialPropertyZzDisclosurePursuantToTerrorismRiskInsAct2002~FedShareOfTerrorLossFirstYear",
    "Name": "FedShareOfTerrorLossFirstYear",
    "DisplayName": "Federal share of terrorism first year losses (percentage):",
    "DomainTableName": null,
    "IsMandatory": true,
    "SequenceNumber": 300,
    "IsDeviation": false,
    "IsRequest": false,
    "HelpText": "The federal share is  85% in 2015.  On 1/1/2016, it decreases by 1% per calendar year until equal to 80%.",
    "OnChangeAction": true,
    "Min": "80",
    "Max": "85",
    "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": 2,
    "ProductChoicesIndicator": false,
    "UIRuleIndicator": true
    }, {
    "Id": "BEN512411^CommercialPropertyZzDisclosurePursuantToTerrorismRiskInsAct2002~FirstYear",
    "Name": "FirstYear",
    "DisplayName": "First Year",
    "DomainTableName": null,
    "IsMandatory": true,
    "SequenceNumber": 400,
    "IsDeviation": false,
    "IsRequest": false,
    "HelpText": "Year should be in 4 digits",
    "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
    }, 
    ],
    "Coverages": null,
    "CorrelationId": "a64e4e21-6fa1-4e88-b8a6-856d764fe484",
    "FormId": "BEN512411^CommercialPropertyZzDisclosurePursuantToTerrorismRiskInsAct2002",
    "HelpText": null
    }
    ],
    "Forms": [{
    "Id": "BEN512411^CommercialPropertyOptionalForm3",
    "Name": "CommercialPropertyOptionalForm3",
    "DisplayName": "Commercial Property Optional Form 3",
    "Number": "CP OP 03",
    "SequenceNumber": 80270,
    "Type": "Mandatory",
    "DocUrl": null,
    "IsSelected": true,
    "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
    }
    ]
    }
Response
 {
  "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": []
}