Get Coverages

The following method retrieves coverage data.

/api/hobpcoverages/{offerId}/ {state}/ {userId}/ {isSaveAction}

Request Parameters

  • offerID Integer

    Unique identifier of Offer

  • state string

    Name of State.

  • userID integer

    Unique identifier of a user.

  • isSaveAction boolean

    Whether the action must be saved or not.

Response

  • AgentName string

    Name of the agent.

  • MailingAddress string

    Postal address to send documents.

  • InsuredName string

    Name of the insured.

  • EffectiveDate DateTime

    Effective date of Policy.

  • UserId integer

    Metadata

  • QuoteId integer

    Metadata

Request
3459
Response
{
  "Attributes": null,
  "Coverages": [
    {
      "Id": "BEN3459^C1",
      "ParentId": null,
      "BusinessEntityId": 3459,
      "OfferId": 988,
      "Name": "ReplacementCostforNonBuildingStructures",
      "Code": "",
      "DisplayName": "Replacement Cost for Non-Building Structures",
      "SequenceNumber": 0,
      "IsMandatory": false,
      "IsSelected": false,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": "Coverage option that upgrades settlement of non-building structures from actual cash value to replacement cost, with no deduction for depreciation.",
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": "BEN3459^C1",
      "Attributes": null,
      "IsActionable": true,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": null,
      "IsAdded": false,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 1,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "CoverageCategory": 0
    },
    {
      "Id": "BEN3459^C2",
      "ParentId": null,
      "BusinessEntityId": 3459,
      "OfferId": 988,
      "Name": "PersonalPropertyReplacementCost",
      "Code": "",
      "DisplayName": "Personal Property Replacement Cost",
      "SequenceNumber": 0,
      "IsMandatory": false,
      "IsSelected": false,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": "Coverage option that upgrades loss settlement of covered personal property from actual cash value to replacement cost, with no deduction for depreciation.",
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": "BEN3459^C2",
      "Attributes": null,
      "IsActionable": true,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": null,
      "IsAdded": false,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 1,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "CoverageCategory": 0
    },
    {
      "Id": "BEN3459^C3",
      "ParentId": null,
      "BusinessEntityId": 3459,
      "OfferId": 988,
      "Name": "LimitedWaterBackupAndSumpDischargeOrOverflowCoverage",
      "Code": "",
      "DisplayName": "Water Backup ",
      "SequenceNumber": 0,
      "IsMandatory": false,
      "IsSelected": false,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": "Provides coverage for loss caused by water that backups through sewers, drains, and discharges or overflows from a sump, sump pump, or related equipment.",
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": "BEN3459^C3",
      "Attributes": [
        {
          "Id": "BEN3459^C3~Limit",
          "Name": "Limit",
          "DisplayName": "Limit",
          "Description": "",
          "ControlType": "DropDown",
          "DataType": "String",
          "UserValue": null,
          "DefaultValue": null,
          "PriorValue": null,
          "Values": [
            "None",
            "$5,000 limit / $500 deductible",
            "$10,000 limit / $500 deductible",
            "$10,000 limit / $1,000 deductible",
            "$25,000 limit / $1,000 deductible",
            "$25,000 limit / $2,500 deductible"
          ],
          "DetailType": null,
          "SourceType": null,
          "SequenceNumber": 0,
          "HelpText": "",
          "IsDirty": false,
          "IsEnabled": true,
          "IsVisible": true,
          "IsActionable": false,
          "IsRequired": true,
          "Format": null,
          "Min": "",
          "Max": "",
          "RuleType": 0,
          "ProductChoicesIndicator": false,
          "UIRuleIndicator": false
        }
      ],
      "IsActionable": true,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": null,
      "IsAdded": false,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 1,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "CoverageCategory": 0
    },
    {
      "Id": "BEN3459^C5",
      "ParentId": null,
      "BusinessEntityId": 3459,
      "OfferId": 988,
      "Name": "RefrigeratedPropertyCoverageEndorsement",
      "Code": "",
      "DisplayName": "Refrigerated Property Coverage",
      "SequenceNumber": 0,
      "IsMandatory": false,
      "IsSelected": false,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": "Covers personal property stored in freezers or refrigerators on the residence premises caused by loss of power to a refrigeration or freezer unit. Coverage applies only if the refrigeration unit is maintained and in working condition immediately prior to the loss.",
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": "BEN3459^C5",
      "Attributes": [
        {
          "Id": "BEN3459^C5~Limit",
          "Name": "Limit",
          "DisplayName": "Limit",
          "Description": "",
          "ControlType": "DropDown",
          "DataType": "String",
          "UserValue": null,
          "DefaultValue": null,
          "PriorValue": null,
          "Values": [],
          "DetailType": null,
          "SourceType": null,
          "SequenceNumber": 0,
          "HelpText": "",
          "IsDirty": false,
          "IsEnabled": true,
          "IsVisible": true,
          "IsActionable": false,
          "IsRequired": true,
          "Format": null,
          "Min": "",
          "Max": "",
          "RuleType": 0,
          "ProductChoicesIndicator": false,
          "UIRuleIndicator": false
        }
      ],
      "IsActionable": true,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": null,
      "IsAdded": false,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 1,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "CoverageCategory": 0
    },
    {
      "Id": "BEN3459^C15",
      "ParentId": null,
      "BusinessEntityId": 3459,
      "OfferId": 988,
      "Name": "ExtendedReplacementCostDwelling",
      "Code": "",
      "DisplayName": "Extended Replacement Cost Dwelling",
      "SequenceNumber": 0,
      "IsMandatory": false,
      "IsSelected": false,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": "Coverage that extends the available limits for the Coverage A Dwelling when the cost to rebuild exceeds the base policy limit.",
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": "BEN3459^C15",
      "Attributes": [
        {
          "Id": "BEN3459^C15~Limit",
          "Name": "Limit",
          "DisplayName": "Limit",
          "Description": "",
          "ControlType": "DropDown",
          "DataType": "String",
          "UserValue": null,
          "DefaultValue": null,
          "PriorValue": null,
          "Values": [],
          "DetailType": null,
          "SourceType": null,
          "SequenceNumber": 0,
          "HelpText": "",
          "IsDirty": false,
          "IsEnabled": true,
          "IsVisible": true,
          "IsActionable": false,
          "IsRequired": true,
          "Format": null,
          "Min": "",
          "Max": "",
          "RuleType": 0,
          "ProductChoicesIndicator": false,
          "UIRuleIndicator": false
        }
      ],
      "IsActionable": true,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": null,
      "IsAdded": false,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 1,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "CoverageCategory": 0
    },
    {
      "Id": "BEN3459^C11",
      "ParentId": null,
      "BusinessEntityId": 3459,
      "OfferId": 988,
      "Name": "CoverageADwelling",
      "Code": "",
      "DisplayName": "A",
      "SequenceNumber": 1,
      "IsMandatory": true,
      "IsSelected": true,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": "Dwelling coverage is the part of a homeowners insurance policy that may help pay to rebuild or repair the physical structure of your home if it's damaged by a covered hazard. Your house and connected structures, such as an attached garage, are typically protected by dwelling coverage.",
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": "BEN3459^C11",
      "Attributes": [
        {
          "Id": "BEN3459^C11~Limit",
          "Name": "Limit",
          "DisplayName": "Coverage A: Dwelling",
          "Description": "",
          "ControlType": "TextArea",
          "DataType": "String",
          "UserValue": "299041.09",
          "DefaultValue": null,
          "PriorValue": null,
          "Values": [],
          "DetailType": null,
          "SourceType": null,
          "SequenceNumber": 0,
          "HelpText": "",
          "IsDirty": false,
          "IsEnabled": true,
          "IsVisible": true,
          "IsActionable": false,
          "IsRequired": true,
          "Format": null,
          "Min": "25000",
          "Max": "1500000",
          "RuleType": 0,
          "ProductChoicesIndicator": false,
          "UIRuleIndicator": false
        }
      ],
      "IsActionable": false,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": null,
      "IsAdded": false,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "CoverageCategory": 0
    },
    {
      "Id": "BEN3459^C4",
      "ParentId": null,
      "BusinessEntityId": 3459,
      "OfferId": 988,
      "Name": "CoverageBOtherStructures",
      "Code": "",
      "DisplayName": "B",
      "SequenceNumber": 2,
      "IsMandatory": true,
      "IsSelected": true,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": "Other structures coverage is the part of a homeowners insurance policy that helps pay to repair or replace structures other than your home, such as a fence.",
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": "BEN3459^C4",
      "Attributes": [
        {
          "Id": "BEN3459^C4~Limit",
          "Name": "Limit",
          "DisplayName": "Coverage B: Other Structures",
          "Description": "",
          "ControlType": "TextArea",
          "DataType": "String",
          "UserValue": "29904.109",
          "DefaultValue": null,
          "PriorValue": null,
          "Values": [],
          "DetailType": null,
          "SourceType": null,
          "SequenceNumber": 0,
          "HelpText": "",
          "IsDirty": false,
          "IsEnabled": true,
          "IsVisible": true,
          "IsActionable": false,
          "IsRequired": true,
          "Format": null,
          "Min": "29904.109",
          "Max": "59808.218",
          "RuleType": 0,
          "ProductChoicesIndicator": false,
          "UIRuleIndicator": false
        }
      ],
      "IsActionable": false,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": null,
      "IsAdded": false,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "CoverageCategory": 0
    },
    {
      "Id": "BEN3459^C13",
      "ParentId": null,
      "BusinessEntityId": 3459,
      "OfferId": 988,
      "Name": "CoverageCPersonalProperty",
      "Code": "",
      "DisplayName": "C",
      "SequenceNumber": 3,
      "IsMandatory": true,
      "IsSelected": true,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": "Coverage for personal belongings like electronics, furniture or clothing inside the home, and in certain occasions, outside the home.",
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": "BEN3459^C13",
      "Attributes": [
        {
          "Id": "BEN3459^C13~Limit",
          "Name": "Limit",
          "DisplayName": "Coverage C: Personal Property",
          "Description": "",
          "ControlType": "TextArea",
          "DataType": "String",
          "UserValue": "149520.545",
          "DefaultValue": null,
          "PriorValue": null,
          "Values": [],
          "DetailType": null,
          "SourceType": null,
          "SequenceNumber": 0,
          "HelpText": "",
          "IsDirty": false,
          "IsEnabled": true,
          "IsVisible": true,
          "IsActionable": false,
          "IsRequired": true,
          "Format": null,
          "Min": "119616.436",
          "Max": "239232.872",
          "RuleType": 0,
          "ProductChoicesIndicator": false,
          "UIRuleIndicator": false
        }
      ],
      "IsActionable": false,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": null,
      "IsAdded": false,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "CoverageCategory": 0
    },
    {
      "Id": "BEN3459^C7",
      "ParentId": null,
      "BusinessEntityId": 3459,
      "OfferId": 988,
      "Name": "CoverageDLossofUse",
      "Code": "",
      "DisplayName": "D",
      "SequenceNumber": 4,
      "IsMandatory": true,
      "IsSelected": true,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": "Coverage for reasonable increases in living expenses, including food and a place to stay, if the home unable to live in as a result of a covered loss.",
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": "BEN3459^C7",
      "Attributes": [
        {
          "Id": "BEN3459^C7~Limit",
          "Name": "Limit",
          "DisplayName": "Coverage D: Loss of Use",
          "Description": "",
          "ControlType": "TextArea",
          "DataType": "String",
          "UserValue": "89712.327",
          "DefaultValue": null,
          "PriorValue": null,
          "Values": [],
          "DetailType": null,
          "SourceType": null,
          "SequenceNumber": 0,
          "HelpText": "",
          "IsDirty": false,
          "IsEnabled": true,
          "IsVisible": true,
          "IsActionable": false,
          "IsRequired": true,
          "Format": null,
          "Min": "89712.327",
          "Max": "119616.436",
          "RuleType": 0,
          "ProductChoicesIndicator": false,
          "UIRuleIndicator": false
        }
      ],
      "IsActionable": false,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": null,
      "IsAdded": false,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "CoverageCategory": 0
    },
    {
      "Id": "BEN3459^C6",
      "ParentId": null,
      "BusinessEntityId": 3459,
      "OfferId": 988,
      "Name": "CoverageEPersonalLiabilityeachoccurrence",
      "Code": "",
      "DisplayName": "E",
      "SequenceNumber": 5,
      "IsMandatory": true,
      "IsSelected": true,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": "Coverage for legal fees or property damages for the insured and resident family members for injuries or property damage to others.",
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": "BEN3459^C6",
      "Attributes": [
        {
          "Id": "BEN3459^C6~Limit",
          "Name": "Limit",
          "DisplayName": "Coverage E: Personal Liability",
          "Description": "",
          "ControlType": "DropDown",
          "DataType": "String",
          "UserValue": "300000",
          "DefaultValue": null,
          "PriorValue": null,
          "Values": [
            "$100,000",
            "$200,000",
            "$300,000",
            "$400,000",
            "$500,000"
          ],
          "DetailType": null,
          "SourceType": null,
          "SequenceNumber": 0,
          "HelpText": "",
          "IsDirty": false,
          "IsEnabled": true,
          "IsVisible": true,
          "IsActionable": false,
          "IsRequired": true,
          "Format": null,
          "Min": "100000",
          "Max": "500000",
          "RuleType": 0,
          "ProductChoicesIndicator": false,
          "UIRuleIndicator": false
        }
      ],
      "IsActionable": false,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": null,
      "IsAdded": false,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "CoverageCategory": 0
    },
    {
      "Id": "BEN3459^C14",
      "ParentId": null,
      "BusinessEntityId": 3459,
      "OfferId": 988,
      "Name": "CoverageFMedicalPaymentstoOtherseachperson",
      "Code": "",
      "DisplayName": "F",
      "SequenceNumber": 6,
      "IsMandatory": true,
      "IsSelected": true,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": null,
      "HelpText": "",
      "IsDirty": false,
      "DetailedXml": null,
      "CoverageId": "BEN3459^C14",
      "Attributes": [
        {
          "Id": "BEN3459^C14~Limit",
          "Name": "Limit",
          "DisplayName": "Coverage F: Medical Payments",
          "Description": "",
          "ControlType": "DropDown",
          "DataType": "String",
          "UserValue": "3000",
          "DefaultValue": null,
          "PriorValue": null,
          "Values": [
            "$1,000",
            "$2,000",
            "$3,000",
            "$4,000",
            "$5,000"
          ],
          "DetailType": null,
          "SourceType": null,
          "SequenceNumber": 0,
          "HelpText": "",
          "IsDirty": false,
          "IsEnabled": true,
          "IsVisible": true,
          "IsActionable": false,
          "IsRequired": true,
          "Format": null,
          "Min": "1000",
          "Max": "5000",
          "RuleType": 0,
          "ProductChoicesIndicator": false,
          "UIRuleIndicator": false
        }
      ],
      "IsActionable": false,
      "Symbols": null,
      "HasCoachingContent": false,
      "Fields": null,
      "IsAdded": false,
      "IsDeleted": false,
      "IsNewlyAdded": false,
      "IsNewlyDeleted": false,
      "RuleType": 0,
      "ProductChoicesIndicator": false,
      "UIRuleIndicator": false,
      "CoverageCategory": 0
    }
  ]
}