GetRiskInfowithFormDetails
The API allows you to retrieve the Risk information along with Form details.
Request Parameters
The following are the request parameters that need to be updated in the request format.
-
offerId Integer Required
Unique identifier of Offer.
-
lobName String Required
Name of Line of Business.
-
state String Required
Name of the State.
-
FormName String Required
Type of Form.
-
formType String Required
Indicates whether the form is Mandatory or Optional.
-
userId Integer Required
User who adds Schedule.
-
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
Child Attributes
-
Id String
Id of Schedule.
-
Code String
Code of Schedule.
-
Mode Add
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
Set as true if Schedule is Mandatory.
-
CoverageType String
Coverage type of schedule.
-
FormType Mandatory
Form Type of Schedule.
-
StateName String
State name of Schedule.
-
Cardinality Single
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
Child Attributes
-
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
Set as true if field is mandatory.
-
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 Independent
Displays as UserInput, derived for field.
-
Format String
Display as Currency, Percentage, or alphanumeric.
-
FactorGroupName String
Factorgroup 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
Set as true if user wants to enable field.
-
MaxLength Integer
Max length of field.
-
IsVisible Boolean
Set as true if user wants to visible the field.
-
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
Indicates as ProductChoices,UIRule or Both.
-
ProductChoicesIndicator Boolean
Set as true if field is ProductChoice.
-
UIRuleIndicator Boolean
Set as true if field is UIRule.
-
-
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 nyumber of Schedule coverage.
-
IsMandatory Boolean
Set as true when Schedule coverage is mandatory.
-
IsSelected Boolean
Set as true when Schedule coverage is selected.
-
IsEnabled Boolean
Set as true when Schedule coverage is enabled.
-
IsVisible Boolean
Set as true when Schedule coverage is visible.
-
Type String
Type of Schedule coverage.
-
HelpText String
Help text for Schedule coverage.
-
IsDirty Boolean
Set as true when Schedule coverage is in edit mode.
-
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 attribute.
-
Values List<String>
List of values for attribute.
-
DetailType String
Detail type of attribute.
-
SourceType String
Source type of attribute.
-
SequenceNumber Integer
Sequence nyumber of attribute.
-
HelpText String
help text for attribute.
-
IsDirty Boolean
Set as true when attribute is in edit mode.
-
IsEnabled Boolean
Set as true when attribute is enabled.
-
IsVisible Boolean
Set as true when attribute is visible on UI.
-
IsActionable Boolean
Set as true when user performs any isolver call on attribute.
-
IsRequired Boolean
Set as true when attribute is mandatory.
-
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
Set as true if attribute rule type is ProductChoiceIndicator.
-
UIRuleIndicator Boolean
Set as true if attribute rule type is UIRuleIndicator.
-
MaxLength Integer
Max length of attribute.
-
RegexValidation String
Performs validation check of 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
ControlTpe 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
Set as true when Symbol is in edit mode.
-
IsEnabled Boolean
Set as true when Symbol is enabled.
-
IsVisible Boolean
Set as true when Symbol is visible on UI.
-
IsActionable Boolean
Set as true when user performs any isolver call on Symbol.
-
IsRequired Boolean
Set as true when Symbol is mandatory.
-
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
Set as true if Symbol rule type is ProductChoiceIndicator.
-
UIRuleIndicator Boolean
Set as true if Symbol type is UIRuleIndicator.
-
MaxLength Integer
Max length of Symbol.
-
RegexValidation String
Performs validation check 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
Set as true when field is mandatory.
-
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 Fiels.
-
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 factorgroup name of field.
-
DefaultValue String
Default value of field.
-
RegexValidation String
Performs validation check.
-
IsEnabled Boolean
Set as true when field is enabled.
-
MaxLength Integer
Max length of field.
-
IsVisible Boolean
Set as true if field ID visible.
-
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
Set as true if field rule type is ProductChoiceIndicator.
-
UIRuleIndicator Boolean
Set as true if field type is UIRuleIndicator.
-
IsAdded Boolean
Set as true when Schedule coverage is added.
-
IsDeleted Boolean
Set as true when Schedule coverage is deleted.
-
IsNewlyAdded Boolean
Set as true when Schedule coverage is newly added.
-
IsNewlyDeleted Boolean
Set as true when Schedule coverage is newly deleted.
-
RuleType "None"
Rule type of Schedule coverage.
-
ProductChoicesIndicator Boolean
Set as true if Schedule coverage rule type is ProductChoiceIndicator.
-
UIRuleIndicator Boolean
Set as true if Schedule coverage type is UIRuleIndicator.
-
FullPath String
-
-
-
ScheduleFields Object
Child Attributes
-
Field String
Field of Schedule.
-
Title String
Title of Schedule.
-
SequenceNumber Integer
Sequence number of Schedule field.
-
IsVisible Boolean
Set as true when section is visible on UI.
-
SequenceNumber Integer
Sequence number of section.
-
FullPath String
Full path of section.
-
UIRuleIndicator Boolean
Set as true if section type is UIRuleIndicator.
-
-
-
Forms Object
Child Attributes
-
FormId String
Id of Forms.
-
CorrelationId String
Correlation ID of forms.
-
HelpText String
Helptext for forms.
-
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
Child Attributes
-
Id String
ID of Schedule.
-
Code String
Code of Schedule.
-
Mode Add
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 the Schedule is mandatory or not.
-
CoverageType String
Coverage type of Schedule.
-
FormType Mandatory
Form type of Schedule.
-
StateName String
State name of Schedule.
-
Cardinality Single
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
Child Attributes
-
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 or not.
-
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 Control Type of a field i.e., textbox, DropDown, DateTime, CheckBox.
-
sourcetype Independent
Displays as UserInput, Derived for field.
-
Format String
Displays as Currency, Percentage or alphanumeric.
-
FactorGroupName String
Factorgroup 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 visible the field 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
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 nyumber 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
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 attribute.
-
Values List<String>
List of values for attribute.
-
DetailType String
Detail type of attribute.
-
SourceType String
Source type of attribute.
-
SequenceNumber Integer
Sequence nyumber 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 check on attributes.
-
-
Symbols
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 is 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
Performs validation check of Symbol.
-
-
Fields
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
Used to perform any iSolver call or not.
-
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 factorgroup 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 Schedule coverage is added or not.
-
IsDeleted Boolean
Indicates whether the Schedule coverage is deleted or not.
-
IsNewlyAdded Boolean
Indicates whether the Schedule coverage is newly added or not.
-
IsNewlyDeleted Boolean
Indicates whether the Schedule coverage is newly deleted or not.
-
RuleType None
Rule type of Schedule coverage.
-
ProductChoicesIndicator Boolean
Indicates whether the Schedule coverage rule type is ProductChoiceIndicator or not.
-
UIRuleIndicator Boolean
Indicates whether the Schedule coverage type is UIRuleIndicator or not.
-
FullPath String
Full path of section.
-
-
-
ScheduleFields
Child Attributes
-
Field String
Field of Schedule.
-
Title String
Title of Schedule.
-
SequenceNumber Integer
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.
-
-
-
Forms Object
Child Attributes
-
FormId String
ID of forms.
-
CorrelationId String
Correlation ID of forms.
-
HelpText String
Help text for forms.
-
{
"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
}
]
}