GetFormDetails

This method allows you to retrieve Form details.

/api/v1/forms/getFormDetails/{offerId}/{lobname}/{state}/{userId}/{template}

Path Parameters

  • offerId Integer Required

    Unique identifier of Offer.

  • 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.

  • BusinessEntityId Integer

    Unique identifier of Business Entity.

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
  • Id Integer

    Unique identifier of form data.

  • UId String

    GUID of form data.

  • Code String

    Code of form data.

  • IsAttached Boolean

    Indicates whether the form is attached to any entity or not.

  • 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

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
{
    "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
    }
    ]
    }