GetMandatoryCoverages

The API allows you to get mandatory coverages.

/api/v1/coverages/{offerId}/{entityId}/{state}/{lobName}/{mode}/{isMandatory}/{userId}

Request Parameters

The following are the request parameters that need to be updated in the request format.

offerId Integer Required

Unique identifier of an offer.
entityId String Required

Unique identifier of Entity.
state String Required

Name of the state.
lobName String Required

Name of the Line of Business.
mode String Required

Indicates mode.
isMandatory Boolean

Set to true for Mandatory.
userId Integer Required

Unique identifier of user.

Response

Id String

Unique identifier of coverage.
ParentId Integer

Unique identifier of parent coverage.
BusinessEntityId Integer

Unique identifier of Business Entity.
OfferId Integer

Unique identifier of Offer.
Name String

Name of the coverage.
Code String

Indicates code for the coverage.
DisplayName String

Display name of coverage.
SequenceNumber Integer

Sequence Number of coverage.
IsMandatory Boolean

Set to true if coverage is mandatory.
IsSelected Boolean

Set to true if coverage is selected.
IsEnabled Boolean

Set to true if coverage is enabled.
IsVisible Boolean

Set to true if coverage is visible.
Type String

Indicates coverage type.
HelpText String

Help text of coverage.
IsDirty Boolean

Set to true in edit mode.
DetailedXML String

XML object for coverage details.
CoverageId String

Unique identifier of coverage.
Attributes Object
Child Attributes
- Id String
  
  Unique identifier of attribute.
- Name String
  
  Name of the attribute.
- DisplayName String
  
  Display name of the attribute.
- Description String
  
  Description of the attribute.
- ControlType String
  
  Indicates type of the control.
- DataType String
  
  Indicates data type of the control.
- UserValue String
  
  Indicates user value.
- DefaultValue String
  
  Indicates default value of the control.
- PriorValue String
  
  Indicates prior value.
- Values String
  
  Collection of values.
- DetailType String
  
  Indicates detail type.
- SourceType String
  
  Indicates source type.
- SequenceNumber Integer
  
  Indicates sequence number of attribute.
- HelpText String
  
  Indicates help text of attribute.
- IsDirty Boolean
  
  Set to true in edit mode.
- IsEnabled Boolean
  
  Set to true if enabled of attribute.
- IsVisible Boolean
  
  Set to true if visible of attribute.
- IsActionable Boolean
  
  Set to true if action of attribute.
- IsRequired Boolean
  
  Set to true if required of attribute.
- Format String
  
  Indicates format for control.
- Min String
  
  Min value of attribute.
- Max String
  
  Max value of attribute.
- RuleType Object
  
  Indicates rule type.
- ProductChoicesIndicator Boolean
  
  Indicates Product Choice of rule.
- UIRuleIndicator Boolean
  
  Indicates UIRule indicator.
- MaxLength Integer
  
  Indicates length of atrribute value.
- RegexValidation String
  
  Indicates validation of atrribute value.
IsActionable Boolean

Set to true for if it has rule.
HasCoachingContent Boolean

Set to true for Coaching Content.
Fields Object

Attribute collection.
IsAdded Boolean

Set to true when attribute is added.
IsDeleted Boolean

Set to true when attribute is deleted.
IsNewlyAdded Boolean

Set to true when attribute is newly added.
IsNewlyDeleted Boolean

Set to true when attribute is newly deleted.
RuleType RuleType

Rule type object.
ProductChoicesIndicator Boolean

Indicates Product choice indicator.
UIRuleIndicator Boolean

Indicates UI rule.
FullPath String

Coverage hierarchy path.

