DeleteScheduleItem

This method allows you to delete the Schedule item.

/api/v1/forms/deleteSchedule/{offerId}/{lobName}/{state}

Path Parameters

  • offerId Integer Required

    Unique identifier of Offer.

  • lobName String Required

    Name of Line of Business.

  • state String Required

    Name of the State.

Request Body Parameters

  • Id String

    ID of Schedule.

  • Code String

    Code of Schedule.

  • Mode Enum

    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 Boolean if Schedule is mandatory.

  • CoverageType String

    Coverage type of schedule.

  • FormType Enum

    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

  • Fields Object

    • 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

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

    • Type TextBox

      It indicates Control Type of a field i.e., textbox, DropDown, DateTime, CheckBox.

    • sourcetype Enum

      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

      Display any validation.

    • 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 make the field visible.

    • 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

      It 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

    • Id String

      Id of Schedule coverage.

    • ParentId Integer

      Parent Id of Schedule coverage.

    • BusinessEntityId Integer

      Business Entity ID 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 number 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 enable.

    • 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

      • 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 number 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 on attributes.

    • Symbols Object

      • 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

        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

        Used to check validations of Symbol.

    • Fields Object

      • 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

        Used to perform any isolver call.

      • Min String

        Min value of field.

      • Max String

        Max value of field.

      • DataType String

        Datatype 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

        Set as true when field is enabled.

      • MaxLength Integer

        Max length of field.

      • IsVisible Boolean

        Set as true if field ID is 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

        Full path of section.

  • ScheduleFields Object

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

Response

  • Status Boolean

    Returns true if the Form Schedule is deleted.

Request
 {
  "Id": "string",
  "Code": "string",
  "Mode": "Add",
  "Name": "string",
  "DisplayName": "string",
  "Output": "string",
  "HelpText": "string",
  "IsMandatory": true,
  "CoverageType": "string",
  "FormType": "Mandatory",
  "StateName": "string",
  "Cardinality": "Single",
  "FormNumber": "string",
  "FormId": "string",
  "ScheduleDetalXML": "string",
  "ScheduleData": [
    {}
  ],
  "Fields": [
    {
      "Id": "string",
      "Name": "string",
      "DisplayName": "string",
      "DomainTableName": "string",
      "IsMandatory": true,
      "SequenceNumber": 0,
      "IsDeviation": true,
      "IsRequest": true,
      "HelpText": "string",
      "OnChangeAction": true,
      "Min": "string",
      "Max": "string",
      "DataType": "string",
      "Type": "TextBox",
      "sourcetype": "Independent",
      "Format": "string",
      "FactorGroupName": "string",
      "ParentGroupName": "string",
      "DefaultValue": "string",
      "RegexValidation": "string",
      "IsEnabled": true,
      "MaxLength": 0,
      "IsVisible": true,
      "Value": "string",
      "Values": [
        "string"
      ],
      "Keys": [
        "string"
      ],
      "RuleType": "None",
      "ProductChoicesIndicator": true,
      "UIRuleIndicator": true
    }
  ],
  "ScheduleCoverages": [
    {
      "Id": "string",
      "ParentId": 0,
      "BusinessEntityId": 0,
      "OfferId": 0,
      "Name": "string",
      "Code": "string",
      "DisplayName": "string",
      "SequenceNumber": 0,
      "IsMandatory": true,
      "IsSelected": true,
      "IsEnabled": true,
      "IsVisible": true,
      "Type": "string",
      "HelpText": "string",
      "IsDirty": true,
      "DetailedXml": "string",
      "CoverageId": "string",
      "Attributes": [
        {
          "Id": "string",
          "Name": "string",
          "DisplayName": "string",
          "Description": "string",
          "ControlType": "string",
          "DataType": "string",
          "UserValue": "string",
          "DefaultValue": "string",
          "PriorValue": "string",
          "Values": [
            "string"
          ],
          "DetailType": "string",
          "SourceType": "string",
          "SequenceNumber": 0,
          "HelpText": "string",
          "IsDirty": true,
          "IsEnabled": true,
          "IsVisible": true,
          "IsActionable": true,
          "IsRequired": true,
          "Format": "string",
          "Min": "string",
          "Max": "string",
          "RuleType": "None",
          "ProductChoicesIndicator": true,
          "UIRuleIndicator": true,
          "MaxLength": 0,
          "RegexValidation": "string"
        }
      ],
      "IsActionable": true,
      "Symbols": [
        {
          "Id": "string",
          "Name": "string",
          "DisplayName": "string",
          "Description": "string",
          "ControlType": "string",
          "DataType": "string",
          "UserValue": "string",
          "DefaultValue": "string",
          "PriorValue": "string",
          "Values": [
            "string"
          ],
          "DetailType": "string",
          "SourceType": "string",
          "SequenceNumber": 0,
          "HelpText": "string",
          "IsDirty": true,
          "IsEnabled": true,
          "IsVisible": true,
          "IsActionable": true,
          "IsRequired": true,
          "Format": "string",
          "Min": "string",
          "Max": "string",
          "RuleType": "None",
          "ProductChoicesIndicator": true,
          "UIRuleIndicator": true,
          "MaxLength": 0,
          "RegexValidation": "string"
        }
      ],
      "HasCoachingContent": true,
      "Fields": [
        {
          "Id": "string",
          "Name": "string",
          "DisplayName": "string",
          "DomainTableName": "string",
          "IsMandatory": true,
          "SequenceNumber": 0,
          "IsDeviation": true,
          "IsRequest": true,
          "HelpText": "string",
          "OnChangeAction": true,
          "Min": "string",
          "Max": "string",
          "DataType": "string",
          "Type": "TextBox",
          "sourcetype": "Independent",
          "Format": "string",
          "FactorGroupName": "string",
          "ParentGroupName": "string",
          "DefaultValue": "string",
          "RegexValidation": "string",
          "IsEnabled": true,
          "MaxLength": 0,
          "IsVisible": true,
          "Value": "string",
          "Values": [
            "string"
          ],
          "Keys": [
            "string"
          ],
          "RuleType": "None",
          "ProductChoicesIndicator": true,
          "UIRuleIndicator": true
        }
      ],
      "IsAdded": true,
      "IsDeleted": true,
      "IsNewlyAdded": true,
      "IsNewlyDeleted": true,
      "RuleType": "None",
      "ProductChoicesIndicator": true,
      "UIRuleIndicator": true,
      "FullPath": "string"
    }
  ],
  "ScheduleFields": [
    {
      "Field": "string",
      "Title": "string",
      "SequenceNumber": 0
    }
  ],
  "IsVisible": true,
  "SequenceNumber": 0,
  "FullPath": "string",
  "UIRuleIndicator": true
}
Response 
 True