@openactive/data-models

{ "type": "Course", "derivedFrom": "https://schema.org/Course", "sampleId": "https://api.example.com/courses/12345", "hasId": true, "inSpec": [ "type", "id", "accessibilityInformation", "accessibilitySupport", "activity", "ageRange", "author", "category", "description", "genderRestriction", "identifier", "image", "level", "name", "url" ], "fields": { "type": { "fieldName": "type", "requiredType": "https://schema.org/Text", "requiredContent": "Course" }, "accessibilityInformation": { "fieldName": "accessibilityInformation", "sameAs": "https://openactive.io/accessibilityInformation", "requiredType": "https://schema.org/Text", "description": [ "Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event." ], "example": "This route has been British Cycling assessed as an accessible route, meaning it is suitable for the majority of adaptive bikes. The route will have no or low levels of traffic, there will be plenty of space and will have a good surface throughout. If you have any questions about using this route on an adaptive bike on this ride, please use visit https://www.letsride.co.uk/accessibility or call 0123 456 7000 and ask for the Recreation team." }, "accessibilitySupport": { "fieldName": "accessibilitySupport", "sameAs": "https://openactive.io/accessibilitySupport", "model": "ArrayOf#Concept", "description": [ "Used to specify the types of disabilities or impairments that are supported at an event." ], "example": [ { "@type": "Concept", "@id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277", "prefLabel": "Visual impairment", "inScheme": "https://openactive.io/accessibility-support" } ] }, "activity": { "fieldName": "activity", "sameAs": "https://openactive.io/activity", "model": "ArrayOf#Concept", "description": [ "Specifies the physical activity or activities that will take place during a Course." ], "example": [ { "@id": "https://openactive.io/activity-list#fbdc35a8-3dd0-40ee-a7ca-6ff40b3e5f90", "@type": "Concept", "prefLabel": "Netball", "inScheme": "https://openactive.io/activity-list" } ] }, "ageRange": { "fieldName": "ageRange", "sameAs": "https://openactive.io/ageRange", "model": "#QuantitativeValue", "description": [ "Indicates that an event is recommended as being suitable for or is targetted at a specific age range." ], "example": { "@type": "QuantitativeValue", "minValue": 50, "maxValue": 60 } }, "author": { "fieldName": "author", "sameAs": "https://schema.org/author", "model": "#Organization", "alternativeModels": [ "#Person" ], "allowReferencing": true, "description": [ "The person or organization who designed the Course. An author might be an schema:Organization or a schema:Person.", "This property may reference the `@id` of the `organizer` of the `CourseInstance` within which this `Course` is embedded, to reduce data duplication." ], "example": { "@type": "Organization", "@id": "https://id.bookingsystem.example.com/organizers/1", "name": "Central Speedball Association", "url": "http://www.speedball-world.com" } }, "category": { "fieldName": "category", "sameAs": "https://schema.org/category", "model": "ArrayOf#Concept", "alternativeTypes": [ "ArrayOf#https://schema.org/Text" ], "description": [ "Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc." ], "example": [ "High Intensity" ] }, "description": { "fieldName": "description", "sameAs": "https://schema.org/description", "requiredType": "https://schema.org/Text", "example": "Netball Youth Camps give junior netballers the chance to get together with their friends and take to the court in the holidays!\n\nThe camp is a non-residential holiday camp providing ‘Nothing but Netball’; not only will there be top quality coaching and fun netball activities but there is even an opportunity to meet and be inspired by an elite player.\n\nIf you are a junior netball lover (or the parent of one!) these are an unmissable holiday activity.", "description": [ "A plain text description of the Course, which must not include HTML or other markup." ] }, "genderRestriction": { "fieldName": "genderRestriction", "sameAs": "https://openactive.io/genderRestriction", "requiredType": "https://openactive.io/GenderRestrictionType", "description": [ "Indicates that an event is restricted to male, female or a mixed audience. This information must be displayed prominently to the user before booking. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience." ], "example": "https://openactive.io/FemaleOnly" }, "identifier": { "fieldName": "identifier", "sameAs": "https://schema.org/identifier", "alternativeModels": [ "#PropertyValue", "ArrayOf#PropertyValue" ], "requiredType": "https://schema.org/Text", "alternativeTypes": [ "https://schema.org/Integer" ], "example": "BR1234", "description": [ "A local non-URI identifier for the resource" ] }, "image": { "fieldName": "image", "sameAs": "https://schema.org/image", "model": "ArrayOf#ImageObject", "description": [ "An image or photo that depicts the event, e.g. a photo taken at a previous event." ], "example": [{ "@type": "ImageObject", "url": "http://example.com/static/image/speedball_large.jpg", "thumbnail":[ { "@type": "ImageObject", "url": "http://example.com/static/image/speedball_thumbnail.jpg" } ] }] }, "level": { "fieldName": "level", "sameAs": "https://openactive.io/level", "requiredType": "ArrayOf#https://schema.org/Text", "alternativeModels": [ "ArrayOf#Concept" ], "description": [ "A general purpose property for specifying the suitability of an event for different participant “levels”. E.g. `Beginner`, `Intermediate`, `Advanced`. Or in the case of martial arts, specific belt requirements." ], "example": [ "Beginner" ] }, "name": { "fieldName": "name", "sameAs": "https://schema.org/name", "requiredType": "https://schema.org/Text", "example": "Netball Youth Camp", "description": [ "The name of the Course" ] }, "url": { "fieldName": "url", "sameAs": "https://schema.org/url", "requiredType": "https://schema.org/URL", "example": "http://www.speedball-world.com/beginners-course", "description": [ "A definitive canonical URL for the Course." ] } } }