Guidance for virtual and on-demand events

[nickevansuk]

Proposer

ODI

Use Case

Taking into account the proposed properties, guidance is required for implementers to know which properties are required vs recommended.

Proposal

For virtual events

SessionSeries and Event

The following properties should be REQUIRED (inheriting from existing Modelling Opportunity Data specification):

• name
• activity
• organizer (including a required @id to give each organizer a globally unique identifier as a URL, and recommended sameAs property for social media handles)
• eventAttendanceMode (#225)
• offers (including a recommended url that links straight to the purchase page)
• url (to a page describing the session)

The following properties should be RECOMMENDED:

• description
• image
• level (#82) - using the string "Beginner" for beginner friendly classes
• ageRange
• genderRestriction
• beta:isFirstSessionAccessibleForFree (#232)
• beta:isInteractivityPreferred (#230)
• beta:participantSuppliedEquipment (#229)
• beta:affiliatedLocation (#227)
• maximumVirtualAttendeeCapacity (#226)
• beta:donationPaymentUrl (#234)

ScheduledSession and Event

The following properties should be REQUIRED (inheriting from existing Modelling Opportunity Data specification):

• startDate

The following properties should be RECOMMENDED:

• duration
• endDate
• beta:virtualLocation (#224) (including a url to the live class itself, e.g. a Facebook Live or Zoom URL)

Example

Note full guidance will include the above fields, and individual ScheduledSessions.

{
  "type": "SessionSeries",
  ...
  "eventAttendanceMode": "https://schema.org/OnlineEventAttendanceMode",
  "beta:affiliatedLocation": {
    "type": "Place",
    "name": "Middlesbrough Sports Village",
    "address": {
      "type": "PostalAddress",
      "streetAddress": "Alan Peacock Way",
      "addressLocality": "Village East",
      "addressRegion": "Middlesbrough",
      "postalCode": "TS4 3AE",
      "addressCountry": "GB"
    },
    "geo": {
      "type": "GeoCoordinates",
      "latitude": 54.543964,
      "longitude": -1.20978500000001
    }
  },
  "beta:isInteractivityPreferred": true,
  "beta:participantSuppliedEquipment": "https://openactive.io/Required",
  "beta:donationPaymentUrl": "https://www.paypal.com/donate/acme_fit"
}

{
  "type": "ScheduledSession",
  ...
  "maximumVirtualAttendeeCapacity": 20,
  "beta:virtualLocation": {
    "type": "VirtualLocation",
    "name": "Zoom Video Chat",
    "url": "https://zoom.us/j/1234567890/signup",
    "description": "Please log into Zoom a few minutes before the event, and mute your mic while you wait for the session to start"
  }
}

For on-demand events

OnDemandEvent (#228)

The following properties should be REQUIRED:

• name
• activity
• organizer (including a required @id to give each organizer a globally unique identifier as a URL, and recommended sameAs property for social media handles)
• offers (including a recommended url that links straight to the purchase page)
• url (to a page describing the session)

The following properties should be RECOMMENDED:

• duration
• description
• image
• level (#82) - using the string "Beginner" for beginner friendly classes
• ageRange
• genderRestriction
• beta:isFirstSessionAccessibleForFree (#232)
• beta:participantSuppliedEquipment (#229)
• beta:donationPaymentUrl (#234)
• workFeatured (#228)

Example

{
  "type": "OnDemandEvent",
  ...

  "workFeatured": {
    "type": "VideoObject",
    "url": "https://www.youtube.com/watch?v=3fbCs0GVjgQ"
  },
  "beta:participantSuppliedEquipment": "https://openactive.io/Required",
  "beta:donationPaymentUrl": "https://www.paypal.com/donate/acme_fit"
}

[nickevansuk]

Note genderRestriction was accidentally omitted from the recommended properties in the discussion today, so have added above in line with the existing status of the same property in the Modelling Opportunity Data specification.

[nickevansuk]

Note the proposal above has been updated to reflect the revised nomenclature from the referenced issues.

[nickevansuk]

Note that the above has now been updated to include https://github.com/openactive/modelling-opportunity-data/issues/234

[nickevansuk]

Noting the expedited addition of the required field organizer @id, to pave the way for both safeguarding and booking of virtual events