Schedule Time Frame Object


Information about the start and end dates of the first and last events that belong to a schedule and whether any events follow an unlimited repetition pattern.

Properties
idstringRead-onlyformat GUID

ID of the schedule to which the time frame belongs.


statusstringRead-only

Information about the presence of recurring events within the schedule.

Supported values:

  • NONE: No events are scheduled within the schedule.
  • FINITE: All recurring events within the schedule have a defined end date, or there are no recurring events.
  • INFINITE: At least one recurring event within the schedule has no end date, meaning it follows an unlimited repetition pattern.

firstEventStartDateFirstEventStartDateRead-only

Start date of the first event within the schedule. Identical to event.start.localDate. Available only if status is set to FINITE or INFINITE.


lastEventEndDateLastEventEndDateRead-only

End date of the last event belonging to the schedule. Identical to event.end.localDate. Available only if status is set to FINITE.


adjustedFirstEventStartDateAdjustedFirstEventStartDateRead-only

Start date of the first event belonging to the schedule, adjusted to timeZone of the site properties or the timeZone specified in the request. Identical to event.adjustedStart.localDate.


adjustedLastEventEndDateAdjustedLastEventEndDateRead-only

End date of the last event belonging to the schedule, adjusted to timeZone of the site properties or the timeZone specified in the request. Identical to event.adjustedEnd.localDate.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the schedule time frame is updated.

ScheduleTimeFrame
JSON
{ "id": "05279386-2859-49d6-9727-0096ad74e014", "status": "FINITE", "firstEventStartDate": { "localDate": "2024-09-24T16:30:00", "timeZone": "Europe/Dublin", "utcDate": "2024-09-24T15:30:00Z" }, "lastEventEndDate": { "localDate": "2024-11-27T17:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-11-27T17:00:00Z" }, "adjustedFirstEventStartDate": { "localDate": "2024-09-24T16:30:00", "timeZone": "Europe/Dublin" }, "adjustedLastEventEndDate": { "localDate": "2024-11-27T17:00:00", "timeZone": "Europe/Dublin" }, "revision": "15" }
Did this help?