Response

 [{
  "Id": "BEN513867^C1009",
  "ParentId": null,
  "BusinessEntityId": 513867,
  "OfferId": 17768,
  "Name": "CommercialPropertyLocationFireDepartmentCharge",
  "Code": "",
  "DisplayName": "Fire Department Charge",
  "SequenceNumber": 0,
  "IsMandatory": false,
  "IsSelected": false,
  "IsEnabled": true,
  "IsVisible": true,
  "Type": null,
  "HelpText": "",
  "IsDirty": false,
  "DetailedXml": null,
  "CoverageId": "BEN513867^C1009",
  "Attributes": [{
    "Id": "BEN513867^C1009~FireIncreaseLimitApplyOnPolicyIndicator",
    "Name": "FireIncreaseLimitApplyOnPolicyIndicator",
    "DisplayName": "Fire Increase Limit Apply On Policy Indicator",
    "Description": "",
    "ControlType": "DropDown",
    "DataType": "String",
    "UserValue": "Yes",
    "DefaultValue": null,
    "PriorValue": null,
    "Values": [
     "Yes",
     "No"
    ],
    "DetailType": null,
    "SourceType": null,
    "SequenceNumber": 2813,
    "HelpText": "",
    "IsDirty": false,
    "IsEnabled": true,
    "IsVisible": false,
    "IsActionable": false,
    "IsRequired": true,
    "Format": null,
    "Min": "",
    "Max": "",
    "RuleType": 0,
    "ProductChoicesIndicator": false,
    "UIRuleIndicator": false,
    "MaxLength": 0,
    "RegexValidation": null
   }, {
    "Id": "BEN513867^C1009~Limit",
    "Name": "Limit",
    "DisplayName": "Limit",
    "Description": "",
    "ControlType": "TextBox",
    "DataType": "Decimal",
    "UserValue": null,
    "DefaultValue": null,
    "PriorValue": null,
    "Values": [],
    "DetailType": null,
    "SourceType": null,
    "SequenceNumber": 2815,
    "HelpText": "Maximum amount can be $25,000",
    "IsDirty": false,
    "IsEnabled": true,
    "IsVisible": true,
    "IsActionable": true,
    "IsRequired": true,
    "Format": "currency",
    "Min": "1000",
    "Max": "25000",
    "RuleType": 2,
    "ProductChoicesIndicator": false,
    "UIRuleIndicator": true,
    "MaxLength": 0,
    "RegexValidation": null
   }, {
    "Id": "BEN513867^C1009~PolicyTermPremium",
    "Name": "PolicyTermPremium",
    "DisplayName": "Policy Term Premium",
    "Description": "",
    "ControlType": "TextBox",
    "DataType": "Decimal",
    "UserValue": null,
    "DefaultValue": null,
    "PriorValue": null,
    "Values": [],
    "DetailType": null,
    "SourceType": null,
    "SequenceNumber": 2817,
    "HelpText": "",
    "IsDirty": false,
    "IsEnabled": true,
    "IsVisible": false,
    "IsActionable": false,
    "IsRequired": false,
    "Format": null,
    "Min": "",
    "Max": "",
    "RuleType": 0,
    "ProductChoicesIndicator": false,
    "UIRuleIndicator": false,
    "MaxLength": 0,
    "RegexValidation": null
   }
  ],
  "IsActionable": false,
  "Symbols": null,
  "HasCoachingContent": false,
  "Fields": null,
  "IsAdded": false,
  "IsDeleted": false,
  "IsNewlyAdded": false,
  "IsNewlyDeleted": false,
  "RuleType": 0,
  "ProductChoicesIndicator": false,
  "UIRuleIndicator": false,
  "FullPath": null
 }, {
  "Id": "BEN513867^C1025",
  "ParentId": null,
  "BusinessEntityId": 513867,
  "OfferId": 17768,
  "Name": "CommercialPropertyLocationNewlyAcquiredLocationTimeElement",
  "Code": "",
  "DisplayName": "Newly Acquired Location Time Element",
  "SequenceNumber": 0,
  "IsMandatory": false,
  "IsSelected": false,
  "IsEnabled": true,
  "IsVisible": true,
  "Type": null,
  "HelpText": "",
  "IsDirty": false,
  "DetailedXml": null,
  "CoverageId": "BEN513867^C1025",
  "Attributes": [{
    "Id": "BEN513867^C1025~Indicator",
    "Name": "Indicator",
    "DisplayName": "Indicator",
    "Description": "",
    "ControlType": "DropDown",
    "DataType": "String",
    "UserValue": "Yes",
    "DefaultValue": null,
    "PriorValue": null,
    "Values": [
     "Yes",
     "No"
    ],
    "DetailType": null,
    "SourceType": null,
    "SequenceNumber": 2900,
    "HelpText": "",
    "IsDirty": false,
    "IsEnabled": true,
    "IsVisible": false,
    "IsActionable": false,
    "IsRequired": true,
    "Format": null,
    "Min": "",
    "Max": "",
    "RuleType": 0,
    "ProductChoicesIndicator": false,
    "UIRuleIndicator": false,
    "MaxLength": 0,
    "RegexValidation": null
   }, {
    "Id": "BEN513867^C1025~Limit",
    "Name": "Limit",
    "DisplayName": "Limit",
    "Description": "",
    "ControlType": "TextBox",
    "DataType": "Integer",
    "UserValue": null,
    "DefaultValue": null,
    "PriorValue": null,
    "Values": [],
    "DetailType": null,
    "SourceType": null,
    "SequenceNumber": 2901,
    "HelpText": "",
    "IsDirty": false,
    "IsEnabled": true,
    "IsVisible": true,
    "IsActionable": true,
    "IsRequired": true,
    "Format": null,
    "Min": "",
    "Max": "",
    "RuleType": 1,
    "ProductChoicesIndicator": true,
    "UIRuleIndicator": false,
    "MaxLength": 0,
    "RegexValidation": null
   }, {
    "Id": "BEN513867^C1025~ManualPremium",
    "Name": "ManualPremium",
    "DisplayName": "Manual Premium",
    "Description": "",
    "ControlType": "TextBox",
    "DataType": "Decimal",
    "UserValue": null,
    "DefaultValue": null,
    "PriorValue": null,
    "Values": [],
    "DetailType": null,
    "SourceType": null,
    "SequenceNumber": 2902,
    "HelpText": "",
    "IsDirty": false,
    "IsEnabled": true,
    "IsVisible": true,
    "IsActionable": false,
    "IsRequired": true,
    "Format": null,
    "Min": "",
    "Max": "",
    "RuleType": 0,
    "ProductChoicesIndicator": false,
    "UIRuleIndicator": false,
    "MaxLength": 0,
    "RegexValidation": null
   }, {
    "Id": "BEN513867^C1025~PolicyTermPremium",
    "Name": "PolicyTermPremium",
    "DisplayName": "Policy Term Premium",
    "Description": "",
    "ControlType": "TextBox",
    "DataType": "Integer",
    "UserValue": null,
    "DefaultValue": null,
    "PriorValue": null,
    "Values": [],
    "DetailType": null,
    "SourceType": null,
    "SequenceNumber": 2903,
    "HelpText": "",
    "IsDirty": false,
    "IsEnabled": true,
    "IsVisible": false,
    "IsActionable": false,
    "IsRequired": false,
    "Format": "currency",
    "Min": "",
    "Max": "",
    "RuleType": 0,
    "ProductChoicesIndicator": false,
    "UIRuleIndicator": false,
    "MaxLength": 0,
    "RegexValidation": null
   }
  ],
  "IsActionable": true,
  "Symbols": null,
  "HasCoachingContent": false,
  "Fields": null,
  "IsAdded": false,
  "IsDeleted": false,
  "IsNewlyAdded": false,
  "IsNewlyDeleted": false,
  "RuleType": 1,
  "ProductChoicesIndicator": false,
  "UIRuleIndicator": false,
  "FullPath": null
 }
]
                                                                