Get list of recurring event schedule

This API is used to get a list of a recurring event schedule. If the event is recurring, it will give results as a list of the recurring events. If the event is not recurring, it will return an empty result.

Path Parameters
Not Required

Body Parameters
Not Required

Response
Details / Check response object

Authentication required - ✅

Role wise accessibility 

Super Admin - ✅
Organizer Admin - ✅
Staff - ❌
Attendee - ❌
Exhibitor - ❌
Speaker - ❌

Modules
Display - ❌
Portal - ❌
Host - ✅

if the event is recurring then it will return a response in JSON format, Below you can find the description of each response attribute.

Attributes

Description

startTime

This contains the start time of the event

endTime

This contains the end time of the event

occursFrom

This contains the date the event started.

occursUntil

This contains the date the event will end.

id

This contains the id for a recurring event

frequency

This contains the frequency of the recurring event.
(i.e. daily, weekly, monthly)

dayOfMonth

This contains the day of the month on which a recurring event is scheduled if the frequency is monthly.
(i.e. every 1st of the month).

weekOfMonth

This contains the week of the month on which recurring event is scheduled if the frequency is monthly.
(i.e. 1st week of the month).

daysOfWeek

This contains the day on which recurring event is scheduled if the frequency is weekly or monthly.
(i.e. Sunday)

endTimeOnXDays

This contains the number of days between two recurring events

totalDaysCount

This contains the total number of days for the recurring event

soldTickets

This contains a boolean value (true or false) for if tickets are sold or not.

soldDate

This contains the date when the ticket is sold.

recurringEventResDtos

This will contain an array of objects which contain information regarding a specific event day.

This will contain below attributes:

endTime, id, location, occursFrom, occursUntil,
remainingTicketCount, scheduleId,
soldTicketCount, soldTickets, startTime.

The function of these attributes is the same as they were defined before in this table, except these are for a specific event day.

Below, you can find the description of the possible error messages, which are returned.

Error Code

Error Description

4030201

Not Event Host

401

Not authorize to access

Language
Authentication
Header
Click Try It! to start a request and see the response here!