Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Requires home / personal equipment #229

Open
nishaldesai opened this issue Mar 24, 2020 · 4 comments
Open

Requires home / personal equipment #229

nishaldesai opened this issue Mar 24, 2020 · 4 comments

Comments

@nishaldesai
Copy link

@nishaldesai nishaldesai commented Mar 24, 2020

Proposer

@nishaldesai (imin) on behalf of several local authorities including Westminster and Slough

Use Case

As an end-user, I want to filter virtual classes by whether they require me to have equipment (yoga matt, dumbbells, exercise ball etc) at home or not.

Why is this not covered by existing properties?

The existing model includes attendeeInstructions, and the Routes spec includes suggestedEquipment, which are both helpful, but are string inputs, so could be anything. A better UX would be a boolean field for requires-home-equipment or not, which data users / brokers can filter on.

Proposal

requiresPersonalEquipment or similar (boolean). Maybe just equipmentRequired ?

Perhaps in the near future there's also a restricted list included? So users can search for virtual classes that match the equipment they have.

@nickevansuk

This comment has been minimized.

Copy link
Contributor

@nickevansuk nickevansuk commented Mar 24, 2020

Perhaps participantRequiresEquipment in line with participantInteraction (instead of using the word "personal")?

@nickevansuk

This comment has been minimized.

Copy link
Contributor

@nickevansuk nickevansuk commented Mar 26, 2020

Relevant points from the summary of the W3C call:

  • There was a proposal that this should be triple-valued (roughly required, optional, none) - to account for events where equipment is optional (an alternative is provided for those without). Consensus was that context would indicate the meaning of the attribute, with additional guidance being provided in attendeeInstructions if required.
@nickevansuk

This comment has been minimized.

Copy link
Contributor

@nickevansuk nickevansuk commented Mar 26, 2020

Updated Proposal

A boolean property beta:participantSuppliedEquipment is defined on Event to indicate whether the participant must or may supply equipment for use in the Event.

Utilising the existing oa:RequiredStatusType for simplicity, the value of the property must be one of the following:

  • https://openactive.io/Required - Equipment is required (e.g. weights, or a mat)
  • https://openactive.io/Optional - Equipment is optional, and the participant can improvise
  • https://openactive.io/Unavailable - No equipment required

If the beta:participantSuppliedEquipment property is not specified, it is assumed to be unknown.

Example

{
  "@type": "SessionSeries",
  ...
  "beta:participantSuppliedEquipment": "https://openactive.io/Required"
}
@openactive-bot

This comment has been minimized.

Copy link
Contributor

@openactive-bot openactive-bot commented Mar 30, 2020

This proposal has been added to the Beta namespace as follows:

(Class) Property Expected Type Description
(schema:Event)
beta:participantSuppliedEquipment
oa:RequiredStatusType Indicates whether the participant must or may supply equipment for use in the Event.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.