Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions versions/2.x/models/Course.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"sameAs": "https://openactive.io/activity",
"model": "ArrayOf#Concept",
"description": [
"Specifies the physical activity or activities that will take place during a Course."
"Specifies the physical activity or activities associated with this resource."
],
"example": [
{
Expand All @@ -72,7 +72,7 @@
"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."
"Indicates that this resource is recommended as being suitable for, or is targeted at, a specific age range."
],
"example": {
"@type": "QuantitativeValue",
Expand Down
153 changes: 152 additions & 1 deletion versions/2.x/models/Organization.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,39 @@
"requiredFields": [
"id"
]
},
"$": {
"requiredFields": [
"name",
"activity",
"location",
"beta:dateVerified",
"license"
],
"recommendedFields": [
"id",
"description",
"url",
"sameAs",
"email",
"telephone"
]
},
"data": {
"requiredFields": [
"name",
"activity",
"location",
"beta:dateVerified"
],
"recommendedFields": [
"id",
"description",
"url",
"sameAs",
"email",
"telephone"
]
}
},
"bookableFeed": {
Expand Down Expand Up @@ -203,7 +236,15 @@
"address",
"termsOfService",
"isOpenBookingAllowed",
"hasAccount"
"hasAccount",
"activity",
"location",
"ageRange",
"genderRestriction",
"alternateName",
"memberOf",
"member",
"license"
],
"fields": {
"type": {
Expand Down Expand Up @@ -355,6 +396,116 @@
"Reference to the CustomerAccount associated with this Customer, for use within the Open Booking API flow.",
"Note that this property is in EARLY RELEASE AND IS SUBJECT TO CHANGE, as the [Customer Accounts proposal](https://github.com/openactive/customer-accounts) evolves."
]
},
"activity": {
"fieldName": "activity",
"sameAs": "https://openactive.io/activity",
"model": "ArrayOf#Concept",
"description": [
"The physical activity or activities provided by this organization."
],
"example": [
{
"@type": "Concept",
"@id": "https://openactive.io/activity-list#6bb8b844-df3e-4cae-bf5f-3e129c6b1a9d",
"prefLabel": "Sailing",
"inScheme": "https://openactive.io/activity-list"
}
]
},
"location": {
"fieldName": "location",
"sameAs": "https://schema.org/location",
"model": "#Place",
"alternativeModels": [
"ArrayOf#Place",
"#PostalAddress"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need this. Place.address with a PostalAddress value can be used for this purpose

],
"alternativeTypes": [
"https://schema.org/Text"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need this. Place.address with a String value can be used for this purpose

],
"description": [
"The main address of the organization, or the key locations of the activities it provides."
],
"example": {
"@type": "Place",
"@id": "https://example.com/locations/1234ABCD",
"name": "Example Sailing Club",
"address": {
"@type": "PostalAddress",
"postalCode": "SE10 0BW",
"addressCountry": "GB"
}
}
},
"ageRange": {
"fieldName": "ageRange",
"sameAs": "https://openactive.io/ageRange",
"model": "#QuantitativeValue",
"description": [
"The age range this organization caters for overall."
],
"example": {
"@type": "QuantitativeValue",
"minValue": 5,
"maxValue": 16
}
},
"genderRestriction": {
"fieldName": "genderRestriction",
"sameAs": "https://openactive.io/genderRestriction",
"requiredType": "https://openactive.io/GenderRestrictionType",
"description": [
"Indicates that the organization provides activities that are restricted to male or female participants, or that there are no restrictions."
],
"example": "https://openactive.io/FemaleOnly"
},
"alternateName": {
"fieldName": "alternateName",
"sameAs": "https://schema.org/alternateName",
"requiredType": "https://schema.org/Text",
"alternativeTypes": [
"ArrayOf#https://schema.org/Text"
],
"description": [
"Aliases, common acronyms or alternative names for the organization."
],
"example": [
"EYC"
]
},
"memberOf": {
"fieldName": "memberOf",
"sameAs": "https://schema.org/memberOf",
"model": "#Organization",
"allowReferencing": true,
"description": [
"The `@id` of an organization that this organization is affiliated to. For example, a club can link to its national governing body."

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be an id or a nested Organization object. Description should be updated accordingly.

],
"example": "https://example.org/id/organisation/national-governing-body"
},
"member": {
"fieldName": "member",
"sameAs": "https://schema.org/member",
"requiredType": "ArrayOf#https://schema.org/URL",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be ArrayOf#Organization instead of URL with "allowReferencing": true

"alternativeTypes": [
"https://schema.org/URL"
],
"description": [
"The `@id`s of organizations affiliated to this organization. For example, a national governing body can list its affiliated clubs."
],
"example": [
"https://example.org/id/organisation/1"
]
},
"license": {
"fieldName": "license",
"sameAs": "https://schema.org/license",
"requiredType": "https://schema.org/URL",
"example": "https://creativecommons.org/licenses/by/4.0/",
"description": [
"Reference to the license under which the Organization's data is published. Required when an Organization is published on its own outside an RPDE feed; in an RPDE feed, the license is given by each feed page, so it should not be included."
]
}
}
}
6 changes: 4 additions & 2 deletions versions/2.x/rpde/FeedItem.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
"fieldName": "data",
"model": "#Event",
"alternativeModels": [
"#FacilityUse"
"#FacilityUse",
"#Organization"
],
"description": [
"Note this property must not be included if state is \"deleted\"."
Expand Down Expand Up @@ -51,7 +52,8 @@
"EventSeries",
"OnDemandEvent",
"Order",
"Place"
"Place",
"Organization"
],
"description": [
"The kind property allows for the representation of different entity types, though where possible referenced entities should be embedded into the primary entity. Each entity type (kind) can be synchronised separately, this allows a decoupling of the sync logic from the data structure, and allows the data structure to be reassembled on the data consumer side (at System 2)."
Expand Down
Loading