The API allows you to retrieve Forms.

/api/v1/forms/get/{offerId}/{lobName}/{state}/{userId}/{template}

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

• userId Integer Required

  User ID of Form.

• template String Required

  Name of the template for Line of Business.

Response

• Id String

  Unique identifier of form.

• Name String

  Name of the form.

• DisplayName String

  Display name of form.

• Number String

  Indicates form number.

• SequenceNumber Integer

  Sequence number of forms.

• Type String

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

• IsSelected Boolean

  Indicates whether the form is selected or not.

• IsVisible Boolean

  Indicates whether the form is visible on UI or not.

• State String

  State name of form.

• RiskType String

  Risk type of form.

• RequireAdditionalDetails Boolean

  Indicates whether the form has any additional details or not.

• IsSubmit Boolean

  Indicates whether the form is submitted or not.

• IsAdded Boolean

  Indicates whether the form is added or not.

• IsDeleted Boolean

  Indicates whether the form is deleted or not.

• IsPolicyForm Boolean

  Indicates whether the form is policy level or not.

• EditionDate String

  Edition date of form.

• RuleType Enum

  Indicates whether form is UIRuleIndicator or ProductChoicesIndicator.

• ProductChoicesIndicator Boolean

  Indicates whether the form is ProductChoicesIndicator or not.

• UIRuleIndicator Boolean

  Indicates whether the form is UIRuleIndicator or not.

• PremiumBearing String

  Premium bearing of form.

• RiskIds List<String>

  Risk IDs of form.

 {
  "Id": "BEN512121^CommercialPropertyZzDisclosurePursuantToTerrorismRiskInsAct2002",
  "Name": "CommercialPropertyZzDisclosurePursuantToTerrorismRiskInsAct2002",
  "DisplayName": "Disclosure Pursuant To Terrorism Risk Insurance Act",
  "Number": "IL 09 85",
  "SequenceNumber": 1750,
  "Type": "Mandatory",
  "DocUrl": null,
  "IsSelected": true,
  "IsVisible": true,
  "State": [
      "OK"
  ],
  "RiskType": [{
    "RiskType": "CommercialProperty",
    "DisplayName": "CommercialProperty"
      }
  ],
  "RequireAdditionalDetails": true,
  "IsSubmit": true,
  "IsAdded": true,
  "IsDeleted": false,
  "IsPolicyForm": true,
  "EditionDate": "01 15",
  "RuleType": 0,
  "ProductChoicesIndicator": false,
  "UIRuleIndicator": false,
  "PremiumBearing": "Yes",
  "RiskIds": null
    }
]