Appearance
Schedule ​
Status: Pending
Breadcrumb: Thing > Intangible > Schedule
A schedule defines a repeating time period used to describe a regularly occurring Event. At a minimum a schedule will specify repeatFrequency which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely. This includes identifying the day(s) of the week or month when the recurring event will take place, in addition to its start and end time. Schedules may also have start and end dates to indicate when they are active, e.g. to define a limited calendar of events.
Parent types ​
Properties ​
Properties for Schedule ​
| Property | Expected type | Defined on | Description |
|---|---|---|---|
| byDay | DayOfWeek, Text | Schedule | Defines the day(s) of the week on which a recurring Event takes place. May be specified using either DayOfWeek, or alternatively Text conforming to iCal's syntax for byDay recurrence rules. |
| byMonth | Integer | Schedule | Defines the month(s) of the year on which a recurring Event takes place. Specified as an Integer between 1-12. January is 1. |
| byMonthDay | Integer | Schedule | Defines the day(s) of the month on which a recurring Event takes place. Specified as an Integer between 1-31. |
| byMonthWeek | Integer | Schedule | Defines the week(s) of the month on which a recurring Event takes place. Specified as an Integer between 1-5. For clarity, byMonthWeek is best used in conjunction with byDay to indicate concepts like the first and third Mondays of a month. |
| duration | Duration, QuantitativeValue | Schedule | The duration of the item (movie, audio recording, event, etc.) in ISO 8601 duration format. |
| endDate | Date, DateTime | Schedule | The end date and time of the item (in ISO 8601 date format). |
| endTime | DateTime, Time | Schedule | The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
| exceptDate | Date, DateTime | Schedule | Defines a Date or DateTime during which a scheduled Event will not take place. The property allows exceptions to a Schedule to be specified. If an exception is specified as a DateTime then only the event that would have started at that specific date and time should be excluded from the schedule. If an exception is specified as a Date then any event that is scheduled for that 24 hour period should be excluded from the schedule. This allows a whole day to be excluded from the schedule without having to itemise every scheduled event. |
| repeatCount | Integer | Schedule | Defines the number of times a recurring Event will take place. |
| repeatFrequency | Duration, Text | Schedule | Defines the frequency at which Events will occur according to a schedule Schedule. The intervals between events should be defined as a Duration of time. |
| scheduleTimezone | Text | Schedule | 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. |
| startDate | Date, DateTime | Schedule | The start date and time of the item (in ISO 8601 date format). |
| startTime | DateTime, Time | Schedule | The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
Inherited properties ​
| Property | Expected type | Inherited from | Description |
|---|---|---|---|
| additionalType | Text, URL | Thing | An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide. |
| alternateName | Text | Thing | An alias for the item. |
| description | Text, TextObject | Thing | A description of the item. |
| disambiguatingDescription | Text | Thing | A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation. |
| identifier | PropertyValue, Text, URL | Thing | The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details. |
| image | ImageObject, URL | Thing | An image of the item. This can be a URL or a fully described ImageObject. |
| mainEntityOfPage | CreativeWork, URL | Thing | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
| name | Text | Thing | The name of the item. |
| owner | Organization, Person | Thing | A person or organization who owns this Thing. |
| potentialAction | Action | Thing | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
| sameAs | URL | Thing | URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. |
| subjectOf | CreativeWork, Event | Thing | A CreativeWork or Event about this Thing. |
| url | URL | Thing | URL of the item. |
Example ​
json
{
"@context": "https://schema.org",
"@type": "Schedule",
"name": "Example Name",
"description": "A short description.",
"url": "/example",
"byDay": "Example value",
"byMonth": "Example value"
}