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>

NameTypeDescriptionRequired or OptionalAvailable Version
benefitScheduleNameStringThe name of the benefit schedule.Required57.0
firstSessionEndDateStringThe date and time when the first session ends in the benefit schedule.Required57.0
firstSessionStartDateStringThe date and time when the first session starts in the benefit schedule.Required57.0
modeStringThe mode of the benefit schedule. The dryRun mode indicates that no data is created.Optional57.0
noOfSessionsIntegerThe maximum number of participants in a session. Default value is 5.Optional57.0
scheduleDaysIntegerThe number of days in a week when the benefit schedule is executed.Optional57.0
scheduleEndDateStringThe date when the benefit schedule ends.Optional57.0
scheduleFrequencyStringThe frequency at which the benefit schedule is executed.Optional57.0
totalRecurrencesCountIntegerThe number of times the benefit schedule is executed.Optional57.0

Preview Benefit Sessions Output