This method allows you to add Schedule item.

/api/v1/forms/AddScheduleItem/{offerId}/{lobName}/{state}/{businessEntityId}/{userId}/{template}

Path Parameters

• offerId Integer Required

  Unique identifier of Offer.

• lobName String Required

  Name of Line of Business.

• state String Required

  Name of the State.

• businessEntityId Integer Required

  Unique identifier of Business Entity.

• userId Integer Required

  User who adds Schedules.

• template String Required

  Template name for Product.

Request Body Parameters

• FormId String

  Form ID of Schedule.

• CorrelationId String

  Correlation ID of form.

• ScheduleName String

  Schedule name of form.

• Code String

  Code of Schedule.

Response

• Id String

  Unique identifier of Schedule.

• Code String

  Code of Schedule.

• Mode Enum

  It 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 Enum

  Form type of Schedule.

• StateName String

  State name of Schedule.

• Cardinality Enum

  It 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

  • Id String

    ID of Schedule data.

  • Name String

    Name of Schedule Data.

  • DisplayName String

    Display name of Schedule Data.

  • DomainTableName String

    Domain table name for a field.

  • IsMandatory Boolean

    Indicates whether the field is mandatory or not.

  • SequenceNumber Integer

    It indicates sequence number of fields.

  • HelpText String

    It is used to display Schedule field information on UI.

  • OnChangeAction Boolean

    Used to perform any iSolver call.

  • Min String

    Min value of a field.

  • Max String

    Max value of a field.

  • DataType Integer

    DataType of a field i.e., Integer, String , or Boolean.

  • Type Enum

    It Indicates ControlType of a field i.e., textbox, DropDown, DateTime, CheckBox.

  • sourcetype Enum

    Displays as UserInput derived for field.

  • Format String

    Displays Currency, Percentage, or alphanumeric.

  • FactorGroupName String

    Factor group 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 field is visible or not.

  • Value String

     Value for a field.

  • Values List<String>

     List of values for field.

  • RuleType Enum

     It indicates 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

  Schedule coverages for Schedule.

• Field Object

  Child Attributes

  • Title String

    Title for Field.

  • SequenceNumber Integer

    Sequence number for a field.

  • FullPath String

    Indicates the full path of a Schedule.

 {
    "FormId": "BEN37^CommercialPropertyOptionalForm1",
    "CorrelationId": "7db5c982-c852-4fb6-ace0-b8db6302c0b4",
    "ScheduleName": "CommercialPropertyOptionalForm1Schedule",
    "Code": null
}

{
  "AgentID": 0,
  "AgentName": "string",
  "AgentCode": "string",
  "AgencyID": 0,
  "AgencyName": "string",
  "AgencyCode": "string",
  "UnderwriterName": "string",
  "CurrentluAssignedTo": 0,
  "Status": "string",
  "AccountId": 0,
  "AccountName": "string",
  "AccountDisplayName": "string",
  "Products": [
    {
      "ID": 0,
      "ProductName": "string"
    }
  ],
  "Narrative": "string",
  "TotalRecords": 0,
  "StatusSubmission": 0,
  "IsDirty": true,
  "ID": 0,
  "Code": "string",
  "CreatedBy": "string",
  "ModifiedBy": "string",
  "CreatedDate": "2021-08-24T08:16:25.174Z",
  "ModifiedDate": "2021-08-24T08:16:25.174Z",
  "IsLikeSearch": true
}