@openactive/data-models/src/dist/specs.js

Data models used to drive that OpenActive validator, developer documentation, and model libraries

/* eslint-disable */
  // This is a generated file. Do not edit manually.
  module.exports = {"2.x":{"rawModels":{"models":{"Action":{"type":"Action","derivedFrom":"https://schema.org/Action","hasId":false,"inSpec":["type","object"],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"Action"},"object":{"fieldName":"object","sameAs":"https://schema.org/object","model":"#Event","alternativeModels":["#Order"],"example":{"@type":"SessionSeries","@id":"https://id.booking-system.example.com/session-series/42"},"description":["The object upon which the action is carried out, whose state is kept intact or changed."]}}},"AudioObject":{"type":"AudioObject","subClassOf":"#MediaObject","derivedFrom":"https://schema.org/AudioObject","hasId":false,"requiredFields":["type","url"],"inSpec":["type","thumbnail","url","contentUrl","embedUrl","width","height"],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"AudioObject"},"thumbnail":{"fieldName":"thumbnail","sameAs":"https://schema.org/thumbnail","model":"ArrayOf#ImageObject","description":["The URL for a thumbnail image for the audio."]},"url":{"fieldName":"url","sameAs":"https://schema.org/url","requiredType":"https://schema.org/URL","example":"https://soundcloud.com/stayin/getfit","description":["The URL for the audio."]}}},"BabyChanging":{"type":"BabyChanging","subClassOf":"#LocationFeatureSpecification","fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"BabyChanging"},"name":{"fieldName":"name","sameAs":"https://schema.org/name","requiredType":"https://schema.org/Text","example":"Baby Changing Facilities","description":["A string, suitable for presentation in user interfaces."]}}},"Barcode":{"type":"Barcode","subClassOf":"#ImageObject","derivedFrom":"https://schema.org/Barcode","hasId":false,"requiredFields":["type"],"inSpec":["type","thumbnail","text","url","contentUrl","embedUrl","width","height"],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"Barcode"},"text":{"fieldName":"text","sameAs":"https://schema.org/text","requiredType":"https://schema.org/Text","example":"0123456789","description":["The barcode number"]},"url":{"fieldName":"url","sameAs":"https://schema.org/url","requiredType":"https://schema.org/URL","example":"https://fallback.image.example.com/476ac24c694da79c5e33731ebbb5f1","description":["A fallback rendered barcode image url in addition to the raw barcode details."]}}},"BookingService":{"type":"BookingService","subClassOf":"https://schema.org/Service","validationMode":{"C1Request":"request","C1Response":"response","C1ResponseOrderItemError":"response","C2Request":"request","C2Response":"response","C2ResponseOrderItemError":"response","PRequest":"request","PResponse":"response","PResponseOrderItemError":"response","BRequest":"request","BResponse":"response","BResponseOrderItemError":"response","OrderProposalPatch":"request","OrderPatch":"request","DatasetSite":"datasetSite"},"imperativeConfiguration":{"request":{"requiredFields":[],"recommendedFields":[]},"response":{"requiredFields":["type","name"],"recommendedFields":[]},"datasetSite":{"requiredOptions":[{"description":["A `BookingService` must include a `name`, unless it is a bespoke build, in which case only `hasCredential` is required."],"options":["name","hasCredential"]}],"requiredFields":[],"recommendedFields":[]}},"inSpec":["type","name","url","termsOfService","softwareVersion","hasCredential"],"notInSpec":[],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"BookingService"},"name":{"fieldName":"name","requiredType":"https://schema.org/Text","sameAs":"https://schema.org/name","description":["The name of the Booking System."]},"url":{"fieldName":"url","requiredType":"https://schema.org/URL","sameAs":"https://schema.org/url","description":["The URL of the website of the Booking System."]},"termsOfService":{"fieldName":"termsOfService","sameAs":"https://pending.schema.org/termsOfService","model":"ArrayOf#Terms","description":["The terms of service of the Booking System."]},"softwareVersion":{"fieldName":"softwareVersion","sameAs":"https://schema.org/softwareVersion","requiredType":"https://schema.org/Text","description":["The version of the application, useful for on-premise installations. Note this property is in EARLY RELEASE AND IS SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://openactive.io/dataset-api-discovery/EditorsDraft/) evolves."]},"hasCredential":{"fieldName":"hasCredential","sameAs":"https://pending.schema.org/hasCredential","requiredType":"https://schema.org/URL","description":["A human and machine-readable certification file that asserts the service's conformance to established standards. The value of this property should be a URL that resolves to a valid and up-to-date OpenActive Test Suite Conformance Certificate for this implementation. Note this property is in EARLY RELEASE AND IS SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://openactive.io/dataset-api-discovery/EditorsDraft/) evolves."]}}},"BooleanFormFieldSpecification":{"type":"BooleanFormFieldSpecification","subClassOf":"#PropertyValueSpecification","sampleId":"https://example.com/photoconsent","requiredFields":["type","id","name"],"recommendedFields":["description"],"shallNotInclude":["valueRequired"],"requiredOptions":[],"inSpec":["type","id","name","description","valueRequired"],"notInSpec":["valueRequired"],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"BooleanFormFieldSpecification"}}},"Brand":{"type":"Brand","derivedFrom":"https://schema.org/Brand","hasId":true,"sampleId":"https://example.com/programmes/12345","requiredFields":["type","name","url"],"recommendedFields":["description","logo"],"inSpec":["type","id","name","url","description","logo","identifier"],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"Brand"},"description":{"fieldName":"description","sameAs":"https://schema.org/description","requiredType":"https://schema.org/Text","example":"Play Ball! is a series of games for people of all abilities.","description":["A plain text description for the brand, which must not include HTML or other markup."]},"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"]},"logo":{"fieldName":"logo","sameAs":"https://schema.org/logo","model":"#ImageObject","example":{"@type":"ImageObject","url":"http://example.com/static/image/speedball_large.jpg"},"description":["The logo associated with the brand."]},"name":{"fieldName":"name","sameAs":"https://schema.org/name","requiredType":"https://schema.org/Text","example":"Play Ball!","description":["The name of the brand."]},"url":{"fieldName":"url","sameAs":"https://schema.org/url","requiredType":"https://schema.org/URL","example":"http://example.com/play_ball","description":["A url where further information can be found for the brand."]}}},"CancellationNotPermittedError":{"type":"CancellationNotPermittedError","subClassOf":"#OpenBookingError","description":{"sections":[{"title":"Error Use Case","paragraphs":["Cancellation is not permitted due to internal rules of the Booking System not otherwise exposed to the Broker.  The `description` property of the object MUST include a Customer-facing description of the reason that cancellation is not permitted."]}]},"fields":{"type":{"fieldName":"type","requiredContent":"CancellationNotPermittedError","requiredType":"https://schema.org/Text"},"name":{"description":["A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization."],"example":"Cancellation is not permitted due to internal rules of the Booking System not otherwise exposed to the Broker.","defaultContent":"Cancellation is not permitted due to internal rules of the Booking System not otherwise exposed to the Broker.","fieldName":"name","requiredType":"https://schema.org/Text","sameAs":"https://schema.org/name"},"statusCode":{"fieldName":"statusCode","sameAs":"https://openactive.io/statusCode","requiredType":"https://schema.org/Integer","requiredContent":400,"defaultContent":400,"description":["An integer representing the HTTP status code."]}}},"ChangingFacilities":{"type":"ChangingFacilities","subClassOf":"#LocationFeatureSpecification","fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"ChangingFacilities"},"name":{"fieldName":"name","sameAs":"https://schema.org/name","requiredType":"https://schema.org/Text","example":"Changing Rooms","description":["A string, suitable for presentation in user interfaces."]}}},"Concept":{"type":"Concept","derivedFrom":"http://www.w3.org/2004/02/skos/core#Concept","hasId":true,"sampleId":"https://openactive.io/activity-list#a454c7e6-52da-426d-9bd1-743e9d7d266d","requiredFields":["type","id","prefLabel","inScheme"],"shallNotInclude":["altLabel","hiddenLabel","broader","narrower","related","notation","definition","topConceptOf"],"commonTypos":{"identifier":"notation","name":"prefLabel"},"inSpec":["type","id","prefLabel","altLabel","hiddenLabel","inScheme","broader","narrower","related","notation","definition","topConceptOf"],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"Concept"},"id":{"fieldName":"id","requiredType":"https://schema.org/URL","description":["The `@id` of a Concept from the [OpenActive Activity List](https://github.com/openactive/activity-list). This value [must always exactly match](https://developer.openactive.io/publishing-data/activity-list-references) an `id` from the [OpenActive Activity List](https://github.com/openactive/activity-list)."],"example":"https://openactive.io/activity-list#a454c7e6-52da-426d-9bd1-743e9d7d266d"},"altLabel":{"fieldName":"altLabel","sameAs":"http://www.w3.org/2004/02/skos/core#altLabel","requiredType":"ArrayOf#https://schema.org/Text","example":["Five a side"],"description":["An alternative human readable string for use in user interfaces."]},"hiddenLabel":{"fieldName":"hiddenLabel","sameAs":"http://www.w3.org/2004/02/skos/core#hiddenLabel","requiredType":"ArrayOf#https://schema.org/Text","example":["5-a-side"],"description":["An alternative human readable string used to drive autocomplete search matches, that is hidden from the user."]},"broader":{"fieldName":"broader","sameAs":"http://www.w3.org/2004/02/skos/core#broader","requiredType":"ArrayOf#https://schema.org/URL","example":["https://openactive.io/activity-list#6ca15167-51da-4d91-a1ae-8a45dc47b0ea"],"description":["A broader Concept URI"]},"related":{"fieldName":"related","sameAs":"http://www.w3.org/2004/02/skos/core#related","requiredType":"ArrayOf#https://schema.org/URL","example":["https://openactive.io/activity-list#5cdf5ead-e19d-4619-9585-cfe509c3fe52"],"description":["A related Concept URI"]},"inScheme":{"fieldName":"inScheme","sameAs":"http://www.w3.org/2004/02/skos/core#inScheme","requiredType":"https://schema.org/URL","example":"https://openactive.io/activity-list","description":["A stable URL reference for the taxonomy, which must be `https://openactive.io/activity-list` to [reference the OpenActive Activity List](https://developer.openactive.io/publishing-data/activity-list-references)."]},"narrower":{"fieldName":"narrower","sameAs":"http://www.w3.org/2004/02/skos/core#narrower","requiredType":"ArrayOf#https://schema.org/URL","example":["https://openactive.io/activity-list#b3829f3e-a63e-455f-a51c-1f50ecf85ad5"],"description":["A more specific concept URI"]},"notation":{"fieldName":"notation","sameAs":"http://www.w3.org/2004/02/skos/core#notation","requiredType":"https://schema.org/Text","example":"salsa","description":["A human-readable identifier for the concept."]},"prefLabel":{"fieldName":"prefLabel","sameAs":"http://www.w3.org/2004/02/skos/core#prefLabel","requiredType":"https://schema.org/Text","example":"Salsa","description":["A human readable string that minimally describes the Concept, for use in user interfaces."]},"definition":{"fieldName":"definition","sameAs":"http://www.w3.org/2004/02/skos/core#definition","requiredType":"https://schema.org/Text","example":"Latin American style of dance with Cuban origins.","description":["A human readable string that unambiguously defines the Concept, for use in user interfaces."]},"topConceptOf":{"fieldName":"topConceptOf","sameAs":"http://www.w3.org/2004/02/skos/core#topConceptOf","requiredType":"https://schema.org/URL","example":"https://openactive.io/activity-list","description":["A reference to the Scheme URI, the existence of which indicates that this Concept is at the top level of the hierarchy."]}}},"ConceptScheme":{"type":"ConceptScheme","derivedFrom":"http://www.w3.org/2004/02/skos/core#ConceptScheme","hasId":true,"sampleId":"https://example.com/scheme-name","requiredFields":["type","id","url","title","concept"],"recommendedFields":["description","license"],"inSpec":["type","id","url","title","description","license","concept"],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"ConceptScheme"},"concept":{"fieldName":"concept","sameAs":"https://openactive.io/concept","model":"ArrayOf#Concept","example":[{"@id":"https://example.com/concept/martial-arts","type":"Concept","prefLabel":"Martial Arts","inScheme":"https://example.com/scheme/123","narrower":"https://example.com/concept/martial-arts/karate"}],"description":["A collection of concepts that are part of this scheme"]},"description":{"fieldName":"description","sameAs":"https://schema.org/description","requiredType":"https://schema.org/Text","example":"An example activity list.","description":["A plain text description of the taxonomy, which must not include HTML or other markup."]},"license":{"fieldName":"license","sameAs":"http://purl.org/dc/terms/license","requiredType":"https://schema.org/URL","description":["Reference to the license under which the activity list has been published."],"example":"https://example.com/license/MIT"},"title":{"fieldName":"title","sameAs":"http://purl.org/dc/terms/title","requiredType":"https://schema.org/Text","example":"Activity List","description":["The title of the scheme"]},"url":{"fieldName":"url","sameAs":"https://schema.org/url","requiredType":"https://schema.org/URL","description":["A URL to a web page (or section of a page) that describes the concept scheme."],"example":"https://example.com/scheme/1234"}}},"Course":{"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."]}}},"CourseInstance":{"type":"CourseInstance","hasId":true,"subClassOf":"#Event","derivedFrom":"https://schema.org/CourseInstance","sampleId":"https://api.example.com/course-instances/12345","requiredFields":["type","id","url","name","location","activity","organizer","offers","startDate","endDate"],"requiredOptions":[{"description":["A data publisher must provide either a `subEvent` or specify an `eventSchedule` for a CourseInstance."],"options":["subEvent","eventSchedule"],"oneOf":true}],"recommendedFields":["description","image","eventStatus","ageRange","genderRestriction","leader","level","maximumAttendeeCapacity","remainingAttendeeCapacity"],"shallNotInclude":[],"validationMode":{"C1Request":"request","C1Response":"response","C1ResponseOrderItemError":"response","C2Request":"request","C2Response":"response","C2ResponseOrderItemError":"response","PRequest":"request","PResponse":"response","PResponseOrderItemError":"response","BRequest":"request","BResponse":"response","BResponseOrderItemError":"response","OrdersFeed":"response","OrderProposalsFeed":"response","OrderStatus":"response","TestInterface":"testInterface"},"imperativeConfiguration":{"testInterface":{"requiredFields":["type"],"recommendedFields":[],"shallNotInclude":[]},"request":{"requiredFields":["type","id"],"shallNotInclude":["identifier","url","name","description","image","startDate","endDate","duration","location","organizer","contributor","maximumAttendeeCapacity","maximumVirtualAttendeeCapacity","remainingAttendeeCapacity","eventStatus","subEvent","superEvent","activity","category","ageRange","genderRestriction","ageRestriction","additionalAdmissionRestriction","customerAccountBookingRestriction","isOpenBookingWithCustomerAccountAllowed","programme","attendeeInstructions","leader","accessibilitySupport","accessibilityInformation","isCoached","level","meetingPoint","isAccessibleForFree","offers","schedulingNote","eventSchedule"]},"response":{"requiredFields":["type","id","url","name","location","activity","startDate"],"recommendedFields":["endDate","duration","ageRange","genderRestriction","eventStatus","maximumAttendeeCapacity","remainingAttendeeCapacity"],"shallNotInclude":["offers","subEvent","organizer"]}},"inSpec":["id","type","identifier","url","name","description","image","startDate","endDate","duration","location","organizer","contributor","maximumAttendeeCapacity","maximumVirtualAttendeeCapacity","remainingAttendeeCapacity","eventStatus","subEvent","superEvent","eventSchedule","activity","category","ageRange","genderRestriction","ageRestriction","additionalAdmissionRestriction","customerAccountBookingRestriction","isOpenBookingWithCustomerAccountAllowed","programme","attendeeInstructions","leader","accessibilitySupport","accessibilityInformation","isCoached","level","meetingPoint","isAccessibleForFree","offers","schedulingNote","eventAttendanceMode","instanceOfCourse"],"notInSpec":["superEvent"],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"CourseInstance"},"startDate":{"fieldName":"startDate","sameAs":"https://schema.org/startDate","requiredType":"https://schema.org/Date","description":["The start date of this course."],"example":"2018-01-06"},"endDate":{"fieldName":"endDate","sameAs":"https://schema.org/endDate","requiredType":"https://schema.org/Date","description":["The end date of this course."],"example":"2018-01-27"},"instanceOfCourse":{"fieldName":"instanceOfCourse","sameAs":"https://openactive.io/instanceOfCourse","model":"#Course","description":["The description of the Course for which this is a distinct instance."],"inheritsFrom":{"exclude":["id","identifier"]}},"subEvent":{"fieldName":"subEvent","sameAs":"https://schema.org/subEvent","model":"ArrayOf#Event","description":["The occurrences of this CourseInstance."],"inheritsTo":{"exclude":["id","identifier","subEvent","superEvent","eventSchedule","offers","startDate","endDate"]}},"eventSchedule":{"fieldName":"eventSchedule","sameAs":"https://pending.schema.org/eventSchedule","model":"ArrayOf#Schedule","description":["A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern."],"example":[{"@type":"PartialSchedule","repeatFrequency":"P1W","startTime":"20:15","endTime":"20:45","byDay":["http://schema.org/Tuesday"],"scheduleTimezone":"Europe/London"}]}}},"Creche":{"type":"Creche","subClassOf":"#LocationFeatureSpecification","fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"Creche"},"name":{"fieldName":"name","sameAs":"https://schema.org/name","requiredType":"https://schema.org/Text","example":"Childcare","description":["A string, suitable for presentation in user interfaces."]}}},"CustomerAccount":{"type":"CustomerAccount","subClassOf":"https://schema.org/Thing","hasId":true,"sampleId":"https://id.bookingsystem.example.com/customer-accounts/fdc14503-275e-46d3-9922-45b986c9f9aa","inSpec":["type","id","identifier","accountNumber","customer","accessPass","hasHiddenEntitlements","outstandingAction","entitlement"],"description":{"sections":[{"title":"EARLY RELEASE NOTICE","paragraphs":["This class represents a draft that is designed to inform the OpenActive specification work with implementation feedback.","IT IS STILL SUBJECT TO CHANGE, as the [Customer Accounts proposal](https://github.com/openactive/customer-accounts) evolves."]}]},"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"CustomerAccount"},"identifier":{"fieldName":"identifier","sameAs":"https://schema.org/identifier","requiredType":"https://schema.org/Text","example":"fdc14503-275e-46d3-9922-45b986c9f9aa","description":["The identifier of the Customer Account used by the Booking System."]},"accountNumber":{"fieldName":"accountNumber","sameAs":"https://openactive.io/accountNumber","requiredType":"https://schema.org/Text","description":["The customer-facing identifier for the Customer Account."]},"customer":{"fieldName":"customer","sameAs":"https://schema.org/customer","model":"#Person","alternativeModels":["#Organization"],"description":["The person or organization to whom this Customer Account belongs."]},"accessPass":{"fieldName":"accessPass","sameAs":"https://openactive.io/accessPass","model":"ArrayOf#Barcode","description":["The barcode, QR code, magnetic stripe, or swipe card associated with this Customer Account, within their own namespaces."]},"hasHiddenEntitlements":{"fieldName":"hasHiddenEntitlements","sameAs":"https://openactive.io/hasHiddenEntitlements","requiredType":"https://schema.org/Boolean","description":["Whether there are any additional entitlements (other than those listed in entitlement) or other types of discounts are associated with the Customer Account that will influence pricing, and therefore whether the pricing for the entitlement in the feed should be treated as indicative."],"example":true},"outstandingAction":{"fieldName":"outstandingAction","sameAs":"https://openactive.io/outstandingAction","model":"ArrayOf#Action","description":["Outstanding actions on this Customer Account, such as the resolution of outstanding debts or membership renewal. These may prevent the Customer from making bookings."]},"entitlement":{"fieldName":"entitlement","sameAs":"https://openactive.io/entitlement","model":"ArrayOf#Entitlement","description":["The current valid and active entitlements associated with this customer. Note that expired or inactive entitlements are not included in this list."]}}},"DataCatalog":{"type":"DataCatalog","derivedFrom":"https://schema.org/DataCatalog","hasId":true,"sampleId":"https://opendata.leisurecloud.live/api/datacatalog","requiredFields":["id","type","name","license","publisher"],"requiredOptions":[{"description":["The `DataCatalog` must include either `hasPart` if it is a collection of smaller `DataCatalog`s, or `dataset` if it is a collection of dataset sites."],"options":["hasPart","dataset"],"oneOf":true}],"recommendedFields":["datePublished"],"inSpec":["id","type","name","license","publisher","dateModified","datePublished","dataset","hasPart"],"description":{"sections":[{"title":"EARLY RELEASE NOTICE","paragraphs":["This class represents a draft that is designed to inform the OpenActive specification work with implementation feedback. It is mostly stable, as it based entirely on schema.org.","HOWEVER, IT IS STILL SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://openactive.io/dataset-api-discovery/EditorsDraft/) evolves."]}]},"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"DataCatalog"},"name":{"fieldName":"name","sameAs":"https://schema.org/name","requiredType":"https://schema.org/Text","example":"Acme Leisure Sessions and Facilities","description":["The name of the `DataCatalog`"]},"license":{"fieldName":"license","sameAs":"https://schema.org/license","requiredType":"https://schema.org/URL","requiredContent":"https://creativecommons.org/licenses/by/4.0/","example":"https://creativecommons.org/licenses/by/4.0/","description":["The license under which the data is published. OpenActive data must be published under CC-BY 4.0."]},"publisher":{"fieldName":"publisher","sameAs":"https://schema.org/publisher","model":"#Organization","description":["The organization ultimately responsible for maintaining this `DataCatalog`."],"example":{"@type":"Organization","name":"Central Speedball Association","url":"http://www.speedball-world.com"}},"dateModified":{"fieldName":"dateModified","sameAs":"https://schema.org/dateModified","requiredType":"https://schema.org/DateTime","description":["The date this `DataCatalog` was last updated."],"example":"2018-01-27T12:00:00Z"},"datePublished":{"fieldName":"datePublished","sameAs":"https://schema.org/datePublished","requiredType":"https://schema.org/DateTime","alternativeTypes":["https://schema.org/Date"],"description":["The date this `DataCatalog` was first published. Can be specified as a schema:Date or schema:DateTime."],"example":"2018-01-27T12:00:00Z"},"dataset":{"fieldName":"dataset","sameAs":"https://schema.org/dataset","requiredType":"ArrayOf#https://schema.org/URL","description":["The URLs of the dataset sites within this `DataCatalog`."],"example":["https://opendata.exercise-anywhere.com/","https://www.participant.co.uk/participant/openactive/"]},"hasPart":{"fieldName":"hasPart","sameAs":"https://schema.org/hasPart","requiredType":"ArrayOf#https://schema.org/URL","description":["The URLs of each smaller `DataCatalog` within this `DataCatalog` collection."],"example":["https://opendata.leisurecloud.live/api/datacatalog","https://openactivedatacatalog.legendonlineservices.co.uk/api/DataCatalog"]}}},"DataDownload":{"type":"DataDownload","derivedFrom":"https://schema.org/DataDownload","hasId":false,"requiredFields":["type","name","additionalType","encodingFormat","contentUrl"],"inSpec":["type","name","additionalType","encodingFormat","contentUrl","identifier"],"description":{"sections":[{"title":"EARLY RELEASE NOTICE","paragraphs":["This class represents a draft that is designed to inform the OpenActive specification work with implementation feedback.","IT IS SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://openactive.io/dataset-api-discovery/EditorsDraft/) evolves."]}]},"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"DataDownload"},"identifier":{"fieldName":"identifier","sameAs":"https://schema.org/identifier","requiredType":"https://schema.org/Text","example":"ScheduledSession","description":["A local non-URI identifier for the resource"]},"name":{"fieldName":"name","sameAs":"https://schema.org/name","requiredType":"https://schema.org/Text","example":"SessionSeries","description":["The name of the type of feed"]},"additionalType":{"fieldName":"additionalType","sameAs":"https://schema.org/additionalType","requiredType":"https://schema.org/URL","example":"https://openactive.io/SessionSeries","description":["A fully qualified reference to the class that is at the root of the items in the RPDE feed."]},"encodingFormat":{"fieldName":"encodingFormat","sameAs":"https://schema.org/encodingFormat","requiredType":"https://schema.org/Text","requiredContent":"application/vnd.openactive.rpde+json; version=1","example":"application/vnd.openactive.rpde+json; version=1","description":["The version of RPDE that is used in the feed, specified via MIME type."]},"contentUrl":{"fieldName":"contentUrl","sameAs":"https://schema.org/contentUrl","requiredType":"https://schema.org/URL","description":["The URL of the RPDE data feed."],"example":"https://opendata.leisurecloud.live/api/feeds/fusion-lifestyle-fl-live-session-series"}}},"Dataset":{"type":"Dataset","derivedFrom":"https://schema.org/Dataset","hasId":true,"sampleId":"https://opendata.fusion-lifestyle.com/OpenActive/","validationMode":{"RPDEFeed":"noRequired","BookableRPDEFeed":"noRequired","DataCatalog":"noRequired","C1Request":"noRequired","C1Response":"noRequired","C1ResponseOrderItemError":"noRequired","C2Request":"noRequired","C2Response":"noRequired","C2ResponseOrderItemError":"noRequired","PRequest":"noRequired","PResponse":"noRequired","PResponseOrderItemError":"noRequired","BRequest":"noRequired","BResponse":"noRequired","BResponseOrderItemError":"noRequired","OrderProposalPatch":"noRequired","OrderPatch":"noRequired","OrdersFeed":"noRequired","OrderProposalsFeed":"noRequired","OrderStatus":"noRequired"},"imperativeConfiguration":{"noRequired":{"requiredFields":[],"recommendedFields":[]}},"requiredFields":["id","type","url","name","description","keywords","license","distribution","discussionUrl","documentation","inLanguage","publisher","schemaVersion"],"recommendedFields":["datePublished","dateModified","backgroundImage"],"inSpec":["id","type","url","name","description","keywords","license","distribution","discussionUrl","documentation","inLanguage","publisher","dateModified","datePublished","schemaVersion","backgroundImage","bookingService","accessService"],"description":{"sections":[{"title":"EARLY RELEASE NOTICE","paragraphs":["This class represents a draft that is designed to inform the OpenActive specification work with implementation feedback. It is mostly stable, as it based almost entirely on schema.org.","HOWEVER, IT IS STILL SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://openactive.io/dataset-api-discovery/EditorsDraft/) evolves."]}]},"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"Dataset"},"name":{"fieldName":"name","sameAs":"https://schema.org/name","requiredType":"https://schema.org/Text","example":"Acme Leisure Sessions and Facilities","description":["The name of the `Dataset`"]},"url":{"fieldName":"url","sameAs":"https://schema.org/url","requiredType":"https://schema.org/URL","description":["The URL of the dataset site."],"example":"https://opendata.fusion-lifestyle.com/OpenActive/"},"description":{"fieldName":"description","sameAs":"https://schema.org/description","requiredType":"https://schema.org/Text","example":"Near real-time availability and rich descriptions relating to the sessions and facilities available from {OrganisationName}, published using the OpenActive Modelling Specification 2.0.","description":["A plain text description of the `Dataset`, which must not include HTML or other markup."]},"keywords":{"fieldName":"keywords","sameAs":"https://schema.org/keywords","requiredType":"ArrayOf#https://schema.org/Text","example":["Sessions","Facilities","Activities","Sports","Physical Activity","OpenActive"],"description":["Keywords for search engine optimisation"]},"license":{"fieldName":"license","sameAs":"https://schema.org/license","requiredType":"https://schema.org/URL","requiredContent":"https://creativecommons.org/licenses/by/4.0/","example":"https://creativecommons.org/licenses/by/4.0/","description":["The license under which the data is published. OpenActive data must be published under CC-BY 4.0."]},"distribution":{"fieldName":"distribution","sameAs":"https://schema.org/distribution","model":"ArrayOf#DataDownload","example":[{"@type":"DataDownload","name":"FacilityUse","additionalType":"https://openactive.io/FacilityUse","encodingFormat":"application/vnd.openactive.rpde+json; version=1","contentUrl":"https://opendata.leisurecloud.live/api/feeds/fusion-lifestyle-fl-live-facility-uses"}],"description":["An array of feeds within the dataset"]},"discussionUrl":{"fieldName":"discussionUrl","sameAs":"https://schema.org/discussionUrl","requiredType":"https://schema.org/URL","example":"https://github.com/gladstonemrm/FusionLifestyle/issues","description":["A URL that can be used to raise issues related to the `Dataset` via a public forum."]},"documentation":{"fieldName":"documentation","sameAs":"https://pending.schema.org/documentation","requiredType":"https://schema.org/URL","example":"https://permalink.openactive.io/dataset-site/open-data-documentation","description":["A link to documentation related to the `Dataset`, or a link to the OpenActive developer documentation using `https://permalink.openactive.io/dataset-site/open-data-documentation` if no Dataset-specific documentation is available."]},"inLanguage":{"fieldName":"inLanguage","sameAs":"https://schema.org/inLanguage","requiredType":"ArrayOf#https://schema.org/Text","example":["en-GB"],"description":["An array of languages included in the Dataset's content. Please use one of the language codes from the IETF BCP 47 standard."]},"publisher":{"fieldName":"publisher","sameAs":"https://schema.org/publisher","model":"#Organization","description":["The organization ultimately responsible for this `Dataset`."],"example":{"@type":"Organization","name":"Central Speedball Association","url":"http://www.speedball-world.com"}},"dateModified":{"fieldName":"dateModified","sameAs":"https://schema.org/dateModified","requiredType":"https://schema.org/DateTime","description":["The date this `Dataset` was last updated. For RPDE feeds this may simply be the date and time that the Dataset Site was rendered, which may be cached."],"example":"2018-01-27T12:00:00Z"},"datePublished":{"fieldName":"datePublished","sameAs":"https://schema.org/datePublished","requiredType":"https://schema.org/DateTime","alternativeTypes":["https://schema.org/Date"],"description":["The date this `Dataset` was first published. Can be specified as a schema:Date or schema:DateTime."],"example":"2018-01-27T12:00:00Z"},"schemaVersion":{"fieldName":"schemaVersion","sameAs":"https://schema.org/schemaVersion","requiredType":"https://schema.org/URL","example":"https://openactive.io/modelling-opportunity-data/2.0/","description":["Indicates the version of OpenActive Modelling Opportunity Data Specification with which this `Dataset` conforms, by specifying its URL."]},"backgroundImage":{"fieldName":"backgroundImage","sameAs":"https://openactive.io/backgroundImage","model":"#ImageObject","description":["A background image for the `Dataset`."],"example":{"@type":"ImageObject","url":"http://example.com/static/image/speedball_large.jpg"}},"bookingService":{"fieldName":"bookingService","sameAs":"https://openactive.io/bookingService","model":"#BookingService","description":["Information about the Booking System or publishing platform"]},"accessService":{"fieldName":"accessService","sameAs":"http://www.w3.org/ns/dcat#accessService","model":"#WebAPI","description":["Information about the Open Booking API. Note this property is in EARLY RELEASE AND IS SUBJECT TO CHANGE."]}}},"DropdownFormFieldSpecification":{"type":"DropdownFormFieldSpecification","subClassOf":"#PropertyValueSpecification","sampleId":"https://example.com/gender","requiredFields":["type","id","name","valueOption"],"recommendedFields":["description"],"shallNotInclude":[],"requiredOptions":[],"inSpec":["type","id","name","description","valueRequired","valueOption"],"notInSpec":[],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"DropdownFormFieldSpecification"},"valueOption":{"fieldName":"valueOption","requiredType":"ArrayOf#https://schema.org/Text","description":["Specifies an array of display values for the dropdown."],"sameAs":"https://openactive.io/valueOption"}}},"DynamicPayment":{"type":"DynamicPayment","subClassOf":"#Payment","validationMode":{"C1Request":"request","C1Response":"response","C1ResponseOrderItemError":"response","C2Request":"request","C2Response":"response","C2ResponseOrderItemError":"response","PRequest":"request","PResponse":"response","PResponseOrderItemError":"response","BRequest":"request","BResponse":"response","BResponseOrderItemError":"response","OrderProposalPatch":"request","OrderPatch":"request"},"imperativeConfiguration":{"request":{"requiredFields":[],"recommendedFields":[]},"response":{"requiredFields":["type","identifier","accountId"],"recommendedFields":["paymentProviderId","name"]}},"inSpec":["type","name","identifier","paymentMethod","accountId","paymentProviderId","additionalProperty"],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"DynamicPayment"}}},"Entitlement":{"type":"Entitlement","subClassOf":"https://schema.org/Permit","hasId":false,"inSpec":["type","validFrom","validUntil","entitlementType","evidenceRequestAction"],"description":{"sections":[{"title":"EARLY RELEASE NOTICE","paragraphs":["This class represents a draft that is designed to inform the OpenActive specification work with implementation feedback.","IT IS STILL SUBJECT TO CHANGE, as the [Customer Accounts proposal](https://github.com/openactive/customer-accounts) evolves."]}]},"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"Entitlement"},"validFrom":{"fieldName":"validFrom","sameAs":"https://schema.org/validFrom","requiredType":"https://schema.org/Date","description":["The date the entitlement becomes valid. This must be in the past."]},"validUntil":{"fieldName":"validUntil","sameAs":"https://schema.org/validUntil","requiredType":"https://schema.org/Date","description":["The date that the entitlement is no longer valid. This must be in the future."]},"entitlementType":{"fieldName":"entitlementType","sameAs":"https://openactive.io/entitlementType","model":"#Concept","allowReferencing":true,"description":["For the request, this is the value of the @id of the Concept being referenced. For the response, this the full Concept object including the @id and prefLabel."],"example":{"@type":"Concept","@id":"https://data.mcractive.com/openactive/entitlement-list#5e78bcbe-36db-425a-9064-bf96d09cc351","prefLabel":"MCRactive Adult Resident","inScheme":"https://data.mcractive.com/openactive/entitlement-list"}},"evidenceRequestAction":{"fieldName":"evidenceRequestAction","sameAs":"https://openactive.io/evidenceRequestAction","model":"#Action","description":["Any evidence request associated with the entitlement."]}}},"Event":{"type":"Event","derivedFrom":"https://schema.org/Event","hasId":true,"sampleId":"https://api.example.com/events/12345","requiredFields":["type","id","url","name","location","activity","organizer","offers","startDate"],"commonTypos":{"offer":"offers"},"recommendedFields":["description","image","eventStatus","ageRange","genderRestriction","leader","level","maximumAttendeeCapacity","remainingAttendeeCapacity","endDate"],"shallNotInclude":["eventSchedule"],"validationMode":{"RPDEFeed":"feed","BookableRPDEFeed":"feed","C1Request":"request","C1Response":"response","C1ResponseOrderItemError":"response","C2Request":"request","C2Response":"response","C2ResponseOrderItemError":"response","PRequest":"request","PResponse":"response","PResponseOrderItemError":"response","BRequest":"request","BResponse":"response","BResponseOrderItemError":"response","OrdersFeed":"response","OrderProposalsFeed":"response","OrderStatus":"response","TestInterface":"testInterface"},"imperativeConfigurationWithContext":{"feed":{"subEvent":{"requiredFields":["type","url","name","location","activity","organizer","startDate"]}}},"imperativeConfiguration":{"feed":{},"testInterface":{"requiredFields":["type"],"recommendedFields":[],"shallNotInclude":[]},"request":{"requiredFields":["type","id"],"shallNotInclude":["identifier","url","name","description","image","startDate","endDate","duration","location","organizer","contributor","maximumAttendeeCapacity","maximumVirtualAttendeeCapacity","remainingAttendeeCapacity","eventStatus","subEvent","superEvent","activity","category","ageRange","genderRestriction","ageRestriction","additionalAdmissionRestriction","customerAccountBookingRestriction","isOpenBookingWithCustomerAccountAllowed","programme","attendeeInstructions","leader","accessibilitySupport","accessibilityInformation","isCoached","level","meetingPoint","isAccessibleForFree","offers","schedulingNote"]},"response":{"requiredFields":["type","id","url","name","location","activity","startDate"],"recommendedFields":["endDate","duration","ageRange","genderRestriction","eventStatus","maximumAttendeeCapacity","remainingAttendeeCapacity"],"shallNotInclude":["offers","subEvent","organizer"]}},"inSpec":["id","type","identifier","url","name","description","image","startDate","endDate","duration","location","organizer","contributor","maximumAttendeeCapacity","maximumVirtualAttendeeCapacity","remainingAttendeeCapacity","eventStatus","subEvent","superEvent","activity","category","ageRange","genderRestriction","ageRestriction","additionalAdmissionRestriction","customerAccountBookingRestriction","isOpenBookingWithCustomerAccountAllowed","programme","attendeeInstructions","leader","accessibilitySupport","accessibilityInformation","isCoached","level","meetingPoint","isAccessibleForFree","offers","schedulingNote","eventAttendanceMode"],"fields":{"type":{"fieldName":"type","requiredType":"https://schema.org/Text","requiredContent":"Event"},"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 an event."],"example":[{"@type":"Concept","@id":"https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351","prefLabel":"Bodypump™","inScheme":"https://openactive.io/activity-list"}]},"attendeeInstructions":{"fieldName":"attendeeInstructions","sameAs":"https://openactive.io/attendeeInstructions","requiredType":"https://schema.org/Text","description":["Provides additional notes and instructions for event attendees, for example more information on how to find the event, what to bring, etc. The value of this property must not include HTML or other markup."],"example":"Ensure you bring trainers and a bottle of water."},"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"]},"contributor":{"fieldName":"contributor","sameAs":"https://schema.org/contributor","model":"ArrayOf#Person","description":["A Person who contributes to the facilitation of the Event."],"example":[{"@type":"Person","familyName":"Smith","givenName":"Nicole","@id":"https://example.com/locations/1234ABCD/leaders/89","identifier":89}]},"description":{"fieldName":"description","sameAs":"https://schema.org/description","requiredType":"https://schema.org/Text","example":"A fast paced game that incorporates netball, handball and football.","description":["A plain text description of the event, which must not include HTML or other markup."]},"duration":{"fieldName":"duration","sameAs":"https://schema.org/duration","requiredType":"https://schema.org/Duration","description":["The duration of the event given in [ISO8601] format."],"example":"PT1H"},"endDate":{"fieldName":"endDate","sameAs":"https://sc