Preview Benefit Session Input

Input representation of the benefit scheduling session preview request.

Root XML Tag

<PreviewBenefitSessionInputRepresentation>

JSON Example

1{
2  "benefitScheduleName": "Nov Weekday schedule",
3  "firstSessionStartDate": "2022-11-14T14:30:00.000",
4  "firstSessionEndDate": "2022-11-14T15:00:00.000",
5  "scheduleFrequency": "Weekly",
6  "scheduleDays": 96,
7  "mode": "dryRun",
8  "noOfSessions": 5,
9  "totalRecurrencesCount": 10
10}

Properties

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