Benefit Schedule Sessions Preview (POST)
Create a preview of the benefit scheduling session. Users can preview the benefit sessions before they are created.
57.0
POST
<PreviewBenefitSessionInputRepresentation>
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
benefitScheduleName | String | The name of the benefit schedule. | Required | 57.0 |
firstSessionEndDate | String | The date and time when the first session ends in the benefit schedule. | Required | 57.0 |
firstSessionStartDate | String | The date and time when the first session starts in the benefit schedule. | Required | 57.0 |
mode | String | The mode of the benefit schedule. The dryRun mode indicates that no data is created. | Optional | 57.0 |
noOfSessions | Integer | The maximum number of participants in a session. Default value is 5. | Optional | 57.0 |
scheduleDays | Integer | The number of days in a week when the benefit schedule is executed. | Optional | 57.0 |
scheduleEndDate | String | The date when the benefit schedule ends. | Optional | 57.0 |
scheduleFrequency | String | The frequency at which the benefit schedule is executed. | Optional | 57.0 |
totalRecurrencesCount | Integer | The number of times the benefit schedule is executed. | Optional | 57.0 |