OpenActive Developers
Data ValidatorDataset DashboardW3C Community Group
  • Welcome to our community
  • Publishing Data
    • Data Feeds
      • How an RPDE data feed works
      • Types of RDPE feed
      • Implementing RPDE
      • Testing RPDE feeds
      • Scaling RPDE feeds
    • Activity list references
    • Including geo coordinates
    • Schedules
    • Dataset Sites
    • Virtual Events
    • On-Demand Events
    • Opening Hours
    • Data Quality
  • Using data
    • Harvesting opportunity data
      • Large Integers in JavaScript
    • Tutorial: Consuming an RPDE feed
    • Attribution
  • Open Booking API
    • Key Decisions
    • Implementing booking
    • Testing booking
      • Configuring Test Suite
      • Implementing the Test Interface
        • Test Interface Actions
        • Create Opportunity Endpoint
      • Random Mode: Generating Test Opportunity Data
      • Running Test Suite
      • Generating the Conformance Certificate
  • Data Model
    • Data Model Overview
    • @context and JSON-LD
    • Types Reference
      • Action
      • AudioObject
      • BabyChanging
      • Barcode
      • BookingService
      • BooleanFormFieldSpecification
      • Brand
      • ChangingFacilities
      • ConceptScheme
      • Concept
      • CourseInstance
      • Course
      • Creche
      • CustomerAccount
      • DataCatalog
      • DataDownload
      • Dataset
      • DropdownFormFieldSpecification
      • DynamicPayment
      • Entitlement
      • EventSeries
      • Event
      • FacilityUse
      • FileUploadFormFieldSpecification
      • GeoCoordinates
      • HeadlineEvent
      • ImageObject
      • IndividualFacilityUse
      • InternalApplicationError
      • InternalLibraryConfigurationError
      • InternalLibraryError
      • Lease
      • LocationFeatureSpecification
      • Lockers
      • MediaObject
      • OfferOverride
      • Offer
      • OnDemandEvent
      • OpenBookingError
      • OpeningHoursSpecification
      • OrderItem
      • OrderProposal
      • OrderQuote
      • Order
      • Organization
      • ParagraphFormFieldSpecification
      • Parking
      • PartialSchedule
      • Payment
      • Person
      • Place
      • PostalAddress
      • PriceSpecification
      • PrivacyPolicy
      • PropertyValueSpecification
      • PropertyValue
      • QuantitativeValue
      • Schedule
      • ScheduledSession
      • SessionSeries
      • ShortAnswerFormFieldSpecification
      • Showers
      • Slot
      • SportsActivityLocation
      • TaxChargeSpecification
      • TermsOfUse
      • Terms
      • Toilets
      • Towels
      • VideoObject
      • VirtualLocation
      • WebAPI
  • Specifications
    • Specifications Overview
  • Useful links
    • Data Visualiser
    • Data Validator
    • Dataset Dashboard
    • Non-technical Guidance
  • OpenActive on GitHub
    • Overview
    • Activity List
    • Community
    • Controlled Vocabularies
    • Dataset Publication
    • Documentation
    • Implementation Support
    • Programmes
    • RPDE
    • SKOS
    • Specifications
    • Validators
Powered by GitBook
On this page
  • Properties
  • Required properties
  • Required options
  • Recommended properties
  • Optional properties
  • Beta Extension properties
Edit on GitHub
  1. Data Model
  2. Types Reference

Schedule

This page describes the Schedule type.

PreviousQuantitativeValueNextScheduledSession

Last updated 11 months ago

This type is derived from , which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.

Properties

Required properties

Property
Expected Type
Description

@type

Must always be present and set to "@type": "Schedule"

endTime

The end time of the event.

Example

"endTime": "12:00:00"

scheduleTimezone

Indicates the timezone for which the time(s) indicated in the Schedule are given. The value provided should be among those listed in the IANA Time Zone Database.

Example

"scheduleTimezone": "Europe/London"

scheduledEventType

The type of event this schedule related to.

Example

"scheduledEventType": "Event"

startTime

The start time of the event.

Example

"startTime": "12:00:00"

Required options

While these properties are marked as optional, a data publisher must provide either a byDay, byMonth, byMonthDay or repeatFrequency for a schedule.

Property
Expected Type
Description

byDay

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.

Example

"byDay": [ "https://schema.org/Monday" ]

byMonth

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.

Example

"byMonth": [ 2 ]

byMonthDay

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31

Example

"byMonthDay": [ 28 ]

repeatFrequency

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.

Example

"repeatFrequency": "P1D"

Recommended properties

Property
Expected Type
Description

duration

The duration of the event given in [ISO8601] format.

Example

"duration": "PT1H"

endDate

The end date of the schedule.

Example

"endDate": "2018-01-27"

idTemplate

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule. This property is required if the data provider is supporting third-party booking via the Open Booking API, or providing complimentary individual subEvents.

Example

"idTemplate": "https://api.example.org/session-series/123/{startDate}"

startDate

The start date of the event.

Example

"startDate": "2018-01-27"

urlTemplate

An RFC6570 compliant URI template that can be used to generate a unique url for every event described by the schedule. This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.

Example

"urlTemplate": "https://example.org/session-series/123/{startDate}"

Optional properties

Property
Expected Type
Description

exceptDate

Exception dates where the schedule should not generate an event.

Example

"exceptDate": [ "2016-04-13T17:10:00Z", "2016-09-14T17:10:00Z", "2016-12-14T18:10:00Z", "2016-12-21T18:10:00Z", "2016-12-28T18:10:00Z", "2017-01-04T18:10:00Z" ]

repeatCount

Defines the number of times a recurring Event will take place.

Example

"repeatCount": 3

Beta Extension properties

Property
Expected Type
Description

beta:timeZone

DEPRECATED: Please use scheduleTimezone instead.

The time zone used to generate occurrences, same as iCal TZID. E.g. 'Europe/London'.

Array of - or - Array of

Array of

Array of

Array of - or - Array of

These properties are defined in the . The OpenActive Beta Extension is defined as a convenience to help document properties that are in active testing and review by the community. Publishers should not assume that properties in the beta namespace will either be added to the core specification or be included in the namespace over the long term.

Except as otherwise noted, the content of this page is licensed under the , and code samples are licensed under the , for anyone to access, use and share; using attribution "".

https://pending.schema.org/Schedule
OpenActive Beta Extension
Creative Commons Attribution License (CC-BY V4.0)
MIT License
OpenActive
Text
Time
Text
Text
Time
DayOfWeek
Text
Integer
Integer
Duration
Duration
Date
Text
Date
Text
Date
DateTime
Integer
Text
Proposal #197