OpenActive Developers
Data ValidatorDataset DashboardW3C Community Group
Search…
Welcome to our community
Publishing Data
Data Feeds
Activity list references
Including geo coordinates
Schedules
Dataset Sites
Virtual Events
On-Demand Events
Opening Hours
Using data
Harvesting opportunity data
Open Booking API
Implementing booking
Testing booking
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 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
PartialSchedule
This page describes the PartialSchedule type.
This type is derived from https://pending.schema.org/Schedule, 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
​Text​
Must always be present and set to "@type": "PartialSchedule"
Property
Expected Type
Description
endTime
​Time​
The end time of the event.
Example
"endTime": "12:00:00"
repeatFrequency
​Duration​
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"
startTime
​Time​
The start time of the event.
Example
"startTime": "12:00:00"

Optional properties

Property
Expected Type
Description
byDay
Array of DayOfWeek - or - Array of Text​
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
Array of Integer​
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
Array of Integer​
Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31
Example
"byMonthDay": [ 28 ]
duration
​Duration​
The duration of the event given in [ISO8601] format.
Example
"duration": "PT1H"
endDate
​Date​
The end date of the schedule.
Example
"endDate": "2018-01-27"
exceptDate
Array of Date - or - Array of DateTime​
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
​Integer​
Defines the number of times a recurring Event will take place.
Example
"repeatCount": 3
scheduleTimezone
​Text​
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"
startDate
​Date​
The start date of the event.
Example
"startDate": "2018-01-27"

Beta Extension properties

These properties are defined in the OpenActive Beta Extension. 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.
Property
Expected Type
Description
beta:timeZone
​Text​
DEPRECATED: Please use scheduleTimezone instead.
​Proposal #197​
The time zone used to generate occurrences, same as iCal TZID. E.g. 'Europe/London'.
beta:timeZone
​Text​
DEPRECATED: Please use scheduleTimezone instead.
​Proposal #197​
The time zone used to generate occurrences, same as iCal TZID. E.g. 'Europe/London'.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution License (CC-BY V4.0), and code samples are licensed under the MIT License, for anyone to access, use and share; using attribution "OpenActive".
Previous
Parking
Next
Payment
Last modified 1d ago
Copy link
Edit on GitHub
Contents
Properties
Required properties
Recommended properties
Optional properties
Beta Extension properties