From 959dd1e66dedcae7724a11fc33b53079d5e95047 Mon Sep 17 00:00:00 2001 From: Melanie Abraham Date: Thu, 11 Oct 2018 16:08:43 +0000 Subject: [PATCH 01/10] GitBook: [draft] 38 pages modified --- docs/data-model/types/action.md | 41 +- docs/data-model/types/babychanging.md | 36 +- docs/data-model/types/brand.md | 98 +-- docs/data-model/types/changingfacilities.md | 36 +- docs/data-model/types/concept.md | 118 ++-- docs/data-model/types/conceptscheme.md | 101 ++-- docs/data-model/types/courseinstance.md | 570 ++++++++++++------ docs/data-model/types/creche.md | 36 +- docs/data-model/types/entrypoint.md | 51 +- docs/data-model/types/event.md | 570 ++++++++++++------ docs/data-model/types/eventseries.md | 535 +++++++++++----- docs/data-model/types/facilityuse.md | 292 ++++++--- docs/data-model/types/geocoordinates.md | 41 +- docs/data-model/types/headlineevent.md | 521 +++++++++++----- docs/data-model/types/imageobject.md | 51 +- .../data-model/types/individualfacilityuse.md | 287 +++++---- .../types/locationfeaturespecification.md | 36 +- docs/data-model/types/lockers.md | 36 +- docs/data-model/types/offer.md | 163 +++-- .../types/openinghoursspecification.md | 54 +- docs/data-model/types/organization.md | 142 +++-- docs/data-model/types/parking.md | 36 +- docs/data-model/types/partialschedule.md | 232 ++++--- docs/data-model/types/person.md | 154 +++-- docs/data-model/types/place.md | 204 ++++--- docs/data-model/types/postaladdress.md | 80 ++- docs/data-model/types/propertyvalue.md | 63 +- docs/data-model/types/quantitativevalue.md | 56 +- docs/data-model/types/reserveaction.md | 41 +- docs/data-model/types/schedule.md | 272 ++++++--- docs/data-model/types/scheduledsession.md | 511 +++++++++++----- docs/data-model/types/sessionseries.md | 522 +++++++++++----- docs/data-model/types/showers.md | 36 +- docs/data-model/types/slot.md | 201 ++++-- .../types/sportsactivitylocation.md | 218 ++++--- docs/data-model/types/toilets.md | 36 +- docs/data-model/types/towels.md | 36 +- .../using-data/harvesting-opportunity-data.md | 2 +- 38 files changed, 4292 insertions(+), 2223 deletions(-) diff --git a/docs/data-model/types/action.md b/docs/data-model/types/action.md index 6a2d7d3c..69ab11b0 100644 --- a/docs/data-model/types/action.md +++ b/docs/data-model/types/action.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Action" + Text + Must always be present and set to "type": "Action"
name - Text + name + Text -

The name of the action


Example

"name": "Book"

+

The name of the action

+

+
Example +

+

"name": "Book" +

target - EntryPoint + target + EntryPoint -

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}

+

A definition of the target of the action.

+

+
Example +

+

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/babychanging.md b/docs/data-model/types/babychanging.md index afddc50c..96aacca1 100644 --- a/docs/data-model/types/babychanging.md +++ b/docs/data-model/types/babychanging.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "BabyChanging" + Text + Must always be present and set to "type": "BabyChanging"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Baby Changing Facilities"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Baby Changing Facilities" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/brand.md b/docs/data-model/types/brand.md index 80615e68..c4584376 100644 --- a/docs/data-model/types/brand.md +++ b/docs/data-model/types/brand.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), ## **Fields** ### **Required fields** - + @@ -20,38 +20,44 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Brand" + Text + Must always be present and set to "type": "Brand"
name - Text + name + Text -

The name of the brand.


Example

"name": "Play Ball!"

+

The name of the brand.

+

+
Example +

+

"name": "Play Ball!" +

url - url + url + url -

A url where further information can be found for the brand.


Example

"url": "http://example.com/play_ball"

+

A url where further information can be found for the brand.

+

+
Example +

+

"url": "http://example.com/play_ball" +

- +### **Recommended fields** -### **Recommended fields** - @@ -62,29 +68,36 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - + -
description - Text + description + Text -

A text description for the brand.


Example

"description": "Play Ball! is a series of games for people of all abilities."

+

A text description for the brand.

+

+
Example +

+

"description": "Play Ball! is a series of games for people of all abilities." +

logo - ImageObject + logo + ImageObject -

The logo associated with the brand.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

The logo associated with the brand.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

- +### **Optional fields** -### **Optional fields** - @@ -95,15 +108,26 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + -
identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "BR1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "BR1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/changingfacilities.md b/docs/data-model/types/changingfacilities.md index 2b65ac39..c6a201ef 100644 --- a/docs/data-model/types/changingfacilities.md +++ b/docs/data-model/types/changingfacilities.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "ChangingFacilities" + Text + Must always be present and set to "type": "ChangingFacilities"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Changing Rooms"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Changing Rooms" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/concept.md b/docs/data-model/types/concept.md index 367ffb27..8fe8e544 100644 --- a/docs/data-model/types/concept.md +++ b/docs/data-model/types/concept.md @@ -4,12 +4,12 @@ description: This page describes the Concept type. # Concept -This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://www.w3.org/2004/02/skos/core#Concept). +This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http://www.w3.org/2004/02/skos/core#Concept). ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - - + - - + -
type - Text + type - Must always be present and set to "type": "Concept" + Text + Must always be present and set to "type": "Concept"
prefLabel - Text + prefLabel + Text -

A human readable string for use in user interfaces.


Example

"prefLabel": "Speedball"

+

A human readable string for use in user interfaces.

+

+
Example +

+

"prefLabel": "Speedball" +

+### **Recommended fields** - -### **Recommended fields** - @@ -53,29 +54,36 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/concept/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/concept/12345" +

inScheme - url + inScheme + url -

A stable URL reference for the taxonomy.


Example

"inScheme": "https://example.com/reference/activities"

+

A stable URL reference for the taxonomy.

+

+
Example +

+

"inScheme": "https://example.com/reference/activities" +

+### **Optional fields** - -### **Optional fields** - @@ -86,42 +94,60 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - + - - + - - + - - + -
altLabel - Array of Text + altLabel + Array of Text -

An alternative human readable string for use in user interfaces.


Example

"altLabel": "Speedball"

+

An alternative human readable string for use in user interfaces.

+

+
Example +

+

"altLabel": "Speedball" +

broader - Array of url + broader + Array of url -

A broader Concept URI


Example

"broader": "https://example.com/football"

+

A broader Concept URI

+

+
Example +

+

"broader": "https://example.com/football" +

narrower - Array of url + narrower + Array of url -

A more specific concept URI


Example

"narrower": "https://example.com/walking-football"

+

A more specific concept URI

+

+
Example +

+

"narrower": "https://example.com/walking-football" +

notation - Text + notation + Text -

A concept label that is not normally recognisable as natural language.


Example

"notation": "Speedball"

+

A concept label that is not normally recognisable as natural language.

+

+
Example +

+

"notation": "Speedball" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/conceptscheme.md b/docs/data-model/types/conceptscheme.md index d3acfe5e..aa531e69 100644 --- a/docs/data-model/types/conceptscheme.md +++ b/docs/data-model/types/conceptscheme.md @@ -4,12 +4,12 @@ description: This page describes the ConceptScheme type. # ConceptScheme -This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). +This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). ## **Fields** ### **Required fields** - + @@ -20,56 +20,73 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](ht - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ConceptScheme" + Text + Must always be present and set to "type": "ConceptScheme"
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/scheme/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/scheme/12345" +

concept - Array of Concept + concept + Array of Concept -

A collection of concepts that are part of this scheme


Example

"concept": [
  {
    "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"
  }
]

+

A collection of concepts that are part of this scheme

+

+
Example +

+

"concept": [
{
"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"
}
] +

title - Text + title + Text -

The title of the scheme


Example

"title": "Activity List"

+

The title of the scheme

+

+
Example +

+

"title": "Activity List" +

url - url + url + url -

A URL to a web page (or section of a page) that describes the concept scheme.


Example

"url": "https://example.com/scheme/1234"

+

A URL to a web page (or section of a page) that describes the concept + scheme.

+

+
Example +

+

"url": "https://example.com/scheme/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,24 +97,32 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](ht - - + - - + -
description - Text + description + Text -

A free text description of the taxonomy


Example

"description": "An example activity list."

+

A free text description of the taxonomy

+

+
Example +

+

"description": "An example activity list." +

license - url + license + url -

Reference to the license under which the activity list has been published.


Example

"license": "https://example.com/license/MIT"

+

Reference to the license under which the activity list has been published.

+

+
Example +

+

"license": "https://example.com/license/MIT" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/courseinstance.md b/docs/data-model/types/courseinstance.md index 434844f7..af533baf 100644 --- a/docs/data-model/types/courseinstance.md +++ b/docs/data-model/types/courseinstance.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe ## **Fields** ### **Required fields** - + @@ -20,64 +20,98 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "CourseInstance" + Text + Must always be present and set to "type": "CourseInstance"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. @@ -91,29 +125,40 @@ While these properties are marked as optional, a data publisher must provide eit - startDate - - DateTime
- or -
Date + startDate + + DateTime +
- or - +
Date -

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

- - +### **Recommended fields** -### **Recommended fields** - @@ -124,128 +169,211 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Optional fields** -### **Optional fields** - @@ -256,159 +384,259 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/creche.md b/docs/data-model/types/creche.md index 2ee2db11..1023ec78 100644 --- a/docs/data-model/types/creche.md +++ b/docs/data-model/types/creche.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Creche" + Text + Must always be present and set to "type": "Creche"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Childcare"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Childcare" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/entrypoint.md b/docs/data-model/types/entrypoint.md index 960e3c97..e487be2c 100644 --- a/docs/data-model/types/entrypoint.md +++ b/docs/data-model/types/entrypoint.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent ## **Fields** ### **Required fields** - + @@ -20,42 +20,49 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent - - - + - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "EntryPoint" + Text + Must always be present and set to "type": "EntryPoint"
encodingType - Text + encodingType - Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json" + Text + Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json"
httpMethod - Text + httpMethod + Text -

An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.


Example

"httpMethod": "POST"

+

An HTTP method that specifies the appropriate HTTP method for a request + to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.

+

+
Example +

+

"httpMethod": "POST" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

URL of the item


Example

"urlTemplate": "https://example.com/orders{/var}"

+

URL of the item

+

+
Example +

+

"urlTemplate": "https://example.com/orders{/var}" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/event.md b/docs/data-model/types/event.md index bfc679e5..86f41707 100644 --- a/docs/data-model/types/event.md +++ b/docs/data-model/types/event.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,64 +20,98 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Event" + Text + Must always be present and set to "type": "Event"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. @@ -91,29 +125,40 @@ While these properties are marked as optional, a data publisher must provide eit - startDate - - DateTime
- or -
Date + startDate + + DateTime +
- or - +
Date -

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

- - +### **Recommended fields** -### **Recommended fields** - @@ -124,128 +169,211 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Optional fields** -### **Optional fields** - @@ -256,159 +384,259 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/eventseries.md b/docs/data-model/types/eventseries.md index 7f3bc1b4..eedbe82d 100644 --- a/docs/data-model/types/eventseries.md +++ b/docs/data-model/types/eventseries.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi ## **Fields** ### **Required fields** - + @@ -20,56 +20,77 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "EventSeries" + Text + Must always be present and set to "type": "EventSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,110 +101,175 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

+### **Optional fields** - -### **Optional fields** - @@ -194,186 +280,317 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/facilityuse.md b/docs/data-model/types/facilityuse.md index c9e80ea3..eccc90b5 100644 --- a/docs/data-model/types/facilityuse.md +++ b/docs/data-model/types/facilityuse.md @@ -4,12 +4,10 @@ description: This page describes the FacilityUse type. # FacilityUse - - ## **Fields** ### **Required fields** - + @@ -20,65 +18,80 @@ description: This page describes the FacilityUse type. - - - + - - + - - + - - + - - - + + - - + -
type - Text + type - Must always be present and set to "type": "FacilityUse" + Text + Must always be present and set to "type": "FacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + a facility use.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the facility use will take place.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the facility use


Example

"name": "Speedball"

+

The name of the facility use

+

+
Example +

+

"name": "Speedball" +

provider - - -

The organisation responsible for providing the facility

+ 		provider The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"

+

A URL to a web page (or section of a page) that describes the facility + use.

+

+
Example +

+

"url": "https://example.com/facility-use/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -89,65 +102,86 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/facility-use/112345" +

description - Text + description + Text -

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the facility use

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

event - Array of Slot + event + Array of Slot -

An array of slots of availability of this FacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 3,
    "maximumUses": 6
  }
]

+

An array of slots of availability of this FacilityUse.

+

+
Example +

+

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 3,
"maximumUses": 6
}
] +

hoursAvailable - Array of OpeningHoursSpecification + hoursAvailable -

The times the facility use is available

+ 		Array of OpeningHoursSpecification The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the facility use, e.g. a photo taken at + a previous event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

- +### **Optional fields** -### **Optional fields** - @@ -158,78 +192,136 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."

+

Provides additional notes and instructions for users of a facility. E.g. + more information on how to find it, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]

+

Provides a set of tags that help categorise and describe a facility.

+

+
Example +

+

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

individualFacilityUse - Array of IndividualFacilityUse + individualFacilityUse + Array of IndividualFacilityUse -

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court).


Example

"individualFacilityUse": [
  {
    "type": "IndividualFacilityUse",
    "id": "http://www.example.org/facility-uses/1",
    "name": "Tennis Court 1"
  }
]

+

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse + (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse + (e.g. an opportunity to play tennis on a specific court).

+

+
Example +

+

"individualFacilityUse": [
{
"type": "IndividualFacilityUse",
"id": "http://www.example.org/facility-uses/1",
"name": "Tennis Court 1"
}
] +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

- - + \ No newline at end of file diff --git a/docs/data-model/types/geocoordinates.md b/docs/data-model/types/geocoordinates.md index 8d98bd79..279b2904 100644 --- a/docs/data-model/types/geocoordinates.md +++ b/docs/data-model/types/geocoordinates.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "GeoCoordinates" + Text + Must always be present and set to "type": "GeoCoordinates"
latitude - Float + latitude + Float -

The latitude of a location. For example 51.522338 (WGS 84).


Example

"latitude": 51.522338

+

The latitude of a location. For example 51.522338 (WGS 84).

+

+
Example +

+

"latitude": 51.522338 +

longitude - Float + longitude + Float -

The longitude of a location. For example -0.083437 (WGS 84).


Example

"longitude": -0.083437

+

The longitude of a location. For example -0.083437 (WGS 84).

+

+
Example +

+

"longitude": -0.083437 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/headlineevent.md b/docs/data-model/types/headlineevent.md index 0e5406ab..f4872e89 100644 --- a/docs/data-model/types/headlineevent.md +++ b/docs/data-model/types/headlineevent.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,74 +20,116 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "HeadlineEvent" + Text + Must always be present and set to "type": "HeadlineEvent"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -98,119 +140,194 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

+### **Optional fields** - -### **Optional fields** - @@ -221,150 +338,244 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/imageobject.md b/docs/data-model/types/imageobject.md index cdbb0626..3d0cafa7 100644 --- a/docs/data-model/types/imageobject.md +++ b/docs/data-model/types/imageobject.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im ## **Fields** ### **Required fields** - + @@ -20,48 +20,31 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im - - - - - - - - - - -
type - Text + type - Must always be present and set to "type": "ImageObject" + Text
url - url + Must always be present and set to "type": "ImageObject" -

The URL for the display resolution image.


Example

"url": "http://example.com/static/image/speedball_large.jpg"

-
- - -### **Optional fields** - - - - - - - - - - - + -
PropertyExpected TypeDescription
thumbnail - Array of ImageObject + url + url -

The URL for a thumbnail image for an image.

+

The URL for the display resolution image.

+

+
Example +

+

"url": "http://example.com/static/image/speedball_large.jpg" +

+### **Optional fields** +| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **thumbnail** | Array of [`ImageObject`](https://docs.openactive.io/data-model/types/imageobject) | The URL for a thumbnail image for an image. | diff --git a/docs/data-model/types/individualfacilityuse.md b/docs/data-model/types/individualfacilityuse.md index 796fea75..ba69fdef 100644 --- a/docs/data-model/types/individualfacilityuse.md +++ b/docs/data-model/types/individualfacilityuse.md @@ -4,12 +4,10 @@ description: This page describes the IndividualFacilityUse type. # IndividualFacilityUse - - ## **Fields** ### **Required fields** - + @@ -20,65 +18,80 @@ description: This page describes the IndividualFacilityUse type. - - - + - - + - - + - - + - - - + + - - + -
type - Text + type - Must always be present and set to "type": "IndividualFacilityUse" + Text + Must always be present and set to "type": "IndividualFacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + a facility use.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the facility use will take place.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the facility use


Example

"name": "Speedball"

+

The name of the facility use

+

+
Example +

+

"name": "Speedball" +

provider - - -

The organisation responsible for providing the facility

+ 		provider The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"

+

A URL to a web page (or section of a page) that describes the facility + use.

+

+
Example +

+

"url": "https://example.com/facility-use/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -89,65 +102,81 @@ description: This page describes the IndividualFacilityUse type. - - + - - - + - - + - - + - - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/facility-use/112345" +

aggregateFacilityUse - FacilityUse + aggregateFacilityUse -

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location).

+ 		FacilityUse Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse + (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse + (e.g. an opportunity to play tennis at a specific location).
description - Text + description + Text -

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the facility use

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

event - Array of Slot + event + Array of Slot -

An array of slots of availability of this IndividualFacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 0,
    "maximumUses": 1
  }
]

+

An array of slots of availability of this IndividualFacilityUse.

+

+
Example +

+

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 0,
"maximumUses": 1
}
] +

hoursAvailable - Array of OpeningHoursSpecification + hoursAvailable -

The times the facility use is available

+ 		Array of OpeningHoursSpecification The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the facility use, e.g. a photo taken at + a previous event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

- +### **Optional fields** -### **Optional fields** - @@ -158,78 +187,134 @@ description: This page describes the IndividualFacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."

+

Provides additional notes and instructions for users of a facility. E.g. + more information on how to find it, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]

+

Provides a set of tags that help categorise and describe a facility.

+

+
Example +

+

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

- - + \ No newline at end of file diff --git a/docs/data-model/types/locationfeaturespecification.md b/docs/data-model/types/locationfeaturespecification.md index 6962df6d..1b719113 100644 --- a/docs/data-model/types/locationfeaturespecification.md +++ b/docs/data-model/types/locationfeaturespecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "LocationFeatureSpecification" + Text + Must always be present and set to "type": "LocationFeatureSpecification"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Bike Shed"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Bike Shed" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/lockers.md b/docs/data-model/types/lockers.md index ad1972ce..6db45ee7 100644 --- a/docs/data-model/types/lockers.md +++ b/docs/data-model/types/lockers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Lockers" + Text + Must always be present and set to "type": "Lockers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Indoor Lockers"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Indoor Lockers" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/offer.md b/docs/data-model/types/offer.md index 3c608cdc..54853835 100644 --- a/docs/data-model/types/offer.md +++ b/docs/data-model/types/offer.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), ## **Fields** ### **Required fields** - + @@ -20,29 +20,33 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - - + - - + -
type - Text + type - Must always be present and set to "type": "Offer" + Text + Must always be present and set to "type": "Offer"
price - Float + price + Float -

The offer price of the activity.

This price should be specified without currency symbols and as a floating point number with two decimal places.

The currency of the price should be expressed in the priceCurrency field.


Example

"price": 33

+

The offer price of the activity.

+

This price should be specified without currency symbols and as a floating + point number with two decimal places.

+

The currency of the price should be expressed in the priceCurrency field.

+

+
Example +

+

"price": 33 +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,56 +57,82 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/offer/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/offer/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

name - Text + name + Text -

A human readable name for the offer.


Example

"name": "Speedball winger position"

+

A human readable name for the offer.

+

+
Example +

+

"name": "Speedball winger position" +

priceCurrency - Text + priceCurrency + Text -

The currency (in 3-letter ISO 4217 format) of the price.

If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified.


Example

"priceCurrency": "GBP"

+

The currency (in 3-letter ISO 4217 format) of the price.

+

If an Offer has a zero price, then this property is not required. Otherwise + the currency must be specified.

+

+
Example +

+

"priceCurrency": "GBP" +

url - url + url + url -

URL describing the offer


Example

"url": "http://www.rphs.org.uk/"

+

URL describing the offer

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- +### **Optional fields** -### **Optional fields** - @@ -113,33 +143,56 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + + - - + -
advanceBooking - RequiredStatusType + advanceBooking + RequiredStatusType -

Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either.


Example

"advanceBooking": "https://openactive.io/Required"

+

Indicates whether to accept this offer, a participant must book in advance, + whether they must pay on attending, or have option to do either.

+

+
Example +

+

"advanceBooking": "https://openactive.io/Required" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

prepayment - RequiredStatusType + prepayment + RequiredStatusType -

Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either.


Example

"prepayment": "https://openactive.io/Required"

+

Indicates whether to accept this offer, a participant must pay in advance, + pay when attending, or have the option to do either.

+

+
Example +

+

"prepayment": "https://openactive.io/Required" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/openinghoursspecification.md b/docs/data-model/types/openinghoursspecification.md index 1340d446..bf25b3da 100644 --- a/docs/data-model/types/openinghoursspecification.md +++ b/docs/data-model/types/openinghoursspecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ ## **Fields** ### **Required fields** - + @@ -20,42 +20,54 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ - - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "OpeningHoursSpecification" + Text + Must always be present and set to "type": "OpeningHoursSpecification"
closes - Time + closes + Time -

The closing time.


Example

"closes": "17:00"

+

The closing time.

+

+
Example +

+

"closes": "17:00" +

dayOfWeek - DayOfWeek + dayOfWeek + DayOfWeek -

Defines the day of the week upon which the Place is open


Example

"dayOfWeek": "https://schema.org/Monday"

+

Defines the day of the week upon which the Place is open

+

+
Example +

+

"dayOfWeek": "https://schema.org/Monday" +

opens - Time + opens + Time -

The opening time.


Example

"opens": "09:00"

+

The opening time.

+

+
Example +

+

"opens": "09:00" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/organization.md b/docs/data-model/types/organization.md index 2c7ef789..52c565df 100644 --- a/docs/data-model/types/organization.md +++ b/docs/data-model/types/organization.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - - + - - + -
type - Text + type - Must always be present and set to "type": "Organization" + Text + Must always be present and set to "type": "Organization"
name - Text + name + Text -

The name of the Organization


Example

"name": "Central Speedball Association"

+

The name of the Organization

+

+
Example +

+

"name": "Central Speedball Association" +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,47 +54,65 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/organization/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/organization/12345" +

sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated with the organization.


Example

"sameAs": [
  "https://www.facebook.com/everyoneactive/",
  "https://twitter.com/everyoneactive"
]

+

Lists the URL(s) of the official social media profile pages associated + with the organization.

+

+
Example +

+

"sameAs": [
"https://www.facebook.com/everyoneactive/",
"https://twitter.com/everyoneactive"
] +

telephone - Text + telephone + Text -

The telephone number of the Organization


Example

"telephone": "01234 567890"

+

The telephone number of the Organization

+

+
Example +

+

"telephone": "01234 567890" +

url - url + url + url -

A definitive canonical URL for the Organization.


Example

"url": "http://www.speedball-world.com"

+

A definitive canonical URL for the Organization.

+

+
Example +

+

"url": "http://www.speedball-world.com" +

- +### **Optional fields** -### **Optional fields** - @@ -104,33 +123,54 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + + - - + -
description - Text + description + Text -

The description of the Organization


Example

"description": "The national governing body of cycling"

+

The description of the Organization

+

+
Example +

+

"description": "The national governing body of cycling" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

logo - ImageObject + logo + ImageObject -

A logo for the Organization.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

A logo for the Organization.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/parking.md b/docs/data-model/types/parking.md index 1d5b05bd..d18ce763 100644 --- a/docs/data-model/types/parking.md +++ b/docs/data-model/types/parking.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Parking" + Text + Must always be present and set to "type": "Parking"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Roadside Parking"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Roadside Parking" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/partialschedule.md b/docs/data-model/types/partialschedule.md index 852a2ca8..b8cc1d8c 100644 --- a/docs/data-model/types/partialschedule.md +++ b/docs/data-model/types/partialschedule.md @@ -9,31 +9,13 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "PartialSchedule" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "PartialSchedule"` | ### **Recommended fields** - + @@ -44,38 +26,51 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + -
endTime - Time + endTime + Time -

The end time of the event.


Example

"endTime": "12:00:00"

+

The end time of the event.

+

+
Example +

+

"endTime": "12:00:00" +

repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

startTime - Time + startTime + Time -

The start time of the event.


Example

"startTime": "12:00:00"

+

The start time of the event.

+

+
Example +

+

"startTime": "12:00:00" +

- +### **Optional fields** -### **Optional fields** - @@ -86,105 +81,172 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek
- or -
Array of Text + 		byDay + Array of DayOfWeek +
- or - +
Array of Text 		-

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - Date + endDate + Date -

The end date of the schedule.


Example

"endDate": "2018-01-27"

+

The end date of the schedule.

+

+
Example +

+

"endDate": "2018-01-27" +

exceptDate - Array of Date
- or -
Array of DateTime + 		exceptDate + Array of Date +
- or - +
Array of DateTime 		-

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]

+

Exception dates where the schedule should not generate an event.

+

+
Example +

+

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] +

idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + identifier (@id) for every event described by the schedule (see below for + more information). This property is required if the data provider is supporting + third-party booking via the Open Booking API.

+

+
Example +

+

"idTemplate": "https://example.com/event{/id}" +

repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3

+

Defines the number of times a recurring Event will take place.

+

+
Example +

+

"repeatCount": 3 +

scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.


Example

"scheduledEventType": "Event"

+

The type of event this schedule related to.

+

+
Example +

+

"scheduledEventType": "Event" +

startDate - Date + startDate + Date -

The start date of the event.


Example

"startDate": "2018-01-27"

+

The start date of the event.

+

+
Example +

+

"startDate": "2018-01-27" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + URL (schema:url) for every event described by the schedule (see below for + more information). This property is required if the data provider wants + to provide participants with a unique URL to book to attend an event.

+

+
Example +

+

"urlTemplate": "https://example.com/event{/id}" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/person.md b/docs/data-model/types/person.md index 9c59018e..032f9e42 100644 --- a/docs/data-model/types/person.md +++ b/docs/data-model/types/person.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "Person" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "Person"` | ### **Recommended fields** - + @@ -44,20 +26,22 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/person/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/person/12345" +

+### **Optional fields** - -### **Optional fields** - @@ -68,69 +52,113 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + - - - + + - - + - - + - - + - - + - - + -
description - Text + description + Text -

The description of the Person


Example

"description": "The leader of the coaching team"

+

The description of the Person

+

+
Example +

+

"description": "The leader of the coaching team" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

logo - ImageObject + logo + ImageObject -

A logo for the person.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

A logo for the person.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

name - Text + name + Text -

A full name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"name": "Daley Thompson"

+

A full name for the person.

+

This person must give direct permission for their personal information + to be shared as part of the Open Data.

+

+
Example +

+

"name": "Daley Thompson" +

sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated with the person.


Example

"sameAs": "https://example.org/example-org"

+

Lists the URL(s) of the official social media profile pages associated + with the person.

+

+
Example +

+

"sameAs": "https://example.org/example-org" +

telephone - Text + telephone + Text -

The telephone number of the person


Example

"telephone": "01234 567890"

+

The telephone number of the person

+

+
Example +

+

"telephone": "01234 567890" +

url - url + url + url -

A URL where more information about the person may be found


Example

"url": "http://www.example.com/"

+

A URL where more information about the person may be found

+

+
Example +

+

"url": "http://www.example.com/" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/place.md b/docs/data-model/types/place.md index 65e2a20c..ce250875 100644 --- a/docs/data-model/types/place.md +++ b/docs/data-model/types/place.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - - + - - + -
type - Text + type - Must always be present and set to "type": "Place" + Text + Must always be present and set to "type": "Place"
name - Text + name + Text -

The name of the Place


Example

"name": "Raynes Park High School"

+

The name of the Place

+

+
Example +

+

"name": "Raynes Park High School" +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,92 +54,134 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - + - - + - - + - - + - - + - - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/place/12345" +

address - PostalAddress
- or -
Text + 		address + PostalAddress +
- or - +
Text 		-

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]

+

An array listing the Ammenities of the Place.

+

+
Example +

+

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] +

description - Text + description + Text -

The description of the Place


Example

"description": "Raynes Park High School in London"

+

The description of the Place

+

+
Example +

+

"description": "Raynes Park High School in London" +

geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the place, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

openingHoursSpecification - Array of OpeningHoursSpecification + openingHoursSpecification -

The times the Place is open

+ 		Array of OpeningHoursSpecification The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place


Example

"telephone": "01253 473934"

+

The telephone number for the Place

+

+
Example +

+

"telephone": "01253 473934" +

url - url + url + url -

The website for the Place


Example

"url": "http://www.rphs.org.uk/"

+

The website for the Place

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- +### **Optional fields** -### **Optional fields** - @@ -149,33 +192,54 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - + - - + -
containedInPlace - Place + containedInPlace + Place -

The place within which this Place exists


Example

"containedInPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
  "name": "Middlesbrough Sports Village"
}

+

The place within which this Place exists

+

+
Example +

+

"containedInPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
"name": "Middlesbrough Sports Village"
} +

containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}

+

Places that exist within this place

+

+
Example +

+

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/postaladdress.md b/docs/data-model/types/postaladdress.md index 5b57322a..29028dc7 100644 --- a/docs/data-model/types/postaladdress.md +++ b/docs/data-model/types/postaladdress.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,60 +20,82 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "PostalAddress" + Text + Must always be present and set to "type": "PostalAddress"
addressCountry - Text + addressCountry + Text -

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.


Example

"addressCountry": "GB"

+

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.

+

+
Example +

+

"addressCountry": "GB" +

addressLocality - Text + addressLocality + Text -

The locality, a suburb within a city or a town within a county or district.


Example

"addressLocality": "Shoreditch"

+

The locality, a suburb within a city or a town within a county or district.

+

+
Example +

+

"addressLocality": "Shoreditch" +

addressRegion - Text + addressRegion + Text -

The region, either a city or a county or district.


Example

"addressRegion": "London"

+

The region, either a city or a county or district.

+

+
Example +

+

"addressRegion": "London" +

postalCode - Text + postalCode + Text -

The postal code.


Example

"postalCode": "EC2A 4JE"

+

The postal code.

+

+
Example +

+

"postalCode": "EC2A 4JE" +

streetAddress - Text + streetAddress + Text -

The street address.


Example

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St"

+

The street address.

+

+
Example +

+

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/propertyvalue.md b/docs/data-model/types/propertyvalue.md index 6719f4bb..24b8f082 100644 --- a/docs/data-model/types/propertyvalue.md +++ b/docs/data-model/types/propertyvalue.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,38 +20,46 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "PropertyValue" + Text + Must always be present and set to "type": "PropertyValue"
name - Text + name + Text -

The name of this PropertyValue


Example

"name": "Vendor ID"

+

The name of this PropertyValue

+

+
Example +

+

"name": "Vendor ID" +

value - Text
- or -
Integer + 		value + Text +
- or - +
Integer 		-

The actual value of this identifier


Example

"value": "SB1234"

+

The actual value of this identifier

+

+
Example +

+

"value": "SB1234" +

- +### **Optional fields** -### **Optional fields** - @@ -62,15 +70,20 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + -
propertyID - url
- or -
Text + 		propertyID + url +
- or - +
Text 		-

A commonly used identifier for the characteristic represented by the property


Example

"propertyID": "ActivePlaces"

+

A commonly used identifier for the characteristic represented by the property

+

+
Example +

+

"propertyID": "ActivePlaces" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/quantitativevalue.md b/docs/data-model/types/quantitativevalue.md index 28f57819..86fd4b4b 100644 --- a/docs/data-model/types/quantitativevalue.md +++ b/docs/data-model/types/quantitativevalue.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "QuantitativeValue" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "QuantitativeValue"` | ### **Optional fields** - + @@ -44,24 +26,32 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. - - + - - + -
maxValue - Integer + maxValue + Integer -

The maximum value.


Example

"maxValue": 60

+

The maximum value.

+

+
Example +

+

"maxValue": 60 +

minValue - Integer + minValue + Integer -

The minimum value.


Example

"minValue": 16

+

The minimum value.

+

+
Example +

+

"minValue": 16 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/reserveaction.md b/docs/data-model/types/reserveaction.md index ad053fdd..24dbfc4d 100644 --- a/docs/data-model/types/reserveaction.md +++ b/docs/data-model/types/reserveaction.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ReserveAction" + Text + Must always be present and set to "type": "ReserveAction"
name - Text + name + Text -

The name of the action


Example

"name": "Book"

+

The name of the action

+

+
Example +

+

"name": "Book" +

target - EntryPoint + target + EntryPoint -

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}

+

A definition of the target of the action.

+

+
Example +

+

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/schedule.md b/docs/data-model/types/schedule.md index 9d38742f..8cbe81de 100644 --- a/docs/data-model/types/schedule.md +++ b/docs/data-model/types/schedule.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - + @@ -20,55 +20,72 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Schedule" + Text + Must always be present and set to "type": "Schedule"
endTime - Time + endTime + Time -

The end time of the event.


Example

"endTime": "12:00:00"

+

The end time of the event.

+

+
Example +

+

"endTime": "12:00:00" +

repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.


Example

"scheduledEventType": "Event"

+

The type of event this schedule related to.

+

+
Example +

+

"scheduledEventType": "Event" +

startTime - Time + startTime + Time -

The start time of the event.


Example

"startTime": "12:00:00"

+

The start time of the event.

+

+
Example +

+

"startTime": "12:00:00" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional, a data publisher must provide either a schema:byDay, schema:byMonth or byMonthDay for a schedule. @@ -82,38 +99,56 @@ While these properties are marked as optional, a data publisher must provide eit - byDay - - Array of DayOfWeek
- or -
Array of Text + byDay + + Array of DayOfWeek +
- or - +
Array of Text -

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

- byMonth - - Array of Integer + byMonth + + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

- byMonthDay - - Array of Integer + byMonthDay + + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

- +### **Recommended fields** - -### **Recommended fields** - @@ -124,56 +159,84 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - Date + endDate + Date -

The end date of the schedule.


Example

"endDate": "2018-01-27"

+

The end date of the schedule.

+

+
Example +

+

"endDate": "2018-01-27" +

idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + identifier (@id) for every event described by the schedule (see below for + more information). This property is required if the data provider is supporting + third-party booking via the Open Booking API.

+

+
Example +

+

"idTemplate": "https://example.com/event{/id}" +

startDate - Date + startDate + Date -

The start date of the event.


Example

"startDate": "2018-01-27"

+

The start date of the event.

+

+
Example +

+

"startDate": "2018-01-27" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + URL (schema:url) for every event described by the schedule (see below for + more information). This property is required if the data provider wants + to provide participants with a unique URL to book to attend an event.

+

+
Example +

+

"urlTemplate": "https://example.com/event{/id}" +

+### **Optional fields** - -### **Optional fields** - @@ -184,51 +247,82 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek
- or -
Array of Text + 		byDay + Array of DayOfWeek +
- or - +
Array of Text 		-

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

exceptDate - Array of Date
- or -
Array of DateTime + 		exceptDate + Array of Date +
- or - +
Array of DateTime 		-

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]

+

Exception dates where the schedule should not generate an event.

+

+
Example +

+

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] +

repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3

+

Defines the number of times a recurring Event will take place.

+

+
Example +

+

"repeatCount": 3 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/scheduledsession.md b/docs/data-model/types/scheduledsession.md index 5ae4a10b..f0a7bdcc 100644 --- a/docs/data-model/types/scheduledsession.md +++ b/docs/data-model/types/scheduledsession.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,56 +20,84 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ScheduledSession" + Text + Must always be present and set to "type": "ScheduledSession"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,83 +108,129 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Optional fields** -### **Optional fields** - @@ -167,195 +241,332 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/sessionseries.md b/docs/data-model/types/sessionseries.md index 4c4e26c0..6750a4ba 100644 --- a/docs/data-model/types/sessionseries.md +++ b/docs/data-model/types/sessionseries.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,65 +20,99 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "SessionSeries" + Text + Must always be present and set to "type": "SessionSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -89,83 +123,132 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

- +### **Optional fields** -### **Optional fields** - @@ -176,195 +259,324 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

subEvent - Array of ScheduledSession + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of ScheduledSession Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/showers.md b/docs/data-model/types/showers.md index 33f60e9c..2f7579e1 100644 --- a/docs/data-model/types/showers.md +++ b/docs/data-model/types/showers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Showers" + Text + Must always be present and set to "type": "Showers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Poolside Showers"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Poolside Showers" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/slot.md b/docs/data-model/types/slot.md index 34880694..361b211b 100644 --- a/docs/data-model/types/slot.md +++ b/docs/data-model/types/slot.md @@ -4,12 +4,10 @@ description: This page describes the Slot type. # Slot - - ## **Fields** ### **Required fields** - + @@ -20,55 +18,75 @@ description: This page describes the Slot type. - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Slot" + Text + Must always be present and set to "type": "Slot"
duration - Duration + duration + Duration -

The duration of the slot given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the slot given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

facilityUse - url + facilityUse + url -

URI to the FacilityUse that has this offer


Example

"facilityUse": "https://example.com/facility-use/1"

+

URI to the FacilityUse that has this offer

+

+
Example +

+

"facilityUse": "https://example.com/facility-use/1" +

remainingUses - Integer + remainingUses + Integer -

The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"remainingUses": 5

+

The remaining available courts or pitches at this time. Must be 0 or 1 + for an IndividualFacilityUse.

+

+
Example +

+

"remainingUses": 5 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the slot. Can be specified as a schema:Date or schema:DateTime


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the slot. Can be specified as a schema:Date + or schema:DateTime

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional/recommended in the Modelling Specification, one of these must be provided when surfacing a slot through an RPDE feed to ensure that the slots can be processed correctly by data consumers. @@ -82,29 +100,44 @@ While these properties are marked as optional/recommended in the Modelling Speci - id - - url + id + + url -

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/slot/12345" +

- identifier - - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + identifier + + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer -

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- +### **Recommended fields** - -### **Recommended fields** - @@ -115,29 +148,37 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/slot/12345" +

maximumUses - Integer + maximumUses + Integer -

The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"maximumUses": 16

+

The maximum available courts or pitches at this time. Must be 0 or 1 for + an IndividualFacilityUse.

+

+
Example +

+

"maximumUses": 16 +

- +### **Optional fields** -### **Optional fields** - @@ -148,33 +189,59 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + - - + -
endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the slot. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an slot.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the slot. Can be specified as a schema:Date or + schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an slot.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/sportsactivitylocation.md b/docs/data-model/types/sportsactivitylocation.md index d969ce78..44c23b8e 100644 --- a/docs/data-model/types/sportsactivitylocation.md +++ b/docs/data-model/types/sportsactivitylocation.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "SportsActivityLocation" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "SportsActivityLocation"` | ### **Recommended fields** - + @@ -44,20 +26,22 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/place/12345" +

- +### **Optional fields** -### **Optional fields** - @@ -68,114 +52,184 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - + - - + -
address - PostalAddress
- or -
Text + 		address + PostalAddress +
- or - +
Text 		-

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]

+

An array listing the Ammenities of the Place.

+

+
Example +

+

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] +

containedInPlace - Place
- or -
url + 		containedInPlace + Place +
- or - +
url 		-

While a url is not specified as an option in the Modelling Specification, it is necessary to link entities in RPDE.


Example

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d"

+

While a url is not specified as an option in the Modelling + Specification, it is necessary to link entities in RPDE.

+

+
Example +

+

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d" +

containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}

+

Places that exist within this place

+

+
Example +

+

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} +

description - Text + description + Text -

The description of the Place


Example

"description": "Raynes Park High School in London"

+

The description of the Place

+

+
Example +

+

"description": "Raynes Park High School in London" +

geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the place, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

name - Text + name + Text -

The name of the Place


Example

"name": "Raynes Park High School"

+

The name of the Place

+

+
Example +

+

"name": "Raynes Park High School" +

openingHoursSpecification - Array of OpeningHoursSpecification + openingHoursSpecification -

The times the Place is open

+ 		Array of OpeningHoursSpecification The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place


Example

"telephone": "01253 473934"

+

The telephone number for the Place

+

+
Example +

+

"telephone": "01253 473934" +

url - url + url + url -

The website for the Place


Example

"url": "http://www.rphs.org.uk/"

+

The website for the Place

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/toilets.md b/docs/data-model/types/toilets.md index f5248106..f8e164c9 100644 --- a/docs/data-model/types/toilets.md +++ b/docs/data-model/types/toilets.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Toilets" + Text + Must always be present and set to "type": "Toilets"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Public Toilets"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Public Toilets" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/towels.md b/docs/data-model/types/towels.md index 063eb9c0..14fb351e 100644 --- a/docs/data-model/types/towels.md +++ b/docs/data-model/types/towels.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Towels" + Text + Must always be present and set to "type": "Towels"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Complementary Towels"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Complementary Towels" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/using-data/harvesting-opportunity-data.md b/docs/using-data/harvesting-opportunity-data.md index 21fb0adf..4b8c53a2 100644 --- a/docs/using-data/harvesting-opportunity-data.md +++ b/docs/using-data/harvesting-opportunity-data.md @@ -2,7 +2,7 @@ ## **Introduction** {#introduction} -To follow along you’ll need some existing knowledge of programming, including familiarity with HTTP, JSON, and APIs. +To follow along you’ll need some existing knowledge of programming, including familiarity with HTTP, JSON, and APIs.. This guide is intended to be language agnostic, and is instead a guide to strategy and a general approach that should suit multiple implementations. Where code examples exist, they are intended as quick start assets rather than being production-ready. From 2af85734d1e0a5605e31ed1bb2791a76d04af499 Mon Sep 17 00:00:00 2001 From: Travis CI Date: Thu, 11 Oct 2018 16:09:56 +0000 Subject: [PATCH 02/10] Updating auto-generated model documentation: 75 [ci skip] --- docs/data-model/types/action.md | 41 +- docs/data-model/types/babychanging.md | 36 +- docs/data-model/types/brand.md | 98 ++- docs/data-model/types/changingfacilities.md | 36 +- docs/data-model/types/concept.md | 118 ++-- docs/data-model/types/conceptscheme.md | 101 ++-- docs/data-model/types/courseinstance.md | 570 ++++++------------ docs/data-model/types/creche.md | 36 +- docs/data-model/types/entrypoint.md | 51 +- docs/data-model/types/event.md | 570 ++++++------------ docs/data-model/types/eventseries.md | 535 +++++----------- docs/data-model/types/facilityuse.md | 292 +++------ docs/data-model/types/geocoordinates.md | 41 +- docs/data-model/types/headlineevent.md | 521 +++++----------- docs/data-model/types/imageobject.md | 51 +- .../data-model/types/individualfacilityuse.md | 287 ++++----- .../types/locationfeaturespecification.md | 36 +- docs/data-model/types/lockers.md | 36 +- docs/data-model/types/offer.md | 163 ++--- .../types/openinghoursspecification.md | 54 +- docs/data-model/types/organization.md | 142 ++--- docs/data-model/types/parking.md | 36 +- docs/data-model/types/partialschedule.md | 232 +++---- docs/data-model/types/person.md | 154 ++--- docs/data-model/types/place.md | 204 +++---- docs/data-model/types/postaladdress.md | 80 +-- docs/data-model/types/propertyvalue.md | 63 +- docs/data-model/types/quantitativevalue.md | 56 +- docs/data-model/types/reserveaction.md | 41 +- docs/data-model/types/schedule.md | 272 +++------ docs/data-model/types/scheduledsession.md | 511 +++++----------- docs/data-model/types/sessionseries.md | 522 +++++----------- docs/data-model/types/showers.md | 36 +- docs/data-model/types/slot.md | 201 ++---- .../types/sportsactivitylocation.md | 218 +++---- docs/data-model/types/toilets.md | 36 +- docs/data-model/types/towels.md | 36 +- 37 files changed, 2222 insertions(+), 4291 deletions(-) diff --git a/docs/data-model/types/action.md b/docs/data-model/types/action.md index 69ab11b0..6a2d7d3c 100644 --- a/docs/data-model/types/action.md +++ b/docs/data-model/types/action.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Action" + + Must always be present and set to "type": "Action"
name - Text + name + Text -

The name of the action

-

-
Example -

-

"name": "Book" -

+

The name of the action


Example

"name": "Book"
target - EntryPoint + target + EntryPoint -

A definition of the target of the action.

-

-
Example -

-

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} -

+

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/babychanging.md b/docs/data-model/types/babychanging.md index 96aacca1..afddc50c 100644 --- a/docs/data-model/types/babychanging.md +++ b/docs/data-model/types/babychanging.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "BabyChanging" + + Must always be present and set to "type": "BabyChanging"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Baby Changing Facilities" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Baby Changing Facilities"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/brand.md b/docs/data-model/types/brand.md index c4584376..80615e68 100644 --- a/docs/data-model/types/brand.md +++ b/docs/data-model/types/brand.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), ## **Fields** ### **Required fields** - + @@ -20,44 +20,38 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Brand" + + Must always be present and set to "type": "Brand"
name - Text + name + Text -

The name of the brand.

-

-
Example -

-

"name": "Play Ball!" -

+

The name of the brand.


Example

"name": "Play Ball!"
url - url + url + url -

A url where further information can be found for the brand.

-

-
Example -

-

"url": "http://example.com/play_ball" -

+

A url where further information can be found for the brand.


Example

"url": "http://example.com/play_ball"
### **Recommended fields** + + +### **Recommended fields** + @@ -68,36 +62,29 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - + -
description - Text + description + Text -

A text description for the brand.

-

-
Example -

-

"description": "Play Ball! is a series of games for people of all abilities." -

+

A text description for the brand.


Example

"description": "Play Ball! is a series of games for people of all abilities."
logo - ImageObject + logo + ImageObject -

The logo associated with the brand.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

The logo associated with the brand.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
### **Optional fields** + + +### **Optional fields** + @@ -108,26 +95,15 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + -
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "BR1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "BR1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/changingfacilities.md b/docs/data-model/types/changingfacilities.md index c6a201ef..2b65ac39 100644 --- a/docs/data-model/types/changingfacilities.md +++ b/docs/data-model/types/changingfacilities.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "ChangingFacilities" + + Must always be present and set to "type": "ChangingFacilities"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Changing Rooms" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Changing Rooms"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/concept.md b/docs/data-model/types/concept.md index 8fe8e544..367ffb27 100644 --- a/docs/data-model/types/concept.md +++ b/docs/data-model/types/concept.md @@ -4,12 +4,12 @@ description: This page describes the Concept type. # Concept -This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http://www.w3.org/2004/02/skos/core#Concept). +This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://www.w3.org/2004/02/skos/core#Concept). ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Concept" + + Must always be present and set to "type": "Concept"
prefLabel - Text + prefLabel + Text -

A human readable string for use in user interfaces.

-

-
Example -

-

"prefLabel": "Speedball" -

+

A human readable string for use in user interfaces.


Example

"prefLabel": "Speedball"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,36 +53,29 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/concept/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/concept/12345"
inScheme - url + inScheme + url -

A stable URL reference for the taxonomy.

-

-
Example -

-

"inScheme": "https://example.com/reference/activities" -

+

A stable URL reference for the taxonomy.


Example

"inScheme": "https://example.com/reference/activities"
### **Optional fields** + + +### **Optional fields** + @@ -94,60 +86,42 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - + - - + - - + -
altLabel - Array of Text + altLabel + Array of Text -

An alternative human readable string for use in user interfaces.

-

-
Example -

-

"altLabel": "Speedball" -

+

An alternative human readable string for use in user interfaces.


Example

"altLabel": "Speedball"
broader - Array of url + broader + Array of url -

A broader Concept URI

-

-
Example -

-

"broader": "https://example.com/football" -

+

A broader Concept URI


Example

"broader": "https://example.com/football"
narrower - Array of url + narrower + Array of url -

A more specific concept URI

-

-
Example -

-

"narrower": "https://example.com/walking-football" -

+

A more specific concept URI


Example

"narrower": "https://example.com/walking-football"
notation - Text + notation + Text -

A concept label that is not normally recognisable as natural language.

-

-
Example -

-

"notation": "Speedball" -

+

A concept label that is not normally recognisable as natural language.


Example

"notation": "Speedball"
\ No newline at end of file + + + diff --git a/docs/data-model/types/conceptscheme.md b/docs/data-model/types/conceptscheme.md index aa531e69..d3acfe5e 100644 --- a/docs/data-model/types/conceptscheme.md +++ b/docs/data-model/types/conceptscheme.md @@ -4,12 +4,12 @@ description: This page describes the ConceptScheme type. # ConceptScheme -This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). +This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). ## **Fields** ### **Required fields** - + @@ -20,73 +20,56 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](h - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ConceptScheme" + + Must always be present and set to "type": "ConceptScheme"
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/scheme/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/scheme/12345"
concept - Array of Concept + concept + Array of Concept -

A collection of concepts that are part of this scheme

-

-
Example -

-

"concept": [
{
"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"
}
] -

+

A collection of concepts that are part of this scheme


Example

"concept": [
  {
    "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"
  }
]
title - Text + title + Text -

The title of the scheme

-

-
Example -

-

"title": "Activity List" -

+

The title of the scheme


Example

"title": "Activity List"
url - url + url + url -

A URL to a web page (or section of a page) that describes the concept - scheme.

-

-
Example -

-

"url": "https://example.com/scheme/1234" -

+

A URL to a web page (or section of a page) that describes the concept scheme.


Example

"url": "https://example.com/scheme/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -97,32 +80,24 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](h - - + - - + -
description - Text + description + Text -

A free text description of the taxonomy

-

-
Example -

-

"description": "An example activity list." -

+

A free text description of the taxonomy


Example

"description": "An example activity list."
license - url + license + url -

Reference to the license under which the activity list has been published.

-

-
Example -

-

"license": "https://example.com/license/MIT" -

+

Reference to the license under which the activity list has been published.


Example

"license": "https://example.com/license/MIT"
\ No newline at end of file + + + diff --git a/docs/data-model/types/courseinstance.md b/docs/data-model/types/courseinstance.md index af533baf..434844f7 100644 --- a/docs/data-model/types/courseinstance.md +++ b/docs/data-model/types/courseinstance.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe ## **Fields** ### **Required fields** - + @@ -20,98 +20,64 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "CourseInstance" + + Must always be present and set to "type": "CourseInstance"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. @@ -125,40 +91,29 @@ While these properties are marked as optional, a data publisher must provide eit - startDate - - DateTime -
- or - -
Date + startDate + + DateTime
- or -
Date -

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

-### **Recommended fields** + + +### **Recommended fields** + @@ -169,211 +124,128 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Optional fields** + + +### **Optional fields** + @@ -384,259 +256,159 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/creche.md b/docs/data-model/types/creche.md index 1023ec78..2ee2db11 100644 --- a/docs/data-model/types/creche.md +++ b/docs/data-model/types/creche.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Creche" + + Must always be present and set to "type": "Creche"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Childcare" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Childcare"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/entrypoint.md b/docs/data-model/types/entrypoint.md index e487be2c..960e3c97 100644 --- a/docs/data-model/types/entrypoint.md +++ b/docs/data-model/types/entrypoint.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent ## **Fields** ### **Required fields** - + @@ -20,49 +20,42 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent - - + - - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "EntryPoint" + + Must always be present and set to "type": "EntryPoint"
encodingType - Text + encodingType + Text Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json" + + Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json"
httpMethod - Text + httpMethod + Text -

An HTTP method that specifies the appropriate HTTP method for a request - to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.

-

-
Example -

-

"httpMethod": "POST" -

+

An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.


Example

"httpMethod": "POST"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

URL of the item

-

-
Example -

-

"urlTemplate": "https://example.com/orders{/var}" -

+

URL of the item


Example

"urlTemplate": "https://example.com/orders{/var}"
\ No newline at end of file + + + diff --git a/docs/data-model/types/event.md b/docs/data-model/types/event.md index 86f41707..bfc679e5 100644 --- a/docs/data-model/types/event.md +++ b/docs/data-model/types/event.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,98 +20,64 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Event" + + Must always be present and set to "type": "Event"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. @@ -125,40 +91,29 @@ While these properties are marked as optional, a data publisher must provide eit - startDate - - DateTime -
- or - -
Date + startDate + + DateTime
- or -
Date -

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

-### **Recommended fields** + + +### **Recommended fields** + @@ -169,211 +124,128 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Optional fields** + + +### **Optional fields** + @@ -384,259 +256,159 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/eventseries.md b/docs/data-model/types/eventseries.md index eedbe82d..7f3bc1b4 100644 --- a/docs/data-model/types/eventseries.md +++ b/docs/data-model/types/eventseries.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi ## **Fields** ### **Required fields** - + @@ -20,77 +20,56 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "EventSeries" + + Must always be present and set to "type": "EventSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -101,175 +80,110 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
### **Optional fields** + + +### **Optional fields** + @@ -280,317 +194,186 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/facilityuse.md b/docs/data-model/types/facilityuse.md index eccc90b5..c9e80ea3 100644 --- a/docs/data-model/types/facilityuse.md +++ b/docs/data-model/types/facilityuse.md @@ -4,10 +4,12 @@ description: This page describes the FacilityUse type. # FacilityUse + + ## **Fields** ### **Required fields** - + @@ -18,80 +20,65 @@ description: This page describes the FacilityUse type. - - + - - - + - - + - - + - + + - - - - + -
type - Text + type + Text Must always be present and set to "type": "FacilityUse" + + Must always be present and set to "type": "FacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - a facility use.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the facility use will take place.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the facility use

-

-
Example -

-

"name": "Speedball" -

+

The name of the facility use


Example

"name": "Speedball"
provider + provider + + +

The organisation responsible for providing the facility

The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility - use.

-

-
Example -

-

"url": "https://example.com/facility-use/1234" -

+

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -102,86 +89,65 @@ description: This page describes the FacilityUse type. - - + - - + - - + - + - - - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/facility-use/112345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"
description - Text + description + Text -

A free text description of the facility use

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."
event - Array of Slot + event + Array of Slot -

An array of slots of availability of this FacilityUse.

-

-
Example -

-

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 3,
"maximumUses": 6
}
] -

+

An array of slots of availability of this FacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 3,
    "maximumUses": 6
  }
]
hoursAvailable + hoursAvailable + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the facility use is available

The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at - a previous event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
### **Optional fields** + + +### **Optional fields** + @@ -192,136 +158,78 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. - more information on how to find it, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." -

+

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.

-

-
Example -

-

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] -

+

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
individualFacilityUse - Array of IndividualFacilityUse + individualFacilityUse + Array of IndividualFacilityUse -

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse - (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse - (e.g. an opportunity to play tennis on a specific court).

-

-
Example -

-

"individualFacilityUse": [
{
"type": "IndividualFacilityUse",
"id": "http://www.example.org/facility-uses/1",
"name": "Tennis Court 1"
}
] -

+

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court).


Example

"individualFacilityUse": [
  {
    "type": "IndividualFacilityUse",
    "id": "http://www.example.org/facility-uses/1",
    "name": "Tennis Court 1"
  }
]
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
\ No newline at end of file + + + diff --git a/docs/data-model/types/geocoordinates.md b/docs/data-model/types/geocoordinates.md index 279b2904..8d98bd79 100644 --- a/docs/data-model/types/geocoordinates.md +++ b/docs/data-model/types/geocoordinates.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "GeoCoordinates" + + Must always be present and set to "type": "GeoCoordinates"
latitude - Float + latitude + Float -

The latitude of a location. For example 51.522338 (WGS 84).

-

-
Example -

-

"latitude": 51.522338 -

+

The latitude of a location. For example 51.522338 (WGS 84).


Example

"latitude": 51.522338
longitude - Float + longitude + Float -

The longitude of a location. For example -0.083437 (WGS 84).

-

-
Example -

-

"longitude": -0.083437 -

+

The longitude of a location. For example -0.083437 (WGS 84).


Example

"longitude": -0.083437
\ No newline at end of file + + + diff --git a/docs/data-model/types/headlineevent.md b/docs/data-model/types/headlineevent.md index f4872e89..0e5406ab 100644 --- a/docs/data-model/types/headlineevent.md +++ b/docs/data-model/types/headlineevent.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,116 +20,74 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "HeadlineEvent" + + Must always be present and set to "type": "HeadlineEvent"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -140,194 +98,119 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
### **Optional fields** + + +### **Optional fields** + @@ -338,244 +221,150 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/imageobject.md b/docs/data-model/types/imageobject.md index 3d0cafa7..cdbb0626 100644 --- a/docs/data-model/types/imageobject.md +++ b/docs/data-model/types/imageobject.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im ## **Fields** ### **Required fields** - + @@ -20,31 +20,48 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im - - + - - + - + + +
type - Text + type + Text Must always be present and set to "type": "ImageObject" + + Must always be present and set to "type": "ImageObject"
url + url + url url + +

The URL for the display resolution image.


Example

"url": "http://example.com/static/image/speedball_large.jpg"

+
+ + +### **Optional fields** + + + + + + + + + + + + + -
PropertyExpected TypeDescription
thumbnail + Array of ImageObject -

The URL for the display resolution image.

-

-
Example -

-

"url": "http://example.com/static/image/speedball_large.jpg" -

+

The URL for a thumbnail image for an image.
### **Optional fields** + -| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **thumbnail** | Array of [`ImageObject`](https://docs.openactive.io/data-model/types/imageobject) | The URL for a thumbnail image for an image. | diff --git a/docs/data-model/types/individualfacilityuse.md b/docs/data-model/types/individualfacilityuse.md index ba69fdef..796fea75 100644 --- a/docs/data-model/types/individualfacilityuse.md +++ b/docs/data-model/types/individualfacilityuse.md @@ -4,10 +4,12 @@ description: This page describes the IndividualFacilityUse type. # IndividualFacilityUse + + ## **Fields** ### **Required fields** - + @@ -18,80 +20,65 @@ description: This page describes the IndividualFacilityUse type. - - + - - - + - - + - - + - + + - - - - + -
type - Text + type + Text Must always be present and set to "type": "IndividualFacilityUse" + + Must always be present and set to "type": "IndividualFacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - a facility use.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the facility use will take place.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the facility use

-

-
Example -

-

"name": "Speedball" -

+

The name of the facility use


Example

"name": "Speedball"
provider + provider + + +

The organisation responsible for providing the facility

The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility - use.

-

-
Example -

-

"url": "https://example.com/facility-use/1234" -

+

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -102,81 +89,65 @@ description: This page describes the IndividualFacilityUse type. - - + - + - - - - + - - + - + - - - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/facility-use/112345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"
aggregateFacilityUse + aggregateFacilityUse + FacilityUse FacilityUse + +

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location).

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse - (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse - (e.g. an opportunity to play tennis at a specific location).
description - Text + description + Text -

A free text description of the facility use

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."
event - Array of Slot + event + Array of Slot -

An array of slots of availability of this IndividualFacilityUse.

-

-
Example -

-

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 0,
"maximumUses": 1
}
] -

+

An array of slots of availability of this IndividualFacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 0,
    "maximumUses": 1
  }
]
hoursAvailable + hoursAvailable + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the facility use is available

The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at - a previous event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
### **Optional fields** + + +### **Optional fields** + @@ -187,134 +158,78 @@ description: This page describes the IndividualFacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. - more information on how to find it, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." -

+

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.

-

-
Example -

-

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] -

+

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
\ No newline at end of file + + + diff --git a/docs/data-model/types/locationfeaturespecification.md b/docs/data-model/types/locationfeaturespecification.md index 1b719113..6962df6d 100644 --- a/docs/data-model/types/locationfeaturespecification.md +++ b/docs/data-model/types/locationfeaturespecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "LocationFeatureSpecification" + + Must always be present and set to "type": "LocationFeatureSpecification"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Bike Shed" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Bike Shed"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/lockers.md b/docs/data-model/types/lockers.md index 6db45ee7..ad1972ce 100644 --- a/docs/data-model/types/lockers.md +++ b/docs/data-model/types/lockers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Lockers" + + Must always be present and set to "type": "Lockers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Indoor Lockers" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Indoor Lockers"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/offer.md b/docs/data-model/types/offer.md index 54853835..3c608cdc 100644 --- a/docs/data-model/types/offer.md +++ b/docs/data-model/types/offer.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), ## **Fields** ### **Required fields** - + @@ -20,33 +20,29 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Offer" + + Must always be present and set to "type": "Offer"
price - Float + price + Float -

The offer price of the activity.

-

This price should be specified without currency symbols and as a floating - point number with two decimal places.

-

The currency of the price should be expressed in the priceCurrency field.

-

-
Example -

-

"price": 33 -

+

The offer price of the activity.

This price should be specified without currency symbols and as a floating point number with two decimal places.

The currency of the price should be expressed in the priceCurrency field.


Example

"price": 33
### **Recommended fields** + + +### **Recommended fields** + @@ -57,82 +53,56 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/offer/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/offer/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
name - Text + name + Text -

A human readable name for the offer.

-

-
Example -

-

"name": "Speedball winger position" -

+

A human readable name for the offer.


Example

"name": "Speedball winger position"
priceCurrency - Text + priceCurrency + Text -

The currency (in 3-letter ISO 4217 format) of the price.

-

If an Offer has a zero price, then this property is not required. Otherwise - the currency must be specified.

-

-
Example -

-

"priceCurrency": "GBP" -

+

The currency (in 3-letter ISO 4217 format) of the price.

If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified.


Example

"priceCurrency": "GBP"
url - url + url + url -

URL describing the offer

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

URL describing the offer


Example

"url": "http://www.rphs.org.uk/"
### **Optional fields** + + +### **Optional fields** + @@ -143,56 +113,33 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + + - - + -
advanceBooking - RequiredStatusType + advanceBooking + RequiredStatusType -

Indicates whether to accept this offer, a participant must book in advance, - whether they must pay on attending, or have option to do either.

-

-
Example -

-

"advanceBooking": "https://openactive.io/Required" -

+

Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either.


Example

"advanceBooking": "https://openactive.io/Required"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
prepayment - RequiredStatusType + prepayment + RequiredStatusType -

Indicates whether to accept this offer, a participant must pay in advance, - pay when attending, or have the option to do either.

-

-
Example -

-

"prepayment": "https://openactive.io/Required" -

+

Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either.


Example

"prepayment": "https://openactive.io/Required"
\ No newline at end of file + + + diff --git a/docs/data-model/types/openinghoursspecification.md b/docs/data-model/types/openinghoursspecification.md index bf25b3da..1340d446 100644 --- a/docs/data-model/types/openinghoursspecification.md +++ b/docs/data-model/types/openinghoursspecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ ## **Fields** ### **Required fields** - + @@ -20,54 +20,42 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ - - + - - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "OpeningHoursSpecification" + + Must always be present and set to "type": "OpeningHoursSpecification"
closes - Time + closes + Time -

The closing time.

-

-
Example -

-

"closes": "17:00" -

+

The closing time.


Example

"closes": "17:00"
dayOfWeek - DayOfWeek + dayOfWeek + DayOfWeek -

Defines the day of the week upon which the Place is open

-

-
Example -

-

"dayOfWeek": "https://schema.org/Monday" -

+

Defines the day of the week upon which the Place is open


Example

"dayOfWeek": "https://schema.org/Monday"
opens - Time + opens + Time -

The opening time.

-

-
Example -

-

"opens": "09:00" -

+

The opening time.


Example

"opens": "09:00"
\ No newline at end of file + + + diff --git a/docs/data-model/types/organization.md b/docs/data-model/types/organization.md index 52c565df..2c7ef789 100644 --- a/docs/data-model/types/organization.md +++ b/docs/data-model/types/organization.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Organization" + + Must always be present and set to "type": "Organization"
name - Text + name + Text -

The name of the Organization

-

-
Example -

-

"name": "Central Speedball Association" -

+

The name of the Organization


Example

"name": "Central Speedball Association"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,65 +53,47 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/organization/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/organization/12345"
sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated - with the organization.

-

-
Example -

-

"sameAs": [
"https://www.facebook.com/everyoneactive/",
"https://twitter.com/everyoneactive"
] -

+

Lists the URL(s) of the official social media profile pages associated with the organization.


Example

"sameAs": [
  "https://www.facebook.com/everyoneactive/",
  "https://twitter.com/everyoneactive"
]
telephone - Text + telephone + Text -

The telephone number of the Organization

-

-
Example -

-

"telephone": "01234 567890" -

+

The telephone number of the Organization


Example

"telephone": "01234 567890"
url - url + url + url -

A definitive canonical URL for the Organization.

-

-
Example -

-

"url": "http://www.speedball-world.com" -

+

A definitive canonical URL for the Organization.


Example

"url": "http://www.speedball-world.com"
### **Optional fields** + + +### **Optional fields** + @@ -123,54 +104,33 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + + - - + -
description - Text + description + Text -

The description of the Organization

-

-
Example -

-

"description": "The national governing body of cycling" -

+

The description of the Organization


Example

"description": "The national governing body of cycling"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
logo - ImageObject + logo + ImageObject -

A logo for the Organization.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

A logo for the Organization.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/parking.md b/docs/data-model/types/parking.md index d18ce763..1d5b05bd 100644 --- a/docs/data-model/types/parking.md +++ b/docs/data-model/types/parking.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Parking" + + Must always be present and set to "type": "Parking"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Roadside Parking" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Roadside Parking"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/partialschedule.md b/docs/data-model/types/partialschedule.md index b8cc1d8c..852a2ca8 100644 --- a/docs/data-model/types/partialschedule.md +++ b/docs/data-model/types/partialschedule.md @@ -9,13 +9,31 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "PartialSchedule" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "PartialSchedule"` | ### **Recommended fields** - + @@ -26,51 +44,38 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + -
endTime - Time + endTime + Time -

The end time of the event.

-

-
Example -

-

"endTime": "12:00:00" -

+

The end time of the event.


Example

"endTime": "12:00:00"
repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"
startTime - Time + startTime + Time -

The start time of the event.

-

-
Example -

-

"startTime": "12:00:00" -

+

The start time of the event.


Example

"startTime": "12:00:00"
### **Optional fields** + + +### **Optional fields** + @@ -81,172 +86,105 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek -
- or - -
Array of Text + 		byDay + Array of DayOfWeek
- or -
Array of Text 		-

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]
byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]
byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - Date + endDate + Date -

The end date of the schedule.

-

-
Example -

-

"endDate": "2018-01-27" -

+

The end date of the schedule.


Example

"endDate": "2018-01-27"
exceptDate - Array of Date -
- or - -
Array of DateTime + 		exceptDate + Array of Date
- or -
Array of DateTime 		-

Exception dates where the schedule should not generate an event.

-

-
Example -

-

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] -

+

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]
idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - identifier (@id) for every event described by the schedule (see below for - more information). This property is required if the data provider is supporting - third-party booking via the Open Booking API.

-

-
Example -

-

"idTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"
repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.

-

-
Example -

-

"repeatCount": 3 -

+

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3
scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.

-

-
Example -

-

"scheduledEventType": "Event" -

+

The type of event this schedule related to.


Example

"scheduledEventType": "Event"
startDate - Date + startDate + Date -

The start date of the event.

-

-
Example -

-

"startDate": "2018-01-27" -

+

The start date of the event.


Example

"startDate": "2018-01-27"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - URL (schema:url) for every event described by the schedule (see below for - more information). This property is required if the data provider wants - to provide participants with a unique URL to book to attend an event.

-

-
Example -

-

"urlTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"
\ No newline at end of file + + + diff --git a/docs/data-model/types/person.md b/docs/data-model/types/person.md index 032f9e42..9c59018e 100644 --- a/docs/data-model/types/person.md +++ b/docs/data-model/types/person.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "Person" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "Person"` | ### **Recommended fields** - + @@ -26,22 +44,20 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/person/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/person/12345"
### **Optional fields** + + +### **Optional fields** + @@ -52,113 +68,69 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + - - - + + - - + - - + - - + - - + - - + -
description - Text + description + Text -

The description of the Person

-

-
Example -

-

"description": "The leader of the coaching team" -

+

The description of the Person


Example

"description": "The leader of the coaching team"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
logo - ImageObject + logo + ImageObject -

A logo for the person.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

A logo for the person.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
name - Text + name + Text -

A full name for the person.

-

This person must give direct permission for their personal information - to be shared as part of the Open Data.

-

-
Example -

-

"name": "Daley Thompson" -

+

A full name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"name": "Daley Thompson"
sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated - with the person.

-

-
Example -

-

"sameAs": "https://example.org/example-org" -

+

Lists the URL(s) of the official social media profile pages associated with the person.


Example

"sameAs": "https://example.org/example-org"
telephone - Text + telephone + Text -

The telephone number of the person

-

-
Example -

-

"telephone": "01234 567890" -

+

The telephone number of the person


Example

"telephone": "01234 567890"
url - url + url + url -

A URL where more information about the person may be found

-

-
Example -

-

"url": "http://www.example.com/" -

+

A URL where more information about the person may be found


Example

"url": "http://www.example.com/"
\ No newline at end of file + + + diff --git a/docs/data-model/types/place.md b/docs/data-model/types/place.md index ce250875..65e2a20c 100644 --- a/docs/data-model/types/place.md +++ b/docs/data-model/types/place.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Place" + + Must always be present and set to "type": "Place"
name - Text + name + Text -

The name of the Place

-

-
Example -

-

"name": "Raynes Park High School" -

+

The name of the Place


Example

"name": "Raynes Park High School"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,134 +53,92 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - + - - + - - + - - + - - + - + - - - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/place/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"
address - PostalAddress -
- or - -
Text + 		address + PostalAddress
- or -
Text 		-

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}
amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.

-

-
Example -

-

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] -

+

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]
description - Text + description + Text -

The description of the Place

-

-
Example -

-

"description": "Raynes Park High School in London" -

+

The description of the Place


Example

"description": "Raynes Park High School in London"
geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
openingHoursSpecification + openingHoursSpecification + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the Place is open

The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place

-

-
Example -

-

"telephone": "01253 473934" -

+

The telephone number for the Place


Example

"telephone": "01253 473934"
url - url + url + url -

The website for the Place

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

The website for the Place


Example

"url": "http://www.rphs.org.uk/"
### **Optional fields** + + +### **Optional fields** + @@ -192,54 +149,33 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - + - - + -
containedInPlace - Place + containedInPlace + Place -

The place within which this Place exists

-

-
Example -

-

"containedInPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
"name": "Middlesbrough Sports Village"
} -

+

The place within which this Place exists


Example

"containedInPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
  "name": "Middlesbrough Sports Village"
}
containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place

-

-
Example -

-

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} -

+

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/postaladdress.md b/docs/data-model/types/postaladdress.md index 29028dc7..5b57322a 100644 --- a/docs/data-model/types/postaladdress.md +++ b/docs/data-model/types/postaladdress.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,82 +20,60 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "PostalAddress" + + Must always be present and set to "type": "PostalAddress"
addressCountry - Text + addressCountry + Text -

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.

-

-
Example -

-

"addressCountry": "GB" -

+

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.


Example

"addressCountry": "GB"
addressLocality - Text + addressLocality + Text -

The locality, a suburb within a city or a town within a county or district.

-

-
Example -

-

"addressLocality": "Shoreditch" -

+

The locality, a suburb within a city or a town within a county or district.


Example

"addressLocality": "Shoreditch"
addressRegion - Text + addressRegion + Text -

The region, either a city or a county or district.

-

-
Example -

-

"addressRegion": "London" -

+

The region, either a city or a county or district.


Example

"addressRegion": "London"
postalCode - Text + postalCode + Text -

The postal code.

-

-
Example -

-

"postalCode": "EC2A 4JE" -

+

The postal code.


Example

"postalCode": "EC2A 4JE"
streetAddress - Text + streetAddress + Text -

The street address.

-

-
Example -

-

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St" -

+

The street address.


Example

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St"
\ No newline at end of file + + + diff --git a/docs/data-model/types/propertyvalue.md b/docs/data-model/types/propertyvalue.md index 24b8f082..6719f4bb 100644 --- a/docs/data-model/types/propertyvalue.md +++ b/docs/data-model/types/propertyvalue.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,46 +20,38 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "PropertyValue" + + Must always be present and set to "type": "PropertyValue"
name - Text + name + Text -

The name of this PropertyValue

-

-
Example -

-

"name": "Vendor ID" -

+

The name of this PropertyValue


Example

"name": "Vendor ID"
value - Text -
- or - -
Integer + 		value + Text
- or -
Integer 		-

The actual value of this identifier

-

-
Example -

-

"value": "SB1234" -

+

The actual value of this identifier


Example

"value": "SB1234"
### **Optional fields** + + +### **Optional fields** + @@ -70,20 +62,15 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + -
propertyID - url -
- or - -
Text + 		propertyID + url
- or -
Text 		-

A commonly used identifier for the characteristic represented by the property

-

-
Example -

-

"propertyID": "ActivePlaces" -

+

A commonly used identifier for the characteristic represented by the property


Example

"propertyID": "ActivePlaces"
\ No newline at end of file + + + diff --git a/docs/data-model/types/quantitativevalue.md b/docs/data-model/types/quantitativevalue.md index 86fd4b4b..28f57819 100644 --- a/docs/data-model/types/quantitativevalue.md +++ b/docs/data-model/types/quantitativevalue.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "QuantitativeValue" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "QuantitativeValue"` | ### **Optional fields** - + @@ -26,32 +44,24 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. - - + - - + -
maxValue - Integer + maxValue + Integer -

The maximum value.

-

-
Example -

-

"maxValue": 60 -

+

The maximum value.


Example

"maxValue": 60
minValue - Integer + minValue + Integer -

The minimum value.

-

-
Example -

-

"minValue": 16 -

+

The minimum value.


Example

"minValue": 16
\ No newline at end of file + + + diff --git a/docs/data-model/types/reserveaction.md b/docs/data-model/types/reserveaction.md index 24dbfc4d..ad053fdd 100644 --- a/docs/data-model/types/reserveaction.md +++ b/docs/data-model/types/reserveaction.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ReserveAction" + + Must always be present and set to "type": "ReserveAction"
name - Text + name + Text -

The name of the action

-

-
Example -

-

"name": "Book" -

+

The name of the action


Example

"name": "Book"
target - EntryPoint + target + EntryPoint -

A definition of the target of the action.

-

-
Example -

-

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} -

+

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/schedule.md b/docs/data-model/types/schedule.md index 8cbe81de..9d38742f 100644 --- a/docs/data-model/types/schedule.md +++ b/docs/data-model/types/schedule.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - + @@ -20,72 +20,55 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Schedule" + + Must always be present and set to "type": "Schedule"
endTime - Time + endTime + Time -

The end time of the event.

-

-
Example -

-

"endTime": "12:00:00" -

+

The end time of the event.


Example

"endTime": "12:00:00"
repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"
scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.

-

-
Example -

-

"scheduledEventType": "Event" -

+

The type of event this schedule related to.


Example

"scheduledEventType": "Event"
startTime - Time + startTime + Time -

The start time of the event.

-

-
Example -

-

"startTime": "12:00:00" -

+

The start time of the event.


Example

"startTime": "12:00:00"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional, a data publisher must provide either a schema:byDay, schema:byMonth or byMonthDay for a schedule. @@ -99,56 +82,38 @@ While these properties are marked as optional, a data publisher must provide eit - byDay - - Array of DayOfWeek -
- or - -
Array of Text + byDay + + Array of DayOfWeek
- or -
Array of Text -

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

- byMonth - - Array of Integer + byMonth + + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

- byMonthDay - - Array of Integer + byMonthDay + + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

-### **Recommended fields** + + +### **Recommended fields** + @@ -159,84 +124,56 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - Date + endDate + Date -

The end date of the schedule.

-

-
Example -

-

"endDate": "2018-01-27" -

+

The end date of the schedule.


Example

"endDate": "2018-01-27"
idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - identifier (@id) for every event described by the schedule (see below for - more information). This property is required if the data provider is supporting - third-party booking via the Open Booking API.

-

-
Example -

-

"idTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"
startDate - Date + startDate + Date -

The start date of the event.

-

-
Example -

-

"startDate": "2018-01-27" -

+

The start date of the event.


Example

"startDate": "2018-01-27"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - URL (schema:url) for every event described by the schedule (see below for - more information). This property is required if the data provider wants - to provide participants with a unique URL to book to attend an event.

-

-
Example -

-

"urlTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"
### **Optional fields** + + +### **Optional fields** + @@ -247,82 +184,51 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek -
- or - -
Array of Text + 		byDay + Array of DayOfWeek
- or -
Array of Text 		-

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]
byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]
byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]
exceptDate - Array of Date -
- or - -
Array of DateTime + 		exceptDate + Array of Date
- or -
Array of DateTime 		-

Exception dates where the schedule should not generate an event.

-

-
Example -

-

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] -

+

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]
repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.

-

-
Example -

-

"repeatCount": 3 -

+

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3
\ No newline at end of file + + + diff --git a/docs/data-model/types/scheduledsession.md b/docs/data-model/types/scheduledsession.md index f0a7bdcc..5ae4a10b 100644 --- a/docs/data-model/types/scheduledsession.md +++ b/docs/data-model/types/scheduledsession.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,84 +20,56 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ScheduledSession" + + Must always be present and set to "type": "ScheduledSession"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Recommended fields** + + +### **Recommended fields** + @@ -108,129 +80,83 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Optional fields** + + +### **Optional fields** + @@ -241,332 +167,195 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/sessionseries.md b/docs/data-model/types/sessionseries.md index 6750a4ba..4c4e26c0 100644 --- a/docs/data-model/types/sessionseries.md +++ b/docs/data-model/types/sessionseries.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,99 +20,65 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "SessionSeries" + + Must always be present and set to "type": "SessionSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -123,132 +89,83 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
### **Optional fields** + + +### **Optional fields** + @@ -259,324 +176,195 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
subEvent + subEvent + Array of ScheduledSession Array of ScheduledSession + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/showers.md b/docs/data-model/types/showers.md index 2f7579e1..33f60e9c 100644 --- a/docs/data-model/types/showers.md +++ b/docs/data-model/types/showers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Showers" + + Must always be present and set to "type": "Showers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Poolside Showers" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Poolside Showers"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/slot.md b/docs/data-model/types/slot.md index 361b211b..34880694 100644 --- a/docs/data-model/types/slot.md +++ b/docs/data-model/types/slot.md @@ -4,10 +4,12 @@ description: This page describes the Slot type. # Slot + + ## **Fields** ### **Required fields** - + @@ -18,75 +20,55 @@ description: This page describes the Slot type. - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Slot" + + Must always be present and set to "type": "Slot"
duration - Duration + duration + Duration -

The duration of the slot given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the slot given in [ISO8601] format.


Example

"duration": "PT1H"
facilityUse - url + facilityUse + url -

URI to the FacilityUse that has this offer

-

-
Example -

-

"facilityUse": "https://example.com/facility-use/1" -

+

URI to the FacilityUse that has this offer


Example

"facilityUse": "https://example.com/facility-use/1"
remainingUses - Integer + remainingUses + Integer -

The remaining available courts or pitches at this time. Must be 0 or 1 - for an IndividualFacilityUse.

-

-
Example -

-

"remainingUses": 5 -

+

The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"remainingUses": 5
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the slot. Can be specified as a schema:Date - or schema:DateTime

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the slot. Can be specified as a schema:Date or schema:DateTime


Example

"startDate": "2018-01-27T12:00:00Z"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional/recommended in the Modelling Specification, one of these must be provided when surfacing a slot through an RPDE feed to ensure that the slots can be processed correctly by data consumers. @@ -100,44 +82,29 @@ While these properties are marked as optional/recommended in the Modelling Speci - id - - url + id + + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/slot/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

- identifier - - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + identifier + + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer -

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

-### **Recommended fields** + + +### **Recommended fields** + @@ -148,37 +115,29 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/slot/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"
maximumUses - Integer + maximumUses + Integer -

The maximum available courts or pitches at this time. Must be 0 or 1 for - an IndividualFacilityUse.

-

-
Example -

-

"maximumUses": 16 -

+

The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"maximumUses": 16
### **Optional fields** + + +### **Optional fields** + @@ -189,59 +148,33 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + - - + -
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the slot. Can be specified as a schema:Date or - schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an slot.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the slot. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an slot.


Example

"endDate": "2018-01-27T12:00:00Z"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/sportsactivitylocation.md b/docs/data-model/types/sportsactivitylocation.md index 44c23b8e..d969ce78 100644 --- a/docs/data-model/types/sportsactivitylocation.md +++ b/docs/data-model/types/sportsactivitylocation.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "SportsActivityLocation" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "SportsActivityLocation"` | ### **Recommended fields** - + @@ -26,22 +44,20 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/place/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"
### **Optional fields** + + +### **Optional fields** + @@ -52,184 +68,114 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - - + - - + -
address - PostalAddress -
- or - -
Text + 		address + PostalAddress
- or -
Text 		-

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}
amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.

-

-
Example -

-

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] -

+

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]
containedInPlace - Place -
- or - -
url + 		containedInPlace + Place
- or -
url 		-

While a url is not specified as an option in the Modelling - Specification, it is necessary to link entities in RPDE.

-

-
Example -

-

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d" -

+

While a url is not specified as an option in the Modelling Specification, it is necessary to link entities in RPDE.


Example

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d"
containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place

-

-
Example -

-

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} -

+

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}
description - Text + description + Text -

The description of the Place

-

-
Example -

-

"description": "Raynes Park High School in London" -

+

The description of the Place


Example

"description": "Raynes Park High School in London"
geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
name - Text + name + Text -

The name of the Place

-

-
Example -

-

"name": "Raynes Park High School" -

+

The name of the Place


Example

"name": "Raynes Park High School"
openingHoursSpecification + openingHoursSpecification + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the Place is open

The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place

-

-
Example -

-

"telephone": "01253 473934" -

+

The telephone number for the Place


Example

"telephone": "01253 473934"
url - url + url + url -

The website for the Place

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

The website for the Place


Example

"url": "http://www.rphs.org.uk/"
\ No newline at end of file + + + diff --git a/docs/data-model/types/toilets.md b/docs/data-model/types/toilets.md index f8e164c9..f5248106 100644 --- a/docs/data-model/types/toilets.md +++ b/docs/data-model/types/toilets.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Toilets" + + Must always be present and set to "type": "Toilets"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Public Toilets" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Public Toilets"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/towels.md b/docs/data-model/types/towels.md index 14fb351e..063eb9c0 100644 --- a/docs/data-model/types/towels.md +++ b/docs/data-model/types/towels.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Towels" + + Must always be present and set to "type": "Towels"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Complementary Towels" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Complementary Towels"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + From 6fe45d67286f5011cc6ebb5bd783cdb58582dd66 Mon Sep 17 00:00:00 2001 From: Melanie Abraham Date: Fri, 12 Oct 2018 15:56:48 +0000 Subject: [PATCH 03/10] GitBook: [draft] 41 pages modified --- docs/SUMMARY.md | 2 + ...enactive-data-model-part-one-the-basics.md | 313 ++++++++++ docs/data-model/types/action.md | 41 +- docs/data-model/types/babychanging.md | 36 +- docs/data-model/types/brand.md | 98 +-- docs/data-model/types/changingfacilities.md | 36 +- docs/data-model/types/concept.md | 118 ++-- docs/data-model/types/conceptscheme.md | 101 ++-- docs/data-model/types/courseinstance.md | 570 ++++++++++++------ docs/data-model/types/creche.md | 36 +- docs/data-model/types/entrypoint.md | 51 +- docs/data-model/types/event.md | 570 ++++++++++++------ docs/data-model/types/eventseries.md | 535 +++++++++++----- docs/data-model/types/facilityuse.md | 292 ++++++--- docs/data-model/types/geocoordinates.md | 41 +- docs/data-model/types/headlineevent.md | 521 +++++++++++----- docs/data-model/types/imageobject.md | 51 +- .../data-model/types/individualfacilityuse.md | 287 +++++---- .../types/locationfeaturespecification.md | 36 +- docs/data-model/types/lockers.md | 36 +- docs/data-model/types/offer.md | 163 +++-- .../types/openinghoursspecification.md | 54 +- docs/data-model/types/organization.md | 142 +++-- docs/data-model/types/parking.md | 36 +- docs/data-model/types/partialschedule.md | 232 ++++--- docs/data-model/types/person.md | 154 +++-- docs/data-model/types/place.md | 204 ++++--- docs/data-model/types/postaladdress.md | 80 ++- docs/data-model/types/propertyvalue.md | 63 +- docs/data-model/types/quantitativevalue.md | 56 +- docs/data-model/types/reserveaction.md | 41 +- docs/data-model/types/schedule.md | 272 ++++++--- docs/data-model/types/scheduledsession.md | 511 +++++++++++----- docs/data-model/types/sessionseries.md | 522 +++++++++++----- docs/data-model/types/showers.md | 36 +- docs/data-model/types/slot.md | 201 ++++-- .../types/sportsactivitylocation.md | 218 ++++--- docs/data-model/types/toilets.md | 36 +- docs/data-model/types/towels.md | 36 +- .../using-data/harvesting-opportunity-data.md | 2 +- ...e-openactive-opportunity-data-dashboard.md | 85 +++ 41 files changed, 4692 insertions(+), 2223 deletions(-) create mode 100644 docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md create mode 100644 docs/using-data/how-to-find-opportunity-data-using-the-openactive-opportunity-data-dashboard.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 9e8af508..06911f67 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -12,6 +12,7 @@ ## Using data +* [How to find opportunity data using the OpenActive Opportunity Data Dashboard](using-data/how-to-find-opportunity-data-using-the-openactive-opportunity-data-dashboard.md) * [Harvesting opportunity data](using-data/harvesting-opportunity-data.md) ## Data Model @@ -56,6 +57,7 @@ * [SportsActivityLocation](data-model/types/sportsactivitylocation.md) * [Toilets](data-model/types/toilets.md) * [Towels](data-model/types/towels.md) +* [Tutorial: describing events using the OpenActive data model - part one: the basics](data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md) ## Specifications diff --git a/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md new file mode 100644 index 00000000..420658bf --- /dev/null +++ b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md @@ -0,0 +1,313 @@ +# Tutorial: describing events using the OpenActive data model - part one: the basics + +**Whether you’re aiming to publish open opportunity data or to use it, familiarity with the OpenActive data model will be key.** + + +**In this tutorial we’ll be looking at how to describe an activity session using the standard data model we have developed with the community. We’ll cover all of the core properties that are** [**required**](https://www.openactive.io/modelling-opportunity-data/#required-and-optional-properties) **as part of the standards.** + + +**The tutorial covers:** + + +* **Understanding what the model is** +* **The format of a model** +* **How to describe a basic activity session** +* **Where to go next** + +**By the end of this tutorial you should understand the concept behind the model, and be confident in describing your own events.** + + +**This tutorial requires a general understanding of JSON, and use of a text editor if you wish to follow along or write your own examples.** + + +**The model described here will conform to the Modelling Opportunity Data 2.0 specification. If you want to jump ahead for a sneak peek of the final version, you can find it in the validator.** + + +## **1. Understanding the data model** + +**Before jumping in to create one, we first need to understand what we’re trying to create.** + + +**OpenActive is working to bring about change within the sport and physical activity sector by improving access to ‘open opportunity data’. This means making data about where and when sport and physical activities happen open for anyone to access, use and share. By doing this, more places, products and services can better inform people of opportunities to get active.** + + +**All of the following types of data can be published as open data, and collectively this is known as opportunity data:** + + +* **descriptions and lists of physical activities** +* **details of the locations and venues at which activities or events takes place** +* **the facilities available at those locations** +* **the details of event involving physical activities e.g. when and where they will take place, restrictions on attendance, costs, etc** +* **any related information, e.g. about the format of the event, its organisers, etc** + +**Having a consistent format is important because it makes it easier for everyone to publish and use data, and so we have standards.** [**Open standards**](https://standards.theodi.org/introduction/what-are-open-standards-for-data/) **for data are documented, reusable agreements that help people and organisations to publish, access, share and use better quality data.** + + +**The data model that we’re going to walk through in this tutorial is an example of following the standards that the community have defined. It builds on existing standards \(such as** [**schema.org**](https://schema.org/)**, JSON-LD, and** [**Simple Knowledge Organization System \(SKOS\)**](https://www.w3.org/2004/02/skos/)**\), which has let us focus specifically on the aspects of describing opportunity data that are important to the physical activity sector.** + + +## **2. The format of a model** + +**The recommended approach to publishing open opportunity data is as JSON, and specifically as JSON-LD \(a JSON-based serialization for linked data\). The use of JSON-LD for sharing structured information is also encouraged by people including** [**Google**](https://developers.google.com/search/docs/guides/intro-structured-data)**, and is an example of why it’s useful to have common approaches. In this tutorial all of our examples will be using JSON-LD format.** + + +## **3. How to describe an activity session** + +### **3.1 Add a context** + +**For our starting foundations, all opportunity data should begin with a context contained within an opening and closing bracket \(see below\).** + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld" }** | +| :--- | + + +**A JSON-LD context maps the terms used in a JSON document to their standard definitions. To indicate that your data conforms to the OpenActive opportunity data specification, include a @context reference that matches the above.** + + + +### **3.2 Adding basic session details** + +**Now we can start to add in the information about the session itself. To illustrate this, we’re going to use a rollerblading fitness class.** + + +**The following are the minimum requirements for modelling opportunity data:** + + +* **define that it’s an event \(opportunity\)** +* **its name** +* **a URL providing a link to a web page describing the session** +* **an indication of the type of activity that will take place at an event** +* **the time at which the event will take place** +* **the location at which the event will take place** + +**Whilst this tutorial will help you to understand what’s necessary to get a basic, validating opportunity, there’s a lot more that you can do with the data. Other fields are optional, but might be recommended as they provide useful information for participants. Generally we encourage people to provide as much useful information as possible, while respecting privacy. We’ll talk a bit more about this in the second half of this tutorial, or you can refer to the** [**Required and Optional properties**](https://www.openactive.io/modelling-opportunity-data/#required-and-optional-properties) **part of the specification.** + + +**Let’s walk through and build it up.** + + +#### **Defining the type of resource** + +**Adding to the JSON-LD context that we added in the first step, we now want to start describing the event itself.** + + +**To describe what type of thing we're going to be sharing in our data, we need to add a type property. It’s possible for the data model to describe a number of different types of things, but as we're describing an Event we’ll use that as the value.** + + + + + + + + + +
+

{
"@context": "https://openactive.io/ns/oa.jsonld",
"type": "Event" +

+

} +

+
#### **Give it a name and URL** + +**Add in the name for your individual session, and the public URL where someone could go to find more information, or perhaps sign up to participate.** + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1" }** | +| :--- | + + +#### **Defining the activity type** + +**Next, we want to describe the type of activity this opportunity is for. As part of the OpenActive standards work there have been some initial efforts to develop a** [**standardised list of activities**](https://www.openactive.io/activity-list/) **for the sector. Where possible consider the terminology already being used, but if these don’t accurately reflect your activity types we’d encourage you to share your list as open data and contribute to the efforts in this area.** + + +**In this case Roller Blading is in the standardised activity list, so we can add it to our model, along with references to the activity list that it has come from. We do this by adding an array of SKOS Concepts, however for our example we only need to define one activity type:** + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], }** | +| :--- | + + +#### **Giving it a time** + +**People need to know when the event starts, and so in its most basic form we include a startDate property. The value of this must be a valid \[**[**ISO8601**](https://www.openactive.io/opportunity-data-primer/#bib-ISO8601)**\] date or date time, with a trailing definition of timezone. For example, 2018-08-01T10:51:02Z or 2018-08-01T10:51:02+01:00.** + + +**Whilst this is the only mandatory property, it’s recommended to include information about when the event finishes, and how long the activity part of it takes. Due to this, you may wish to include an EndDate, and a duration.** + + +**The endDate property is the partner to startDate, and is used to signify the end of the event. Furthermore, certain activities may have a start and end point, but the actual duration of activity itself may be less than this total period - for instance a bike ride that meets at 10am and concludes at 3pm, but only includes two hours of cycling with the rest as social time. For activities such as these, we may wish to use the duration property \(defined using an** [**ISO8601**](https://www.openactive.io/opportunity-data-primer/#bib-ISO8601) **duration\) to indicate the length of the activity within the overall period.** + + +**In our example the activity lasts the full hour dictated by the start and end points. For that reason duration is optional, but it has been included here to illustrate usage.** + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", }** | +| :--- | + + +**Your event timings may be more complicated than this, and we’ll come onto that in part two of this tutorial.** + + +#### **Stating where it happens** + +**Finally, people need to know where to go to attend the event. Locations are added to events using the location property, which follows the** [**schema.org standards for address data**](https://schema.org/PostalAddress)**. The minimum requirements for validation are shown below, but the recommendation in the specification is that applications should provide as much information about the Place as possible.** + + +**An example of providing more information is through including geocodes. Whilst this is not mandatory for each event, it’s recommended as people are more likely to use the data if it’s geocoded.** + + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } } }** | +| :--- | + + +**An example of providing more information is through including geocodes. Whilst this is not mandatory for each event, it’s recommended as people are more likely to use the data if it’s geocoded.** + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }** | +| :--- | + + +**And that’s it! Here we have a valid event described according to the OpenActive opportunity data model.** + + +**You’re able to double-check that you’ve got everything entered correctly by pasting your code into the** [**OpenActive data validator tool**](https://validator.openactive.io/)**.** +**3. How to describe an activity session** + +### **3.1 Add a context** + +**For our starting foundations, all opportunity data should begin with a context contained within an opening and closing bracket \(see below\).** + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld" }** | +| :--- | + + +**A JSON-LD context maps the terms used in a JSON document to their standard definitions. To indicate that your data conforms to the OpenActive opportunity data specification, include a @context reference that matches the above.** + + + +### **3.2 Adding basic session details** + +**Now we can start to add in the information about the session itself. To illustrate this, we’re going to use a rollerblading fitness class.** + + +**The following are the minimum requirements for modelling opportunity data:** + + +* **define that it’s an event \(opportunity\)** +* **its name** +* **a URL providing a link to a web page describing the session** +* **an indication of the type of activity that will take place at an event** +* **the time at which the event will take place** +* **the location at which the event will take place** + +**Whilst this tutorial will help you to understand what’s necessary to get a basic, validating opportunity, there’s a lot more that you can do with the data. Other fields are optional, but might be recommended as they provide useful information for participants. Generally we encourage people to provide as much useful information as possible, while respecting privacy. We’ll talk a bit more about this in the second half of this tutorial, or you can refer to the** [**Required and Optional properties**](https://www.openactive.io/modelling-opportunity-data/#required-and-optional-properties) **part of the specification.** + + +**Let’s walk through and build it up.** + + +#### **Defining the type of resource** + +**Adding to the JSON-LD context that we added in the first step, we now want to start describing the event itself.** + + +**To describe what type of thing we're going to be sharing in our data, we need to add a type property. It’s possible for the data model to describe a number of different types of things, but as we're describing an Event we’ll use that as the value.** + + + + + + + + + +
+

{
"@context": "https://openactive.io/ns/oa.jsonld",
"type": "Event" +

+

} +

+
#### **Give it a name and URL** + +**Add in the name for your individual session, and the public URL where someone could go to find more information, or perhaps sign up to participate.** + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1" }** | +| :--- | + + +#### **Defining the activity type** + +**Next, we want to describe the type of activity this opportunity is for. As part of the OpenActive standards work there have been some initial efforts to develop a** [**standardised list of activities**](https://www.openactive.io/activity-list/) **for the sector. Where possible consider the terminology already being used, but if these don’t accurately reflect your activity types we’d encourage you to share your list as open data and contribute to the efforts in this area.** + + +**In this case Roller Blading is in the standardised activity list, so we can add it to our model, along with references to the activity list that it has come from. We do this by adding an array of SKOS Concepts, however for our example we only need to define one activity type:** + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], }** | +| :--- | + + +#### **Giving it a time** + +**People need to know when the event starts, and so in its most basic form we include a startDate property. The value of this must be a valid \[**[**ISO8601**](https://www.openactive.io/opportunity-data-primer/#bib-ISO8601)**\] date or date time, with a trailing definition of timezone. For example, 2018-08-01T10:51:02Z or 2018-08-01T10:51:02+01:00.** + + +**Whilst this is the only mandatory property, it’s recommended to include information about when the event finishes, and how long the activity part of it takes. Due to this, you may wish to include an EndDate, and a duration.** + + +**The endDate property is the partner to startDate, and is used to signify the end of the event. Furthermore, certain activities may have a start and end point, but the actual duration of activity itself may be less than this total period - for instance a bike ride that meets at 10am and concludes at 3pm, but only includes two hours of cycling with the rest as social time. For activities such as these, we may wish to use the duration property \(defined using an** [**ISO8601**](https://www.openactive.io/opportunity-data-primer/#bib-ISO8601) **duration\) to indicate the length of the activity within the overall period.** + + +**In our example the activity lasts the full hour dictated by the start and end points. For that reason duration is optional, but it has been included here to illustrate usage.** + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", }** | +| :--- | + + +**Your event timings may be more complicated than this, and we’ll come onto that in part two of this tutorial.** + + +#### **Stating where it happens** + +**Finally, people need to know where to go to attend the event. Locations are added to events using the location property, which follows the** [**schema.org standards for address data**](https://schema.org/PostalAddress)**. The minimum requirements for validation are shown below, but the recommendation in the specification is that applications should provide as much information about the Place as possible.** + + +**An example of providing more information is through including geocodes. Whilst this is not mandatory for each event, it’s recommended as people are more likely to use the data if it’s geocoded.** + + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } } }** | +| :--- | + + +**An example of providing more information is through including geocodes. Whilst this is not mandatory for each event, it’s recommended as people are more likely to use the data if it’s geocoded.** + + +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }** | +| :--- | + + +**And that’s it! Here we have a valid event described according to the OpenActive opportunity data model.** + + +**You’re able to double-check that you’ve got everything entered correctly by pasting your code into the** [**OpenActive data validator tool**](https://validator.openactive.io/)**.** + +## **4. Where to go next** + +**This is all you need to get up and running, but it may be that you’d like a bit more detail. If you’ve taken the time to validate the above, you’ll also see that the validator returns a number of additional recommendations for making the data even better. If you’d like to build the example up even further you can follow along with part two: adding additional timing detail.** + + +**Alternatively, if you’d like to jump straight in to creating your own events, the following will probably be useful:** + + +* **Data model specification:** [**https://www.openactive.io/modelling-opportunity-data/**](https://www.openactive.io/modelling-opportunity-data/) +* **OpenActive developer area:** [**https://developer.openactive.io/**](https://developer.openactive.io/) +* **A “full fat” Event example, which you may want to use as a starting point and cut down where needed:** [**https://developer.openactive.io/models/event**](https://developer.openactive.io/models/event) + +**Activity list:** [**https://www.openactive.io/activity-list/**](https://www.openactive.io/activity-list/) + + diff --git a/docs/data-model/types/action.md b/docs/data-model/types/action.md index 6a2d7d3c..69ab11b0 100644 --- a/docs/data-model/types/action.md +++ b/docs/data-model/types/action.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Action" + Text + Must always be present and set to "type": "Action"
name - Text + name + Text -

The name of the action


Example

"name": "Book"

+

The name of the action

+

+
Example +

+

"name": "Book" +

target - EntryPoint + target + EntryPoint -

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}

+

A definition of the target of the action.

+

+
Example +

+

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/babychanging.md b/docs/data-model/types/babychanging.md index afddc50c..96aacca1 100644 --- a/docs/data-model/types/babychanging.md +++ b/docs/data-model/types/babychanging.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "BabyChanging" + Text + Must always be present and set to "type": "BabyChanging"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Baby Changing Facilities"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Baby Changing Facilities" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/brand.md b/docs/data-model/types/brand.md index 80615e68..c4584376 100644 --- a/docs/data-model/types/brand.md +++ b/docs/data-model/types/brand.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), ## **Fields** ### **Required fields** - + @@ -20,38 +20,44 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Brand" + Text + Must always be present and set to "type": "Brand"
name - Text + name + Text -

The name of the brand.


Example

"name": "Play Ball!"

+

The name of the brand.

+

+
Example +

+

"name": "Play Ball!" +

url - url + url + url -

A url where further information can be found for the brand.


Example

"url": "http://example.com/play_ball"

+

A url where further information can be found for the brand.

+

+
Example +

+

"url": "http://example.com/play_ball" +

- +### **Recommended fields** -### **Recommended fields** - @@ -62,29 +68,36 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - + -
description - Text + description + Text -

A text description for the brand.


Example

"description": "Play Ball! is a series of games for people of all abilities."

+

A text description for the brand.

+

+
Example +

+

"description": "Play Ball! is a series of games for people of all abilities." +

logo - ImageObject + logo + ImageObject -

The logo associated with the brand.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

The logo associated with the brand.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

- +### **Optional fields** -### **Optional fields** - @@ -95,15 +108,26 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + -
identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "BR1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "BR1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/changingfacilities.md b/docs/data-model/types/changingfacilities.md index 2b65ac39..c6a201ef 100644 --- a/docs/data-model/types/changingfacilities.md +++ b/docs/data-model/types/changingfacilities.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "ChangingFacilities" + Text + Must always be present and set to "type": "ChangingFacilities"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Changing Rooms"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Changing Rooms" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/concept.md b/docs/data-model/types/concept.md index 367ffb27..8fe8e544 100644 --- a/docs/data-model/types/concept.md +++ b/docs/data-model/types/concept.md @@ -4,12 +4,12 @@ description: This page describes the Concept type. # Concept -This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://www.w3.org/2004/02/skos/core#Concept). +This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http://www.w3.org/2004/02/skos/core#Concept). ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - - + - - + -
type - Text + type - Must always be present and set to "type": "Concept" + Text + Must always be present and set to "type": "Concept"
prefLabel - Text + prefLabel + Text -

A human readable string for use in user interfaces.


Example

"prefLabel": "Speedball"

+

A human readable string for use in user interfaces.

+

+
Example +

+

"prefLabel": "Speedball" +

+### **Recommended fields** - -### **Recommended fields** - @@ -53,29 +54,36 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/concept/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/concept/12345" +

inScheme - url + inScheme + url -

A stable URL reference for the taxonomy.


Example

"inScheme": "https://example.com/reference/activities"

+

A stable URL reference for the taxonomy.

+

+
Example +

+

"inScheme": "https://example.com/reference/activities" +

+### **Optional fields** - -### **Optional fields** - @@ -86,42 +94,60 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - + - - + - - + - - + -
altLabel - Array of Text + altLabel + Array of Text -

An alternative human readable string for use in user interfaces.


Example

"altLabel": "Speedball"

+

An alternative human readable string for use in user interfaces.

+

+
Example +

+

"altLabel": "Speedball" +

broader - Array of url + broader + Array of url -

A broader Concept URI


Example

"broader": "https://example.com/football"

+

A broader Concept URI

+

+
Example +

+

"broader": "https://example.com/football" +

narrower - Array of url + narrower + Array of url -

A more specific concept URI


Example

"narrower": "https://example.com/walking-football"

+

A more specific concept URI

+

+
Example +

+

"narrower": "https://example.com/walking-football" +

notation - Text + notation + Text -

A concept label that is not normally recognisable as natural language.


Example

"notation": "Speedball"

+

A concept label that is not normally recognisable as natural language.

+

+
Example +

+

"notation": "Speedball" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/conceptscheme.md b/docs/data-model/types/conceptscheme.md index d3acfe5e..aa531e69 100644 --- a/docs/data-model/types/conceptscheme.md +++ b/docs/data-model/types/conceptscheme.md @@ -4,12 +4,12 @@ description: This page describes the ConceptScheme type. # ConceptScheme -This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). +This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). ## **Fields** ### **Required fields** - + @@ -20,56 +20,73 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](ht - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ConceptScheme" + Text + Must always be present and set to "type": "ConceptScheme"
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/scheme/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/scheme/12345" +

concept - Array of Concept + concept + Array of Concept -

A collection of concepts that are part of this scheme


Example

"concept": [
  {
    "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"
  }
]

+

A collection of concepts that are part of this scheme

+

+
Example +

+

"concept": [
{
"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"
}
] +

title - Text + title + Text -

The title of the scheme


Example

"title": "Activity List"

+

The title of the scheme

+

+
Example +

+

"title": "Activity List" +

url - url + url + url -

A URL to a web page (or section of a page) that describes the concept scheme.


Example

"url": "https://example.com/scheme/1234"

+

A URL to a web page (or section of a page) that describes the concept + scheme.

+

+
Example +

+

"url": "https://example.com/scheme/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,24 +97,32 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](ht - - + - - + -
description - Text + description + Text -

A free text description of the taxonomy


Example

"description": "An example activity list."

+

A free text description of the taxonomy

+

+
Example +

+

"description": "An example activity list." +

license - url + license + url -

Reference to the license under which the activity list has been published.


Example

"license": "https://example.com/license/MIT"

+

Reference to the license under which the activity list has been published.

+

+
Example +

+

"license": "https://example.com/license/MIT" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/courseinstance.md b/docs/data-model/types/courseinstance.md index 434844f7..3d286bf9 100644 --- a/docs/data-model/types/courseinstance.md +++ b/docs/data-model/types/courseinstance.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe ## **Fields** ### **Required fields** - + @@ -20,64 +20,98 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "CourseInstance" + Text + Must always be present and set to "type": "CourseInstance"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. @@ -91,29 +125,40 @@ While these properties are marked as optional, a data publisher must provide eit - startDate - - DateTime
- or -
Date + startDate + + DateTime +
- or - +
Date -

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

- - +### **Recommended fields** -### **Recommended fields** - @@ -124,128 +169,211 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Optional fields** -### **Optional fields** - @@ -256,159 +384,259 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/creche.md b/docs/data-model/types/creche.md index 2ee2db11..1023ec78 100644 --- a/docs/data-model/types/creche.md +++ b/docs/data-model/types/creche.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Creche" + Text + Must always be present and set to "type": "Creche"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Childcare"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Childcare" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/entrypoint.md b/docs/data-model/types/entrypoint.md index 960e3c97..e487be2c 100644 --- a/docs/data-model/types/entrypoint.md +++ b/docs/data-model/types/entrypoint.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent ## **Fields** ### **Required fields** - + @@ -20,42 +20,49 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent - - - + - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "EntryPoint" + Text + Must always be present and set to "type": "EntryPoint"
encodingType - Text + encodingType - Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json" + Text + Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json"
httpMethod - Text + httpMethod + Text -

An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.


Example

"httpMethod": "POST"

+

An HTTP method that specifies the appropriate HTTP method for a request + to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.

+

+
Example +

+

"httpMethod": "POST" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

URL of the item


Example

"urlTemplate": "https://example.com/orders{/var}"

+

URL of the item

+

+
Example +

+

"urlTemplate": "https://example.com/orders{/var}" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/event.md b/docs/data-model/types/event.md index bfc679e5..2d10a8a7 100644 --- a/docs/data-model/types/event.md +++ b/docs/data-model/types/event.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,64 +20,98 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Event" + Text + Must always be present and set to "type": "Event"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. @@ -91,29 +125,40 @@ While these properties are marked as optional, a data publisher must provide eit - startDate - - DateTime
- or -
Date + startDate + + DateTime +
- or - +
Date -

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

- - +### **Recommended fields** -### **Recommended fields** - @@ -124,128 +169,211 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Optional fields** -### **Optional fields** - @@ -256,159 +384,259 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/eventseries.md b/docs/data-model/types/eventseries.md index 7f3bc1b4..6aae6a49 100644 --- a/docs/data-model/types/eventseries.md +++ b/docs/data-model/types/eventseries.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi ## **Fields** ### **Required fields** - + @@ -20,56 +20,77 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "EventSeries" + Text + Must always be present and set to "type": "EventSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,110 +101,175 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

+### **Optional fields** - -### **Optional fields** - @@ -194,186 +280,317 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/facilityuse.md b/docs/data-model/types/facilityuse.md index c9e80ea3..eccc90b5 100644 --- a/docs/data-model/types/facilityuse.md +++ b/docs/data-model/types/facilityuse.md @@ -4,12 +4,10 @@ description: This page describes the FacilityUse type. # FacilityUse - - ## **Fields** ### **Required fields** - + @@ -20,65 +18,80 @@ description: This page describes the FacilityUse type. - - - + - - + - - + - - + - - - + + - - + -
type - Text + type - Must always be present and set to "type": "FacilityUse" + Text + Must always be present and set to "type": "FacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + a facility use.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the facility use will take place.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the facility use


Example

"name": "Speedball"

+

The name of the facility use

+

+
Example +

+

"name": "Speedball" +

provider - - -

The organisation responsible for providing the facility

+ 		provider The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"

+

A URL to a web page (or section of a page) that describes the facility + use.

+

+
Example +

+

"url": "https://example.com/facility-use/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -89,65 +102,86 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/facility-use/112345" +

description - Text + description + Text -

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the facility use

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

event - Array of Slot + event + Array of Slot -

An array of slots of availability of this FacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 3,
    "maximumUses": 6
  }
]

+

An array of slots of availability of this FacilityUse.

+

+
Example +

+

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 3,
"maximumUses": 6
}
] +

hoursAvailable - Array of OpeningHoursSpecification + hoursAvailable -

The times the facility use is available

+ 		Array of OpeningHoursSpecification The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the facility use, e.g. a photo taken at + a previous event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

- +### **Optional fields** -### **Optional fields** - @@ -158,78 +192,136 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."

+

Provides additional notes and instructions for users of a facility. E.g. + more information on how to find it, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]

+

Provides a set of tags that help categorise and describe a facility.

+

+
Example +

+

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

individualFacilityUse - Array of IndividualFacilityUse + individualFacilityUse + Array of IndividualFacilityUse -

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court).


Example

"individualFacilityUse": [
  {
    "type": "IndividualFacilityUse",
    "id": "http://www.example.org/facility-uses/1",
    "name": "Tennis Court 1"
  }
]

+

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse + (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse + (e.g. an opportunity to play tennis on a specific court).

+

+
Example +

+

"individualFacilityUse": [
{
"type": "IndividualFacilityUse",
"id": "http://www.example.org/facility-uses/1",
"name": "Tennis Court 1"
}
] +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

- - + \ No newline at end of file diff --git a/docs/data-model/types/geocoordinates.md b/docs/data-model/types/geocoordinates.md index 8d98bd79..279b2904 100644 --- a/docs/data-model/types/geocoordinates.md +++ b/docs/data-model/types/geocoordinates.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "GeoCoordinates" + Text + Must always be present and set to "type": "GeoCoordinates"
latitude - Float + latitude + Float -

The latitude of a location. For example 51.522338 (WGS 84).


Example

"latitude": 51.522338

+

The latitude of a location. For example 51.522338 (WGS 84).

+

+
Example +

+

"latitude": 51.522338 +

longitude - Float + longitude + Float -

The longitude of a location. For example -0.083437 (WGS 84).


Example

"longitude": -0.083437

+

The longitude of a location. For example -0.083437 (WGS 84).

+

+
Example +

+

"longitude": -0.083437 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/headlineevent.md b/docs/data-model/types/headlineevent.md index 0e5406ab..30a701f0 100644 --- a/docs/data-model/types/headlineevent.md +++ b/docs/data-model/types/headlineevent.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,74 +20,116 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "HeadlineEvent" + Text + Must always be present and set to "type": "HeadlineEvent"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -98,119 +140,194 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

+### **Optional fields** - -### **Optional fields** - @@ -221,150 +338,244 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/imageobject.md b/docs/data-model/types/imageobject.md index cdbb0626..3d0cafa7 100644 --- a/docs/data-model/types/imageobject.md +++ b/docs/data-model/types/imageobject.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im ## **Fields** ### **Required fields** - + @@ -20,48 +20,31 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im - - - - - - - - - - -
type - Text + type - Must always be present and set to "type": "ImageObject" + Text
url - url + Must always be present and set to "type": "ImageObject" -

The URL for the display resolution image.


Example

"url": "http://example.com/static/image/speedball_large.jpg"

-
- - -### **Optional fields** - - - - - - - - - - - + -
PropertyExpected TypeDescription
thumbnail - Array of ImageObject + url + url -

The URL for a thumbnail image for an image.

+

The URL for the display resolution image.

+

+
Example +

+

"url": "http://example.com/static/image/speedball_large.jpg" +

+### **Optional fields** +| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **thumbnail** | Array of [`ImageObject`](https://docs.openactive.io/data-model/types/imageobject) | The URL for a thumbnail image for an image. | diff --git a/docs/data-model/types/individualfacilityuse.md b/docs/data-model/types/individualfacilityuse.md index 796fea75..ba69fdef 100644 --- a/docs/data-model/types/individualfacilityuse.md +++ b/docs/data-model/types/individualfacilityuse.md @@ -4,12 +4,10 @@ description: This page describes the IndividualFacilityUse type. # IndividualFacilityUse - - ## **Fields** ### **Required fields** - + @@ -20,65 +18,80 @@ description: This page describes the IndividualFacilityUse type. - - - + - - + - - + - - + - - - + + - - + -
type - Text + type - Must always be present and set to "type": "IndividualFacilityUse" + Text + Must always be present and set to "type": "IndividualFacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + a facility use.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the facility use will take place.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the facility use


Example

"name": "Speedball"

+

The name of the facility use

+

+
Example +

+

"name": "Speedball" +

provider - - -

The organisation responsible for providing the facility

+ 		provider The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"

+

A URL to a web page (or section of a page) that describes the facility + use.

+

+
Example +

+

"url": "https://example.com/facility-use/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -89,65 +102,81 @@ description: This page describes the IndividualFacilityUse type. - - + - - - + - - + - - + - - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/facility-use/112345" +

aggregateFacilityUse - FacilityUse + aggregateFacilityUse -

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location).

+ 		FacilityUse Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse + (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse + (e.g. an opportunity to play tennis at a specific location).
description - Text + description + Text -

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the facility use

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

event - Array of Slot + event + Array of Slot -

An array of slots of availability of this IndividualFacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 0,
    "maximumUses": 1
  }
]

+

An array of slots of availability of this IndividualFacilityUse.

+

+
Example +

+

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 0,
"maximumUses": 1
}
] +

hoursAvailable - Array of OpeningHoursSpecification + hoursAvailable -

The times the facility use is available

+ 		Array of OpeningHoursSpecification The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the facility use, e.g. a photo taken at + a previous event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

- +### **Optional fields** -### **Optional fields** - @@ -158,78 +187,134 @@ description: This page describes the IndividualFacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."

+

Provides additional notes and instructions for users of a facility. E.g. + more information on how to find it, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]

+

Provides a set of tags that help categorise and describe a facility.

+

+
Example +

+

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

- - + \ No newline at end of file diff --git a/docs/data-model/types/locationfeaturespecification.md b/docs/data-model/types/locationfeaturespecification.md index 6962df6d..1b719113 100644 --- a/docs/data-model/types/locationfeaturespecification.md +++ b/docs/data-model/types/locationfeaturespecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "LocationFeatureSpecification" + Text + Must always be present and set to "type": "LocationFeatureSpecification"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Bike Shed"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Bike Shed" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/lockers.md b/docs/data-model/types/lockers.md index ad1972ce..6db45ee7 100644 --- a/docs/data-model/types/lockers.md +++ b/docs/data-model/types/lockers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Lockers" + Text + Must always be present and set to "type": "Lockers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Indoor Lockers"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Indoor Lockers" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/offer.md b/docs/data-model/types/offer.md index 3c608cdc..54853835 100644 --- a/docs/data-model/types/offer.md +++ b/docs/data-model/types/offer.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), ## **Fields** ### **Required fields** - + @@ -20,29 +20,33 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - - + - - + -
type - Text + type - Must always be present and set to "type": "Offer" + Text + Must always be present and set to "type": "Offer"
price - Float + price + Float -

The offer price of the activity.

This price should be specified without currency symbols and as a floating point number with two decimal places.

The currency of the price should be expressed in the priceCurrency field.


Example

"price": 33

+

The offer price of the activity.

+

This price should be specified without currency symbols and as a floating + point number with two decimal places.

+

The currency of the price should be expressed in the priceCurrency field.

+

+
Example +

+

"price": 33 +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,56 +57,82 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/offer/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/offer/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

name - Text + name + Text -

A human readable name for the offer.


Example

"name": "Speedball winger position"

+

A human readable name for the offer.

+

+
Example +

+

"name": "Speedball winger position" +

priceCurrency - Text + priceCurrency + Text -

The currency (in 3-letter ISO 4217 format) of the price.

If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified.


Example

"priceCurrency": "GBP"

+

The currency (in 3-letter ISO 4217 format) of the price.

+

If an Offer has a zero price, then this property is not required. Otherwise + the currency must be specified.

+

+
Example +

+

"priceCurrency": "GBP" +

url - url + url + url -

URL describing the offer


Example

"url": "http://www.rphs.org.uk/"

+

URL describing the offer

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- +### **Optional fields** -### **Optional fields** - @@ -113,33 +143,56 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + + - - + -
advanceBooking - RequiredStatusType + advanceBooking + RequiredStatusType -

Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either.


Example

"advanceBooking": "https://openactive.io/Required"

+

Indicates whether to accept this offer, a participant must book in advance, + whether they must pay on attending, or have option to do either.

+

+
Example +

+

"advanceBooking": "https://openactive.io/Required" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

prepayment - RequiredStatusType + prepayment + RequiredStatusType -

Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either.


Example

"prepayment": "https://openactive.io/Required"

+

Indicates whether to accept this offer, a participant must pay in advance, + pay when attending, or have the option to do either.

+

+
Example +

+

"prepayment": "https://openactive.io/Required" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/openinghoursspecification.md b/docs/data-model/types/openinghoursspecification.md index 1340d446..bf25b3da 100644 --- a/docs/data-model/types/openinghoursspecification.md +++ b/docs/data-model/types/openinghoursspecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ ## **Fields** ### **Required fields** - + @@ -20,42 +20,54 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ - - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "OpeningHoursSpecification" + Text + Must always be present and set to "type": "OpeningHoursSpecification"
closes - Time + closes + Time -

The closing time.


Example

"closes": "17:00"

+

The closing time.

+

+
Example +

+

"closes": "17:00" +

dayOfWeek - DayOfWeek + dayOfWeek + DayOfWeek -

Defines the day of the week upon which the Place is open


Example

"dayOfWeek": "https://schema.org/Monday"

+

Defines the day of the week upon which the Place is open

+

+
Example +

+

"dayOfWeek": "https://schema.org/Monday" +

opens - Time + opens + Time -

The opening time.


Example

"opens": "09:00"

+

The opening time.

+

+
Example +

+

"opens": "09:00" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/organization.md b/docs/data-model/types/organization.md index 2c7ef789..52c565df 100644 --- a/docs/data-model/types/organization.md +++ b/docs/data-model/types/organization.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - - + - - + -
type - Text + type - Must always be present and set to "type": "Organization" + Text + Must always be present and set to "type": "Organization"
name - Text + name + Text -

The name of the Organization


Example

"name": "Central Speedball Association"

+

The name of the Organization

+

+
Example +

+

"name": "Central Speedball Association" +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,47 +54,65 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/organization/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/organization/12345" +

sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated with the organization.


Example

"sameAs": [
  "https://www.facebook.com/everyoneactive/",
  "https://twitter.com/everyoneactive"
]

+

Lists the URL(s) of the official social media profile pages associated + with the organization.

+

+
Example +

+

"sameAs": [
"https://www.facebook.com/everyoneactive/",
"https://twitter.com/everyoneactive"
] +

telephone - Text + telephone + Text -

The telephone number of the Organization


Example

"telephone": "01234 567890"

+

The telephone number of the Organization

+

+
Example +

+

"telephone": "01234 567890" +

url - url + url + url -

A definitive canonical URL for the Organization.


Example

"url": "http://www.speedball-world.com"

+

A definitive canonical URL for the Organization.

+

+
Example +

+

"url": "http://www.speedball-world.com" +

- +### **Optional fields** -### **Optional fields** - @@ -104,33 +123,54 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + + - - + -
description - Text + description + Text -

The description of the Organization


Example

"description": "The national governing body of cycling"

+

The description of the Organization

+

+
Example +

+

"description": "The national governing body of cycling" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

logo - ImageObject + logo + ImageObject -

A logo for the Organization.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

A logo for the Organization.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/parking.md b/docs/data-model/types/parking.md index 1d5b05bd..d18ce763 100644 --- a/docs/data-model/types/parking.md +++ b/docs/data-model/types/parking.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Parking" + Text + Must always be present and set to "type": "Parking"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Roadside Parking"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Roadside Parking" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/partialschedule.md b/docs/data-model/types/partialschedule.md index 852a2ca8..b8cc1d8c 100644 --- a/docs/data-model/types/partialschedule.md +++ b/docs/data-model/types/partialschedule.md @@ -9,31 +9,13 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "PartialSchedule" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "PartialSchedule"` | ### **Recommended fields** - + @@ -44,38 +26,51 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + -
endTime - Time + endTime + Time -

The end time of the event.


Example

"endTime": "12:00:00"

+

The end time of the event.

+

+
Example +

+

"endTime": "12:00:00" +

repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

startTime - Time + startTime + Time -

The start time of the event.


Example

"startTime": "12:00:00"

+

The start time of the event.

+

+
Example +

+

"startTime": "12:00:00" +

- +### **Optional fields** -### **Optional fields** - @@ -86,105 +81,172 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek
- or -
Array of Text + 		byDay + Array of DayOfWeek +
- or - +
Array of Text 		-

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - Date + endDate + Date -

The end date of the schedule.


Example

"endDate": "2018-01-27"

+

The end date of the schedule.

+

+
Example +

+

"endDate": "2018-01-27" +

exceptDate - Array of Date
- or -
Array of DateTime + 		exceptDate + Array of Date +
- or - +
Array of DateTime 		-

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]

+

Exception dates where the schedule should not generate an event.

+

+
Example +

+

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] +

idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + identifier (@id) for every event described by the schedule (see below for + more information). This property is required if the data provider is supporting + third-party booking via the Open Booking API.

+

+
Example +

+

"idTemplate": "https://example.com/event{/id}" +

repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3

+

Defines the number of times a recurring Event will take place.

+

+
Example +

+

"repeatCount": 3 +

scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.


Example

"scheduledEventType": "Event"

+

The type of event this schedule related to.

+

+
Example +

+

"scheduledEventType": "Event" +

startDate - Date + startDate + Date -

The start date of the event.


Example

"startDate": "2018-01-27"

+

The start date of the event.

+

+
Example +

+

"startDate": "2018-01-27" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + URL (schema:url) for every event described by the schedule (see below for + more information). This property is required if the data provider wants + to provide participants with a unique URL to book to attend an event.

+

+
Example +

+

"urlTemplate": "https://example.com/event{/id}" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/person.md b/docs/data-model/types/person.md index 9c59018e..032f9e42 100644 --- a/docs/data-model/types/person.md +++ b/docs/data-model/types/person.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "Person" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "Person"` | ### **Recommended fields** - + @@ -44,20 +26,22 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/person/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/person/12345" +

+### **Optional fields** - -### **Optional fields** - @@ -68,69 +52,113 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + - - - + + - - + - - + - - + - - + - - + -
description - Text + description + Text -

The description of the Person


Example

"description": "The leader of the coaching team"

+

The description of the Person

+

+
Example +

+

"description": "The leader of the coaching team" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

logo - ImageObject + logo + ImageObject -

A logo for the person.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

A logo for the person.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

name - Text + name + Text -

A full name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"name": "Daley Thompson"

+

A full name for the person.

+

This person must give direct permission for their personal information + to be shared as part of the Open Data.

+

+
Example +

+

"name": "Daley Thompson" +

sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated with the person.


Example

"sameAs": "https://example.org/example-org"

+

Lists the URL(s) of the official social media profile pages associated + with the person.

+

+
Example +

+

"sameAs": "https://example.org/example-org" +

telephone - Text + telephone + Text -

The telephone number of the person


Example

"telephone": "01234 567890"

+

The telephone number of the person

+

+
Example +

+

"telephone": "01234 567890" +

url - url + url + url -

A URL where more information about the person may be found


Example

"url": "http://www.example.com/"

+

A URL where more information about the person may be found

+

+
Example +

+

"url": "http://www.example.com/" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/place.md b/docs/data-model/types/place.md index 65e2a20c..ce250875 100644 --- a/docs/data-model/types/place.md +++ b/docs/data-model/types/place.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - - + - - + -
type - Text + type - Must always be present and set to "type": "Place" + Text + Must always be present and set to "type": "Place"
name - Text + name + Text -

The name of the Place


Example

"name": "Raynes Park High School"

+

The name of the Place

+

+
Example +

+

"name": "Raynes Park High School" +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,92 +54,134 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - + - - + - - + - - + - - + - - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/place/12345" +

address - PostalAddress
- or -
Text + 		address + PostalAddress +
- or - +
Text 		-

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]

+

An array listing the Ammenities of the Place.

+

+
Example +

+

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] +

description - Text + description + Text -

The description of the Place


Example

"description": "Raynes Park High School in London"

+

The description of the Place

+

+
Example +

+

"description": "Raynes Park High School in London" +

geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the place, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

openingHoursSpecification - Array of OpeningHoursSpecification + openingHoursSpecification -

The times the Place is open

+ 		Array of OpeningHoursSpecification The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place


Example

"telephone": "01253 473934"

+

The telephone number for the Place

+

+
Example +

+

"telephone": "01253 473934" +

url - url + url + url -

The website for the Place


Example

"url": "http://www.rphs.org.uk/"

+

The website for the Place

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- +### **Optional fields** -### **Optional fields** - @@ -149,33 +192,54 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - + - - + -
containedInPlace - Place + containedInPlace + Place -

The place within which this Place exists


Example

"containedInPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
  "name": "Middlesbrough Sports Village"
}

+

The place within which this Place exists

+

+
Example +

+

"containedInPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
"name": "Middlesbrough Sports Village"
} +

containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}

+

Places that exist within this place

+

+
Example +

+

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/postaladdress.md b/docs/data-model/types/postaladdress.md index 5b57322a..29028dc7 100644 --- a/docs/data-model/types/postaladdress.md +++ b/docs/data-model/types/postaladdress.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,60 +20,82 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "PostalAddress" + Text + Must always be present and set to "type": "PostalAddress"
addressCountry - Text + addressCountry + Text -

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.


Example

"addressCountry": "GB"

+

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.

+

+
Example +

+

"addressCountry": "GB" +

addressLocality - Text + addressLocality + Text -

The locality, a suburb within a city or a town within a county or district.


Example

"addressLocality": "Shoreditch"

+

The locality, a suburb within a city or a town within a county or district.

+

+
Example +

+

"addressLocality": "Shoreditch" +

addressRegion - Text + addressRegion + Text -

The region, either a city or a county or district.


Example

"addressRegion": "London"

+

The region, either a city or a county or district.

+

+
Example +

+

"addressRegion": "London" +

postalCode - Text + postalCode + Text -

The postal code.


Example

"postalCode": "EC2A 4JE"

+

The postal code.

+

+
Example +

+

"postalCode": "EC2A 4JE" +

streetAddress - Text + streetAddress + Text -

The street address.


Example

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St"

+

The street address.

+

+
Example +

+

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/propertyvalue.md b/docs/data-model/types/propertyvalue.md index 6719f4bb..24b8f082 100644 --- a/docs/data-model/types/propertyvalue.md +++ b/docs/data-model/types/propertyvalue.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,38 +20,46 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "PropertyValue" + Text + Must always be present and set to "type": "PropertyValue"
name - Text + name + Text -

The name of this PropertyValue


Example

"name": "Vendor ID"

+

The name of this PropertyValue

+

+
Example +

+

"name": "Vendor ID" +

value - Text
- or -
Integer + 		value + Text +
- or - +
Integer 		-

The actual value of this identifier


Example

"value": "SB1234"

+

The actual value of this identifier

+

+
Example +

+

"value": "SB1234" +

- +### **Optional fields** -### **Optional fields** - @@ -62,15 +70,20 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + -
propertyID - url
- or -
Text + 		propertyID + url +
- or - +
Text 		-

A commonly used identifier for the characteristic represented by the property


Example

"propertyID": "ActivePlaces"

+

A commonly used identifier for the characteristic represented by the property

+

+
Example +

+

"propertyID": "ActivePlaces" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/quantitativevalue.md b/docs/data-model/types/quantitativevalue.md index 28f57819..86fd4b4b 100644 --- a/docs/data-model/types/quantitativevalue.md +++ b/docs/data-model/types/quantitativevalue.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "QuantitativeValue" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "QuantitativeValue"` | ### **Optional fields** - + @@ -44,24 +26,32 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. - - + - - + -
maxValue - Integer + maxValue + Integer -

The maximum value.


Example

"maxValue": 60

+

The maximum value.

+

+
Example +

+

"maxValue": 60 +

minValue - Integer + minValue + Integer -

The minimum value.


Example

"minValue": 16

+

The minimum value.

+

+
Example +

+

"minValue": 16 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/reserveaction.md b/docs/data-model/types/reserveaction.md index ad053fdd..24dbfc4d 100644 --- a/docs/data-model/types/reserveaction.md +++ b/docs/data-model/types/reserveaction.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ReserveAction" + Text + Must always be present and set to "type": "ReserveAction"
name - Text + name + Text -

The name of the action


Example

"name": "Book"

+

The name of the action

+

+
Example +

+

"name": "Book" +

target - EntryPoint + target + EntryPoint -

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}

+

A definition of the target of the action.

+

+
Example +

+

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/schedule.md b/docs/data-model/types/schedule.md index 9d38742f..8cbe81de 100644 --- a/docs/data-model/types/schedule.md +++ b/docs/data-model/types/schedule.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - + @@ -20,55 +20,72 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Schedule" + Text + Must always be present and set to "type": "Schedule"
endTime - Time + endTime + Time -

The end time of the event.


Example

"endTime": "12:00:00"

+

The end time of the event.

+

+
Example +

+

"endTime": "12:00:00" +

repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.


Example

"scheduledEventType": "Event"

+

The type of event this schedule related to.

+

+
Example +

+

"scheduledEventType": "Event" +

startTime - Time + startTime + Time -

The start time of the event.


Example

"startTime": "12:00:00"

+

The start time of the event.

+

+
Example +

+

"startTime": "12:00:00" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional, a data publisher must provide either a schema:byDay, schema:byMonth or byMonthDay for a schedule. @@ -82,38 +99,56 @@ While these properties are marked as optional, a data publisher must provide eit - byDay - - Array of DayOfWeek
- or -
Array of Text + byDay + + Array of DayOfWeek +
- or - +
Array of Text -

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

- byMonth - - Array of Integer + byMonth + + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

- byMonthDay - - Array of Integer + byMonthDay + + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

- +### **Recommended fields** - -### **Recommended fields** - @@ -124,56 +159,84 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - Date + endDate + Date -

The end date of the schedule.


Example

"endDate": "2018-01-27"

+

The end date of the schedule.

+

+
Example +

+

"endDate": "2018-01-27" +

idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + identifier (@id) for every event described by the schedule (see below for + more information). This property is required if the data provider is supporting + third-party booking via the Open Booking API.

+

+
Example +

+

"idTemplate": "https://example.com/event{/id}" +

startDate - Date + startDate + Date -

The start date of the event.


Example

"startDate": "2018-01-27"

+

The start date of the event.

+

+
Example +

+

"startDate": "2018-01-27" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + URL (schema:url) for every event described by the schedule (see below for + more information). This property is required if the data provider wants + to provide participants with a unique URL to book to attend an event.

+

+
Example +

+

"urlTemplate": "https://example.com/event{/id}" +

+### **Optional fields** - -### **Optional fields** - @@ -184,51 +247,82 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek
- or -
Array of Text + 		byDay + Array of DayOfWeek +
- or - +
Array of Text 		-

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

exceptDate - Array of Date
- or -
Array of DateTime + 		exceptDate + Array of Date +
- or - +
Array of DateTime 		-

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]

+

Exception dates where the schedule should not generate an event.

+

+
Example +

+

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] +

repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3

+

Defines the number of times a recurring Event will take place.

+

+
Example +

+

"repeatCount": 3 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/scheduledsession.md b/docs/data-model/types/scheduledsession.md index 5ae4a10b..64fc0cff 100644 --- a/docs/data-model/types/scheduledsession.md +++ b/docs/data-model/types/scheduledsession.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,56 +20,84 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ScheduledSession" + Text + Must always be present and set to "type": "ScheduledSession"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,83 +108,129 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Optional fields** -### **Optional fields** - @@ -167,195 +241,332 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/sessionseries.md b/docs/data-model/types/sessionseries.md index 4c4e26c0..cedbdfe8 100644 --- a/docs/data-model/types/sessionseries.md +++ b/docs/data-model/types/sessionseries.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,65 +20,99 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "SessionSeries" + Text + Must always be present and set to "type": "SessionSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -89,83 +123,132 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

- +### **Optional fields** -### **Optional fields** - @@ -176,195 +259,324 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

subEvent - Array of ScheduledSession + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of ScheduledSession Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/showers.md b/docs/data-model/types/showers.md index 33f60e9c..2f7579e1 100644 --- a/docs/data-model/types/showers.md +++ b/docs/data-model/types/showers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Showers" + Text + Must always be present and set to "type": "Showers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Poolside Showers"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Poolside Showers" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/slot.md b/docs/data-model/types/slot.md index 34880694..361b211b 100644 --- a/docs/data-model/types/slot.md +++ b/docs/data-model/types/slot.md @@ -4,12 +4,10 @@ description: This page describes the Slot type. # Slot - - ## **Fields** ### **Required fields** - + @@ -20,55 +18,75 @@ description: This page describes the Slot type. - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Slot" + Text + Must always be present and set to "type": "Slot"
duration - Duration + duration + Duration -

The duration of the slot given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the slot given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

facilityUse - url + facilityUse + url -

URI to the FacilityUse that has this offer


Example

"facilityUse": "https://example.com/facility-use/1"

+

URI to the FacilityUse that has this offer

+

+
Example +

+

"facilityUse": "https://example.com/facility-use/1" +

remainingUses - Integer + remainingUses + Integer -

The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"remainingUses": 5

+

The remaining available courts or pitches at this time. Must be 0 or 1 + for an IndividualFacilityUse.

+

+
Example +

+

"remainingUses": 5 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the slot. Can be specified as a schema:Date or schema:DateTime


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the slot. Can be specified as a schema:Date + or schema:DateTime

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional/recommended in the Modelling Specification, one of these must be provided when surfacing a slot through an RPDE feed to ensure that the slots can be processed correctly by data consumers. @@ -82,29 +100,44 @@ While these properties are marked as optional/recommended in the Modelling Speci - id - - url + id + + url -

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/slot/12345" +

- identifier - - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + identifier + + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer -

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- +### **Recommended fields** - -### **Recommended fields** - @@ -115,29 +148,37 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/slot/12345" +

maximumUses - Integer + maximumUses + Integer -

The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"maximumUses": 16

+

The maximum available courts or pitches at this time. Must be 0 or 1 for + an IndividualFacilityUse.

+

+
Example +

+

"maximumUses": 16 +

- +### **Optional fields** -### **Optional fields** - @@ -148,33 +189,59 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + - - + -
endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the slot. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an slot.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the slot. Can be specified as a schema:Date or + schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an slot.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/sportsactivitylocation.md b/docs/data-model/types/sportsactivitylocation.md index d969ce78..44c23b8e 100644 --- a/docs/data-model/types/sportsactivitylocation.md +++ b/docs/data-model/types/sportsactivitylocation.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "SportsActivityLocation" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "SportsActivityLocation"` | ### **Recommended fields** - + @@ -44,20 +26,22 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/place/12345" +

- +### **Optional fields** -### **Optional fields** - @@ -68,114 +52,184 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - + - - + -
address - PostalAddress
- or -
Text + 		address + PostalAddress +
- or - +
Text 		-

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]

+

An array listing the Ammenities of the Place.

+

+
Example +

+

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] +

containedInPlace - Place
- or -
url + 		containedInPlace + Place +
- or - +
url 		-

While a url is not specified as an option in the Modelling Specification, it is necessary to link entities in RPDE.


Example

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d"

+

While a url is not specified as an option in the Modelling + Specification, it is necessary to link entities in RPDE.

+

+
Example +

+

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d" +

containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}

+

Places that exist within this place

+

+
Example +

+

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} +

description - Text + description + Text -

The description of the Place


Example

"description": "Raynes Park High School in London"

+

The description of the Place

+

+
Example +

+

"description": "Raynes Park High School in London" +

geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the place, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

name - Text + name + Text -

The name of the Place


Example

"name": "Raynes Park High School"

+

The name of the Place

+

+
Example +

+

"name": "Raynes Park High School" +

openingHoursSpecification - Array of OpeningHoursSpecification + openingHoursSpecification -

The times the Place is open

+ 		Array of OpeningHoursSpecification The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place


Example

"telephone": "01253 473934"

+

The telephone number for the Place

+

+
Example +

+

"telephone": "01253 473934" +

url - url + url + url -

The website for the Place


Example

"url": "http://www.rphs.org.uk/"

+

The website for the Place

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/toilets.md b/docs/data-model/types/toilets.md index f5248106..f8e164c9 100644 --- a/docs/data-model/types/toilets.md +++ b/docs/data-model/types/toilets.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Toilets" + Text + Must always be present and set to "type": "Toilets"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Public Toilets"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Public Toilets" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/towels.md b/docs/data-model/types/towels.md index 063eb9c0..14fb351e 100644 --- a/docs/data-model/types/towels.md +++ b/docs/data-model/types/towels.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Towels" + Text + Must always be present and set to "type": "Towels"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Complementary Towels"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Complementary Towels" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/using-data/harvesting-opportunity-data.md b/docs/using-data/harvesting-opportunity-data.md index 4b8c53a2..21fb0adf 100644 --- a/docs/using-data/harvesting-opportunity-data.md +++ b/docs/using-data/harvesting-opportunity-data.md @@ -2,7 +2,7 @@ ## **Introduction** {#introduction} -To follow along you’ll need some existing knowledge of programming, including familiarity with HTTP, JSON, and APIs.. +To follow along you’ll need some existing knowledge of programming, including familiarity with HTTP, JSON, and APIs. This guide is intended to be language agnostic, and is instead a guide to strategy and a general approach that should suit multiple implementations. Where code examples exist, they are intended as quick start assets rather than being production-ready. diff --git a/docs/using-data/how-to-find-opportunity-data-using-the-openactive-opportunity-data-dashboard.md b/docs/using-data/how-to-find-opportunity-data-using-the-openactive-opportunity-data-dashboard.md new file mode 100644 index 00000000..756dc3c9 --- /dev/null +++ b/docs/using-data/how-to-find-opportunity-data-using-the-openactive-opportunity-data-dashboard.md @@ -0,0 +1,85 @@ +# How to find opportunity data using the OpenActive Opportunity Data Dashboard + +## **Introduction** + +**If you’re looking to use physical activity opportunity data within your website or app, you’re probably wanting to understand what’s available to you, and to identify which of it will help you meet your goals. To support people with this we’ve created the OpenActive Opportunity Data Dashboard.** + + +**The status dashboard can be found at** [**status.openactive.io**](http://status.openactive.io/)**. It lists all of the openly licensed datasets and APIs published as part of the OpenActive initiative, as well as highlighting attributes of each set.** + + +**In this guide we’ll cover:** + + +* **Seeing what data is available** +* **How you can find data that meets your needs** +* **Taking your next steps** + +## **How to see all of the open opportunity data that’s available** + +**When landing on** [**status.openactive.io**](http://status.openactive.io/)**, you’re presented with a table that contains an overview of each dataset currently available under the OpenActive initiative. Each row on the table represents a different dataset. These are ordered alphabetically by default, but you can sort the table in different ways to help you explore.** + + +![The API status dashboard, with a selection of datasets highlighted](https://lh5.googleusercontent.com/is13vfrrV1BvSGpSdgC4V7d9xo4y2IlsqVUo4lgUm4sB7ejgfJSAHlTp2jhMuj0hrsUvlzz-qN3zFQIFmfFjfGpNhEvjelovWq_8jL0TD8cuUt9prik9uXr_Ph_twSJMYQsMMMB9) + +**As part of** [**the publishing process**](https://www.openactive.io/getting-started/) **for datasets, we ask publishers to provide some basic information about their feeds, including where the endpoint is located. Because of this, feeds will automatically appear on the dashboard when they’re reviewed and published.** + + +**The list of datasets on the dashboard and the summaries are regularly updated. The date and time of the last update is displayed on the main page and the individual dataset summary pages** + + +**You can keep up to date with new datasets by checking the site periodically, by signing up to the** [**mailing list**](https://us13.list-manage.com/subscribe?u=9e6648557f84731796a4ac873&id=1665f95799)**, or at the bottom of the page there is an option to ‘**[**Download JSON list**](http://status.openactive.io/datasets.json)**’. This links to a file containing a snapshot of all of the information on the status site, including the sampled output. You can use this machine-readable version to automatically integrate new datasets into your application.** + + +![A view of the contents of the status dashboard summary JSON file](https://lh4.googleusercontent.com/Sn9bpyu6cJsGBzTTXeVdBZoXU3QJhY8bN_c6HakjrARe02Anxh5IUCCgaH1sQeeQFKjqYqhKflavGNqZJmDU1B8cDvF4UElW6yATLcWvrG2gS9tUpuiiIzMk0ZWVG3W46_vnW8_q) + + + +## **How to find information that meets your needs** + +**Whilst some people may wish to harvest all of the data available, others will be focused on certain types of data - perhaps certain activities or geographies - and may wish to understand more about the content of the datasets. The status site lets you do this in a few different ways. Looking at each row in the table, you may want to consider some or all of the following:** + + +### **Key dataset information** + +* **Provider - includes the name of the organisation publishing the data. This links through to more information, optionally including mailing list, documentation, and more.** +* **Endpoint - includes an indicator of whether the API is currently up or down. This links through to the URL for the dataset/API.** + +**Conformance to standards, and known issues** + +* **Uses paging spec - with a link to the specification itself in the header of the table, this column represents whether or not the dataset conforms to the standards around how data is transferred for harvesting. For each feed, clicking on the entry will take you to the validator tool which will tell you of the errors conforming to v1.1 of the RPDE spec.** +* **Uses opportunity model - similarly, the opportunity model specification is linked in the table header. This column represents whether or not the dataset conforms to standards around the model of the data itself. For each feed, clicking on the entry will take you to the validator tool which will tell you of any errors conforming to v2 of the data model spec.** +* **Issues - showing the number of open issues and discussions relating to this dataset. This links through to the dataset’s GitHub issue tracker.** + +\*\*\*\* + +### **Activity types and geography** + +* **Summary - if a dataset conforms to the standard data model then the dashboard will automatically generate a summary page for it. These pages are based on a daily sample of data from the data feed and provide an overview of the most common activities present in the dataset, as well as a summaryof their geographical spread across local authority areas. Please note that as the counts are from a sample, they are not reflective of the total number of opportunities.** +* **Includes coordinates - a recommendation of the standards is that opportunity data should include geographic coordinates for locations, to better support geographical searching. Where there is any evidence of coordinates, this flag is set to yes.** + +![An example view of a summary page for a dataset](https://lh5.googleusercontent.com/Egjsca79kyPKii792w-tyDjOkHFxO83msIKjnvCsESeeGky7uO08nQYP7n3J2TQQ5-owneeaPgSCoMtiC7iGa1E9Lt-Pyv8e5S0srpRDhuE269WaooCZ3NrQTbuDcNlGPhWEkFEe) + + +**** + +### **How the data can be used** + +* **Licence - this indicates which open data licence the publisher has chosen to apply to their dataset. OpenActive recommends the Creative Commons Attribution licence which means you can use the data for any purpose, so long as you attribute your sources.** + +## **How to use the data that you’ve found** + +**Once you’ve identified and made of note of the datasets that meet your needs, you’ll then need to harvest the data for each using their endpoints \(linked through in the endpoint column, or found using the data-url attribute in the JSON file\).** + + +**How to do this is covered in another tutorial, which you can find** [**here**](harvesting-opportunity-data.md)**.** + + +## **What if there is other data you want?** + +**If there’s data missing from providers with an open feed \(e.g. they’ve only published kids activities and you want to use adult activities, or they haven’t provided detailed enough descriptions\) let them know through their GitHub repository, linked through their line on the status page. You can also let us know at** [**hello@openactive.io**](mailto:hello@openactive.io) **or on** [**Slack** ](https://www.openactive.io/public-openactive-w3c/)**as we can help coordinate you with other data users.** + + +**If you’re looking for data from a provider who isn’t yet open, let us know at** [**hello@openactive.io**](mailto:hello@openactive.io)**. We can let you know where that organisation is at in their open data journey, link you up to other data users so you can coordinate efforts, and support you to work directly with the data provider to get the data you want.** + + From 4dc8820c46304ce63292904cd612f3b3bba580f7 Mon Sep 17 00:00:00 2001 From: Travis CI Date: Fri, 12 Oct 2018 15:58:01 +0000 Subject: [PATCH 04/10] Updating auto-generated model documentation: 76 [ci skip] --- docs/data-model/types/action.md | 41 +- docs/data-model/types/babychanging.md | 36 +- docs/data-model/types/brand.md | 98 ++- docs/data-model/types/changingfacilities.md | 36 +- docs/data-model/types/concept.md | 118 ++-- docs/data-model/types/conceptscheme.md | 101 ++-- docs/data-model/types/courseinstance.md | 570 ++++++------------ docs/data-model/types/creche.md | 36 +- docs/data-model/types/entrypoint.md | 51 +- docs/data-model/types/event.md | 570 ++++++------------ docs/data-model/types/eventseries.md | 535 +++++----------- docs/data-model/types/facilityuse.md | 292 +++------ docs/data-model/types/geocoordinates.md | 41 +- docs/data-model/types/headlineevent.md | 521 +++++----------- docs/data-model/types/imageobject.md | 51 +- .../data-model/types/individualfacilityuse.md | 287 ++++----- .../types/locationfeaturespecification.md | 36 +- docs/data-model/types/lockers.md | 36 +- docs/data-model/types/offer.md | 163 ++--- .../types/openinghoursspecification.md | 54 +- docs/data-model/types/organization.md | 142 ++--- docs/data-model/types/parking.md | 36 +- docs/data-model/types/partialschedule.md | 232 +++---- docs/data-model/types/person.md | 154 ++--- docs/data-model/types/place.md | 204 +++---- docs/data-model/types/postaladdress.md | 80 +-- docs/data-model/types/propertyvalue.md | 63 +- docs/data-model/types/quantitativevalue.md | 56 +- docs/data-model/types/reserveaction.md | 41 +- docs/data-model/types/schedule.md | 272 +++------ docs/data-model/types/scheduledsession.md | 511 +++++----------- docs/data-model/types/sessionseries.md | 522 +++++----------- docs/data-model/types/showers.md | 36 +- docs/data-model/types/slot.md | 201 ++---- .../types/sportsactivitylocation.md | 218 +++---- docs/data-model/types/toilets.md | 36 +- docs/data-model/types/towels.md | 36 +- 37 files changed, 2222 insertions(+), 4291 deletions(-) diff --git a/docs/data-model/types/action.md b/docs/data-model/types/action.md index 69ab11b0..6a2d7d3c 100644 --- a/docs/data-model/types/action.md +++ b/docs/data-model/types/action.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Action" + + Must always be present and set to "type": "Action"
name - Text + name + Text -

The name of the action

-

-
Example -

-

"name": "Book" -

+

The name of the action


Example

"name": "Book"
target - EntryPoint + target + EntryPoint -

A definition of the target of the action.

-

-
Example -

-

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} -

+

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/babychanging.md b/docs/data-model/types/babychanging.md index 96aacca1..afddc50c 100644 --- a/docs/data-model/types/babychanging.md +++ b/docs/data-model/types/babychanging.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "BabyChanging" + + Must always be present and set to "type": "BabyChanging"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Baby Changing Facilities" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Baby Changing Facilities"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/brand.md b/docs/data-model/types/brand.md index c4584376..80615e68 100644 --- a/docs/data-model/types/brand.md +++ b/docs/data-model/types/brand.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), ## **Fields** ### **Required fields** - + @@ -20,44 +20,38 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Brand" + + Must always be present and set to "type": "Brand"
name - Text + name + Text -

The name of the brand.

-

-
Example -

-

"name": "Play Ball!" -

+

The name of the brand.


Example

"name": "Play Ball!"
url - url + url + url -

A url where further information can be found for the brand.

-

-
Example -

-

"url": "http://example.com/play_ball" -

+

A url where further information can be found for the brand.


Example

"url": "http://example.com/play_ball"
### **Recommended fields** + + +### **Recommended fields** + @@ -68,36 +62,29 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - + -
description - Text + description + Text -

A text description for the brand.

-

-
Example -

-

"description": "Play Ball! is a series of games for people of all abilities." -

+

A text description for the brand.


Example

"description": "Play Ball! is a series of games for people of all abilities."
logo - ImageObject + logo + ImageObject -

The logo associated with the brand.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

The logo associated with the brand.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
### **Optional fields** + + +### **Optional fields** + @@ -108,26 +95,15 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + -
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "BR1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "BR1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/changingfacilities.md b/docs/data-model/types/changingfacilities.md index c6a201ef..2b65ac39 100644 --- a/docs/data-model/types/changingfacilities.md +++ b/docs/data-model/types/changingfacilities.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "ChangingFacilities" + + Must always be present and set to "type": "ChangingFacilities"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Changing Rooms" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Changing Rooms"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/concept.md b/docs/data-model/types/concept.md index 8fe8e544..367ffb27 100644 --- a/docs/data-model/types/concept.md +++ b/docs/data-model/types/concept.md @@ -4,12 +4,12 @@ description: This page describes the Concept type. # Concept -This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http://www.w3.org/2004/02/skos/core#Concept). +This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://www.w3.org/2004/02/skos/core#Concept). ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Concept" + + Must always be present and set to "type": "Concept"
prefLabel - Text + prefLabel + Text -

A human readable string for use in user interfaces.

-

-
Example -

-

"prefLabel": "Speedball" -

+

A human readable string for use in user interfaces.


Example

"prefLabel": "Speedball"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,36 +53,29 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/concept/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/concept/12345"
inScheme - url + inScheme + url -

A stable URL reference for the taxonomy.

-

-
Example -

-

"inScheme": "https://example.com/reference/activities" -

+

A stable URL reference for the taxonomy.


Example

"inScheme": "https://example.com/reference/activities"
### **Optional fields** + + +### **Optional fields** + @@ -94,60 +86,42 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - + - - + - - + -
altLabel - Array of Text + altLabel + Array of Text -

An alternative human readable string for use in user interfaces.

-

-
Example -

-

"altLabel": "Speedball" -

+

An alternative human readable string for use in user interfaces.


Example

"altLabel": "Speedball"
broader - Array of url + broader + Array of url -

A broader Concept URI

-

-
Example -

-

"broader": "https://example.com/football" -

+

A broader Concept URI


Example

"broader": "https://example.com/football"
narrower - Array of url + narrower + Array of url -

A more specific concept URI

-

-
Example -

-

"narrower": "https://example.com/walking-football" -

+

A more specific concept URI


Example

"narrower": "https://example.com/walking-football"
notation - Text + notation + Text -

A concept label that is not normally recognisable as natural language.

-

-
Example -

-

"notation": "Speedball" -

+

A concept label that is not normally recognisable as natural language.


Example

"notation": "Speedball"
\ No newline at end of file + + + diff --git a/docs/data-model/types/conceptscheme.md b/docs/data-model/types/conceptscheme.md index aa531e69..d3acfe5e 100644 --- a/docs/data-model/types/conceptscheme.md +++ b/docs/data-model/types/conceptscheme.md @@ -4,12 +4,12 @@ description: This page describes the ConceptScheme type. # ConceptScheme -This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). +This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). ## **Fields** ### **Required fields** - + @@ -20,73 +20,56 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](h - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ConceptScheme" + + Must always be present and set to "type": "ConceptScheme"
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/scheme/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/scheme/12345"
concept - Array of Concept + concept + Array of Concept -

A collection of concepts that are part of this scheme

-

-
Example -

-

"concept": [
{
"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"
}
] -

+

A collection of concepts that are part of this scheme


Example

"concept": [
  {
    "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"
  }
]
title - Text + title + Text -

The title of the scheme

-

-
Example -

-

"title": "Activity List" -

+

The title of the scheme


Example

"title": "Activity List"
url - url + url + url -

A URL to a web page (or section of a page) that describes the concept - scheme.

-

-
Example -

-

"url": "https://example.com/scheme/1234" -

+

A URL to a web page (or section of a page) that describes the concept scheme.


Example

"url": "https://example.com/scheme/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -97,32 +80,24 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](h - - + - - + -
description - Text + description + Text -

A free text description of the taxonomy

-

-
Example -

-

"description": "An example activity list." -

+

A free text description of the taxonomy


Example

"description": "An example activity list."
license - url + license + url -

Reference to the license under which the activity list has been published.

-

-
Example -

-

"license": "https://example.com/license/MIT" -

+

Reference to the license under which the activity list has been published.


Example

"license": "https://example.com/license/MIT"
\ No newline at end of file + + + diff --git a/docs/data-model/types/courseinstance.md b/docs/data-model/types/courseinstance.md index 3d286bf9..434844f7 100644 --- a/docs/data-model/types/courseinstance.md +++ b/docs/data-model/types/courseinstance.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe ## **Fields** ### **Required fields** - + @@ -20,98 +20,64 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "CourseInstance" + + Must always be present and set to "type": "CourseInstance"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. @@ -125,40 +91,29 @@ While these properties are marked as optional, a data publisher must provide eit - startDate - - DateTime -
- or - -
Date + startDate + + DateTime
- or -
Date -

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

-### **Recommended fields** + + +### **Recommended fields** + @@ -169,211 +124,128 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Optional fields** + + +### **Optional fields** + @@ -384,259 +256,159 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/creche.md b/docs/data-model/types/creche.md index 1023ec78..2ee2db11 100644 --- a/docs/data-model/types/creche.md +++ b/docs/data-model/types/creche.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Creche" + + Must always be present and set to "type": "Creche"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Childcare" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Childcare"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/entrypoint.md b/docs/data-model/types/entrypoint.md index e487be2c..960e3c97 100644 --- a/docs/data-model/types/entrypoint.md +++ b/docs/data-model/types/entrypoint.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent ## **Fields** ### **Required fields** - + @@ -20,49 +20,42 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent - - + - - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "EntryPoint" + + Must always be present and set to "type": "EntryPoint"
encodingType - Text + encodingType + Text Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json" + + Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json"
httpMethod - Text + httpMethod + Text -

An HTTP method that specifies the appropriate HTTP method for a request - to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.

-

-
Example -

-

"httpMethod": "POST" -

+

An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.


Example

"httpMethod": "POST"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

URL of the item

-

-
Example -

-

"urlTemplate": "https://example.com/orders{/var}" -

+

URL of the item


Example

"urlTemplate": "https://example.com/orders{/var}"
\ No newline at end of file + + + diff --git a/docs/data-model/types/event.md b/docs/data-model/types/event.md index 2d10a8a7..bfc679e5 100644 --- a/docs/data-model/types/event.md +++ b/docs/data-model/types/event.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,98 +20,64 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Event" + + Must always be present and set to "type": "Event"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. @@ -125,40 +91,29 @@ While these properties are marked as optional, a data publisher must provide eit - startDate - - DateTime -
- or - -
Date + startDate + + DateTime
- or -
Date -

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

-### **Recommended fields** + + +### **Recommended fields** + @@ -169,211 +124,128 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Optional fields** + + +### **Optional fields** + @@ -384,259 +256,159 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/eventseries.md b/docs/data-model/types/eventseries.md index 6aae6a49..7f3bc1b4 100644 --- a/docs/data-model/types/eventseries.md +++ b/docs/data-model/types/eventseries.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi ## **Fields** ### **Required fields** - + @@ -20,77 +20,56 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "EventSeries" + + Must always be present and set to "type": "EventSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -101,175 +80,110 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
### **Optional fields** + + +### **Optional fields** + @@ -280,317 +194,186 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/facilityuse.md b/docs/data-model/types/facilityuse.md index eccc90b5..c9e80ea3 100644 --- a/docs/data-model/types/facilityuse.md +++ b/docs/data-model/types/facilityuse.md @@ -4,10 +4,12 @@ description: This page describes the FacilityUse type. # FacilityUse + + ## **Fields** ### **Required fields** - + @@ -18,80 +20,65 @@ description: This page describes the FacilityUse type. - - + - - - + - - + - - + - + + - - - - + -
type - Text + type + Text Must always be present and set to "type": "FacilityUse" + + Must always be present and set to "type": "FacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - a facility use.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the facility use will take place.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the facility use

-

-
Example -

-

"name": "Speedball" -

+

The name of the facility use


Example

"name": "Speedball"
provider + provider + + +

The organisation responsible for providing the facility

The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility - use.

-

-
Example -

-

"url": "https://example.com/facility-use/1234" -

+

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -102,86 +89,65 @@ description: This page describes the FacilityUse type. - - + - - + - - + - + - - - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/facility-use/112345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"
description - Text + description + Text -

A free text description of the facility use

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."
event - Array of Slot + event + Array of Slot -

An array of slots of availability of this FacilityUse.

-

-
Example -

-

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 3,
"maximumUses": 6
}
] -

+

An array of slots of availability of this FacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 3,
    "maximumUses": 6
  }
]
hoursAvailable + hoursAvailable + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the facility use is available

The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at - a previous event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
### **Optional fields** + + +### **Optional fields** + @@ -192,136 +158,78 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. - more information on how to find it, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." -

+

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.

-

-
Example -

-

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] -

+

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
individualFacilityUse - Array of IndividualFacilityUse + individualFacilityUse + Array of IndividualFacilityUse -

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse - (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse - (e.g. an opportunity to play tennis on a specific court).

-

-
Example -

-

"individualFacilityUse": [
{
"type": "IndividualFacilityUse",
"id": "http://www.example.org/facility-uses/1",
"name": "Tennis Court 1"
}
] -

+

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court).


Example

"individualFacilityUse": [
  {
    "type": "IndividualFacilityUse",
    "id": "http://www.example.org/facility-uses/1",
    "name": "Tennis Court 1"
  }
]
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
\ No newline at end of file + + + diff --git a/docs/data-model/types/geocoordinates.md b/docs/data-model/types/geocoordinates.md index 279b2904..8d98bd79 100644 --- a/docs/data-model/types/geocoordinates.md +++ b/docs/data-model/types/geocoordinates.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "GeoCoordinates" + + Must always be present and set to "type": "GeoCoordinates"
latitude - Float + latitude + Float -

The latitude of a location. For example 51.522338 (WGS 84).

-

-
Example -

-

"latitude": 51.522338 -

+

The latitude of a location. For example 51.522338 (WGS 84).


Example

"latitude": 51.522338
longitude - Float + longitude + Float -

The longitude of a location. For example -0.083437 (WGS 84).

-

-
Example -

-

"longitude": -0.083437 -

+

The longitude of a location. For example -0.083437 (WGS 84).


Example

"longitude": -0.083437
\ No newline at end of file + + + diff --git a/docs/data-model/types/headlineevent.md b/docs/data-model/types/headlineevent.md index 30a701f0..0e5406ab 100644 --- a/docs/data-model/types/headlineevent.md +++ b/docs/data-model/types/headlineevent.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,116 +20,74 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "HeadlineEvent" + + Must always be present and set to "type": "HeadlineEvent"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -140,194 +98,119 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
### **Optional fields** + + +### **Optional fields** + @@ -338,244 +221,150 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/imageobject.md b/docs/data-model/types/imageobject.md index 3d0cafa7..cdbb0626 100644 --- a/docs/data-model/types/imageobject.md +++ b/docs/data-model/types/imageobject.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im ## **Fields** ### **Required fields** - + @@ -20,31 +20,48 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im - - + - - + - + + +
type - Text + type + Text Must always be present and set to "type": "ImageObject" + + Must always be present and set to "type": "ImageObject"
url + url + url url + +

The URL for the display resolution image.


Example

"url": "http://example.com/static/image/speedball_large.jpg"

+
+ + +### **Optional fields** + + + + + + + + + + + + + -
PropertyExpected TypeDescription
thumbnail + Array of ImageObject -

The URL for the display resolution image.

-

-
Example -

-

"url": "http://example.com/static/image/speedball_large.jpg" -

+

The URL for a thumbnail image for an image.
### **Optional fields** + -| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **thumbnail** | Array of [`ImageObject`](https://docs.openactive.io/data-model/types/imageobject) | The URL for a thumbnail image for an image. | diff --git a/docs/data-model/types/individualfacilityuse.md b/docs/data-model/types/individualfacilityuse.md index ba69fdef..796fea75 100644 --- a/docs/data-model/types/individualfacilityuse.md +++ b/docs/data-model/types/individualfacilityuse.md @@ -4,10 +4,12 @@ description: This page describes the IndividualFacilityUse type. # IndividualFacilityUse + + ## **Fields** ### **Required fields** - + @@ -18,80 +20,65 @@ description: This page describes the IndividualFacilityUse type. - - + - - - + - - + - - + - + + - - - - + -
type - Text + type + Text Must always be present and set to "type": "IndividualFacilityUse" + + Must always be present and set to "type": "IndividualFacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - a facility use.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the facility use will take place.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the facility use

-

-
Example -

-

"name": "Speedball" -

+

The name of the facility use


Example

"name": "Speedball"
provider + provider + + +

The organisation responsible for providing the facility

The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility - use.

-

-
Example -

-

"url": "https://example.com/facility-use/1234" -

+

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -102,81 +89,65 @@ description: This page describes the IndividualFacilityUse type. - - + - + - - - - + - - + - + - - - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/facility-use/112345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"
aggregateFacilityUse + aggregateFacilityUse + FacilityUse FacilityUse + +

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location).

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse - (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse - (e.g. an opportunity to play tennis at a specific location).
description - Text + description + Text -

A free text description of the facility use

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."
event - Array of Slot + event + Array of Slot -

An array of slots of availability of this IndividualFacilityUse.

-

-
Example -

-

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 0,
"maximumUses": 1
}
] -

+

An array of slots of availability of this IndividualFacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 0,
    "maximumUses": 1
  }
]
hoursAvailable + hoursAvailable + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the facility use is available

The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at - a previous event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
### **Optional fields** + + +### **Optional fields** + @@ -187,134 +158,78 @@ description: This page describes the IndividualFacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. - more information on how to find it, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." -

+

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.

-

-
Example -

-

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] -

+

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
\ No newline at end of file + + + diff --git a/docs/data-model/types/locationfeaturespecification.md b/docs/data-model/types/locationfeaturespecification.md index 1b719113..6962df6d 100644 --- a/docs/data-model/types/locationfeaturespecification.md +++ b/docs/data-model/types/locationfeaturespecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "LocationFeatureSpecification" + + Must always be present and set to "type": "LocationFeatureSpecification"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Bike Shed" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Bike Shed"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/lockers.md b/docs/data-model/types/lockers.md index 6db45ee7..ad1972ce 100644 --- a/docs/data-model/types/lockers.md +++ b/docs/data-model/types/lockers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Lockers" + + Must always be present and set to "type": "Lockers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Indoor Lockers" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Indoor Lockers"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/offer.md b/docs/data-model/types/offer.md index 54853835..3c608cdc 100644 --- a/docs/data-model/types/offer.md +++ b/docs/data-model/types/offer.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), ## **Fields** ### **Required fields** - + @@ -20,33 +20,29 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Offer" + + Must always be present and set to "type": "Offer"
price - Float + price + Float -

The offer price of the activity.

-

This price should be specified without currency symbols and as a floating - point number with two decimal places.

-

The currency of the price should be expressed in the priceCurrency field.

-

-
Example -

-

"price": 33 -

+

The offer price of the activity.

This price should be specified without currency symbols and as a floating point number with two decimal places.

The currency of the price should be expressed in the priceCurrency field.


Example

"price": 33
### **Recommended fields** + + +### **Recommended fields** + @@ -57,82 +53,56 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/offer/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/offer/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
name - Text + name + Text -

A human readable name for the offer.

-

-
Example -

-

"name": "Speedball winger position" -

+

A human readable name for the offer.


Example

"name": "Speedball winger position"
priceCurrency - Text + priceCurrency + Text -

The currency (in 3-letter ISO 4217 format) of the price.

-

If an Offer has a zero price, then this property is not required. Otherwise - the currency must be specified.

-

-
Example -

-

"priceCurrency": "GBP" -

+

The currency (in 3-letter ISO 4217 format) of the price.

If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified.


Example

"priceCurrency": "GBP"
url - url + url + url -

URL describing the offer

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

URL describing the offer


Example

"url": "http://www.rphs.org.uk/"
### **Optional fields** + + +### **Optional fields** + @@ -143,56 +113,33 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + + - - + -
advanceBooking - RequiredStatusType + advanceBooking + RequiredStatusType -

Indicates whether to accept this offer, a participant must book in advance, - whether they must pay on attending, or have option to do either.

-

-
Example -

-

"advanceBooking": "https://openactive.io/Required" -

+

Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either.


Example

"advanceBooking": "https://openactive.io/Required"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
prepayment - RequiredStatusType + prepayment + RequiredStatusType -

Indicates whether to accept this offer, a participant must pay in advance, - pay when attending, or have the option to do either.

-

-
Example -

-

"prepayment": "https://openactive.io/Required" -

+

Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either.


Example

"prepayment": "https://openactive.io/Required"
\ No newline at end of file + + + diff --git a/docs/data-model/types/openinghoursspecification.md b/docs/data-model/types/openinghoursspecification.md index bf25b3da..1340d446 100644 --- a/docs/data-model/types/openinghoursspecification.md +++ b/docs/data-model/types/openinghoursspecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ ## **Fields** ### **Required fields** - + @@ -20,54 +20,42 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ - - + - - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "OpeningHoursSpecification" + + Must always be present and set to "type": "OpeningHoursSpecification"
closes - Time + closes + Time -

The closing time.

-

-
Example -

-

"closes": "17:00" -

+

The closing time.


Example

"closes": "17:00"
dayOfWeek - DayOfWeek + dayOfWeek + DayOfWeek -

Defines the day of the week upon which the Place is open

-

-
Example -

-

"dayOfWeek": "https://schema.org/Monday" -

+

Defines the day of the week upon which the Place is open


Example

"dayOfWeek": "https://schema.org/Monday"
opens - Time + opens + Time -

The opening time.

-

-
Example -

-

"opens": "09:00" -

+

The opening time.


Example

"opens": "09:00"
\ No newline at end of file + + + diff --git a/docs/data-model/types/organization.md b/docs/data-model/types/organization.md index 52c565df..2c7ef789 100644 --- a/docs/data-model/types/organization.md +++ b/docs/data-model/types/organization.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Organization" + + Must always be present and set to "type": "Organization"
name - Text + name + Text -

The name of the Organization

-

-
Example -

-

"name": "Central Speedball Association" -

+

The name of the Organization


Example

"name": "Central Speedball Association"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,65 +53,47 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/organization/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/organization/12345"
sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated - with the organization.

-

-
Example -

-

"sameAs": [
"https://www.facebook.com/everyoneactive/",
"https://twitter.com/everyoneactive"
] -

+

Lists the URL(s) of the official social media profile pages associated with the organization.


Example

"sameAs": [
  "https://www.facebook.com/everyoneactive/",
  "https://twitter.com/everyoneactive"
]
telephone - Text + telephone + Text -

The telephone number of the Organization

-

-
Example -

-

"telephone": "01234 567890" -

+

The telephone number of the Organization


Example

"telephone": "01234 567890"
url - url + url + url -

A definitive canonical URL for the Organization.

-

-
Example -

-

"url": "http://www.speedball-world.com" -

+

A definitive canonical URL for the Organization.


Example

"url": "http://www.speedball-world.com"
### **Optional fields** + + +### **Optional fields** + @@ -123,54 +104,33 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + + - - + -
description - Text + description + Text -

The description of the Organization

-

-
Example -

-

"description": "The national governing body of cycling" -

+

The description of the Organization


Example

"description": "The national governing body of cycling"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
logo - ImageObject + logo + ImageObject -

A logo for the Organization.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

A logo for the Organization.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/parking.md b/docs/data-model/types/parking.md index d18ce763..1d5b05bd 100644 --- a/docs/data-model/types/parking.md +++ b/docs/data-model/types/parking.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Parking" + + Must always be present and set to "type": "Parking"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Roadside Parking" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Roadside Parking"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/partialschedule.md b/docs/data-model/types/partialschedule.md index b8cc1d8c..852a2ca8 100644 --- a/docs/data-model/types/partialschedule.md +++ b/docs/data-model/types/partialschedule.md @@ -9,13 +9,31 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "PartialSchedule" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "PartialSchedule"` | ### **Recommended fields** - + @@ -26,51 +44,38 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + -
endTime - Time + endTime + Time -

The end time of the event.

-

-
Example -

-

"endTime": "12:00:00" -

+

The end time of the event.


Example

"endTime": "12:00:00"
repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"
startTime - Time + startTime + Time -

The start time of the event.

-

-
Example -

-

"startTime": "12:00:00" -

+

The start time of the event.


Example

"startTime": "12:00:00"
### **Optional fields** + + +### **Optional fields** + @@ -81,172 +86,105 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek -
- or - -
Array of Text + 		byDay + Array of DayOfWeek
- or -
Array of Text 		-

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]
byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]
byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - Date + endDate + Date -

The end date of the schedule.

-

-
Example -

-

"endDate": "2018-01-27" -

+

The end date of the schedule.


Example

"endDate": "2018-01-27"
exceptDate - Array of Date -
- or - -
Array of DateTime + 		exceptDate + Array of Date
- or -
Array of DateTime 		-

Exception dates where the schedule should not generate an event.

-

-
Example -

-

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] -

+

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]
idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - identifier (@id) for every event described by the schedule (see below for - more information). This property is required if the data provider is supporting - third-party booking via the Open Booking API.

-

-
Example -

-

"idTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"
repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.

-

-
Example -

-

"repeatCount": 3 -

+

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3
scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.

-

-
Example -

-

"scheduledEventType": "Event" -

+

The type of event this schedule related to.


Example

"scheduledEventType": "Event"
startDate - Date + startDate + Date -

The start date of the event.

-

-
Example -

-

"startDate": "2018-01-27" -

+

The start date of the event.


Example

"startDate": "2018-01-27"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - URL (schema:url) for every event described by the schedule (see below for - more information). This property is required if the data provider wants - to provide participants with a unique URL to book to attend an event.

-

-
Example -

-

"urlTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"
\ No newline at end of file + + + diff --git a/docs/data-model/types/person.md b/docs/data-model/types/person.md index 032f9e42..9c59018e 100644 --- a/docs/data-model/types/person.md +++ b/docs/data-model/types/person.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "Person" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "Person"` | ### **Recommended fields** - + @@ -26,22 +44,20 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/person/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/person/12345"
### **Optional fields** + + +### **Optional fields** + @@ -52,113 +68,69 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + - - - + + - - + - - + - - + - - + - - + -
description - Text + description + Text -

The description of the Person

-

-
Example -

-

"description": "The leader of the coaching team" -

+

The description of the Person


Example

"description": "The leader of the coaching team"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
logo - ImageObject + logo + ImageObject -

A logo for the person.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

A logo for the person.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
name - Text + name + Text -

A full name for the person.

-

This person must give direct permission for their personal information - to be shared as part of the Open Data.

-

-
Example -

-

"name": "Daley Thompson" -

+

A full name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"name": "Daley Thompson"
sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated - with the person.

-

-
Example -

-

"sameAs": "https://example.org/example-org" -

+

Lists the URL(s) of the official social media profile pages associated with the person.


Example

"sameAs": "https://example.org/example-org"
telephone - Text + telephone + Text -

The telephone number of the person

-

-
Example -

-

"telephone": "01234 567890" -

+

The telephone number of the person


Example

"telephone": "01234 567890"
url - url + url + url -

A URL where more information about the person may be found

-

-
Example -

-

"url": "http://www.example.com/" -

+

A URL where more information about the person may be found


Example

"url": "http://www.example.com/"
\ No newline at end of file + + + diff --git a/docs/data-model/types/place.md b/docs/data-model/types/place.md index ce250875..65e2a20c 100644 --- a/docs/data-model/types/place.md +++ b/docs/data-model/types/place.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Place" + + Must always be present and set to "type": "Place"
name - Text + name + Text -

The name of the Place

-

-
Example -

-

"name": "Raynes Park High School" -

+

The name of the Place


Example

"name": "Raynes Park High School"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,134 +53,92 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - + - - + - - + - - + - - + - + - - - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/place/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"
address - PostalAddress -
- or - -
Text + 		address + PostalAddress
- or -
Text 		-

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}
amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.

-

-
Example -

-

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] -

+

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]
description - Text + description + Text -

The description of the Place

-

-
Example -

-

"description": "Raynes Park High School in London" -

+

The description of the Place


Example

"description": "Raynes Park High School in London"
geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
openingHoursSpecification + openingHoursSpecification + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the Place is open

The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place

-

-
Example -

-

"telephone": "01253 473934" -

+

The telephone number for the Place


Example

"telephone": "01253 473934"
url - url + url + url -

The website for the Place

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

The website for the Place


Example

"url": "http://www.rphs.org.uk/"
### **Optional fields** + + +### **Optional fields** + @@ -192,54 +149,33 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - + - - + -
containedInPlace - Place + containedInPlace + Place -

The place within which this Place exists

-

-
Example -

-

"containedInPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
"name": "Middlesbrough Sports Village"
} -

+

The place within which this Place exists


Example

"containedInPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
  "name": "Middlesbrough Sports Village"
}
containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place

-

-
Example -

-

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} -

+

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/postaladdress.md b/docs/data-model/types/postaladdress.md index 29028dc7..5b57322a 100644 --- a/docs/data-model/types/postaladdress.md +++ b/docs/data-model/types/postaladdress.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,82 +20,60 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "PostalAddress" + + Must always be present and set to "type": "PostalAddress"
addressCountry - Text + addressCountry + Text -

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.

-

-
Example -

-

"addressCountry": "GB" -

+

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.


Example

"addressCountry": "GB"
addressLocality - Text + addressLocality + Text -

The locality, a suburb within a city or a town within a county or district.

-

-
Example -

-

"addressLocality": "Shoreditch" -

+

The locality, a suburb within a city or a town within a county or district.


Example

"addressLocality": "Shoreditch"
addressRegion - Text + addressRegion + Text -

The region, either a city or a county or district.

-

-
Example -

-

"addressRegion": "London" -

+

The region, either a city or a county or district.


Example

"addressRegion": "London"
postalCode - Text + postalCode + Text -

The postal code.

-

-
Example -

-

"postalCode": "EC2A 4JE" -

+

The postal code.


Example

"postalCode": "EC2A 4JE"
streetAddress - Text + streetAddress + Text -

The street address.

-

-
Example -

-

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St" -

+

The street address.


Example

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St"
\ No newline at end of file + + + diff --git a/docs/data-model/types/propertyvalue.md b/docs/data-model/types/propertyvalue.md index 24b8f082..6719f4bb 100644 --- a/docs/data-model/types/propertyvalue.md +++ b/docs/data-model/types/propertyvalue.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,46 +20,38 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "PropertyValue" + + Must always be present and set to "type": "PropertyValue"
name - Text + name + Text -

The name of this PropertyValue

-

-
Example -

-

"name": "Vendor ID" -

+

The name of this PropertyValue


Example

"name": "Vendor ID"
value - Text -
- or - -
Integer + 		value + Text
- or -
Integer 		-

The actual value of this identifier

-

-
Example -

-

"value": "SB1234" -

+

The actual value of this identifier


Example

"value": "SB1234"
### **Optional fields** + + +### **Optional fields** + @@ -70,20 +62,15 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + -
propertyID - url -
- or - -
Text + 		propertyID + url
- or -
Text 		-

A commonly used identifier for the characteristic represented by the property

-

-
Example -

-

"propertyID": "ActivePlaces" -

+

A commonly used identifier for the characteristic represented by the property


Example

"propertyID": "ActivePlaces"
\ No newline at end of file + + + diff --git a/docs/data-model/types/quantitativevalue.md b/docs/data-model/types/quantitativevalue.md index 86fd4b4b..28f57819 100644 --- a/docs/data-model/types/quantitativevalue.md +++ b/docs/data-model/types/quantitativevalue.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "QuantitativeValue" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "QuantitativeValue"` | ### **Optional fields** - + @@ -26,32 +44,24 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. - - + - - + -
maxValue - Integer + maxValue + Integer -

The maximum value.

-

-
Example -

-

"maxValue": 60 -

+

The maximum value.


Example

"maxValue": 60
minValue - Integer + minValue + Integer -

The minimum value.

-

-
Example -

-

"minValue": 16 -

+

The minimum value.


Example

"minValue": 16
\ No newline at end of file + + + diff --git a/docs/data-model/types/reserveaction.md b/docs/data-model/types/reserveaction.md index 24dbfc4d..ad053fdd 100644 --- a/docs/data-model/types/reserveaction.md +++ b/docs/data-model/types/reserveaction.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ReserveAction" + + Must always be present and set to "type": "ReserveAction"
name - Text + name + Text -

The name of the action

-

-
Example -

-

"name": "Book" -

+

The name of the action


Example

"name": "Book"
target - EntryPoint + target + EntryPoint -

A definition of the target of the action.

-

-
Example -

-

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} -

+

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/schedule.md b/docs/data-model/types/schedule.md index 8cbe81de..9d38742f 100644 --- a/docs/data-model/types/schedule.md +++ b/docs/data-model/types/schedule.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - + @@ -20,72 +20,55 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Schedule" + + Must always be present and set to "type": "Schedule"
endTime - Time + endTime + Time -

The end time of the event.

-

-
Example -

-

"endTime": "12:00:00" -

+

The end time of the event.


Example

"endTime": "12:00:00"
repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"
scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.

-

-
Example -

-

"scheduledEventType": "Event" -

+

The type of event this schedule related to.


Example

"scheduledEventType": "Event"
startTime - Time + startTime + Time -

The start time of the event.

-

-
Example -

-

"startTime": "12:00:00" -

+

The start time of the event.


Example

"startTime": "12:00:00"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional, a data publisher must provide either a schema:byDay, schema:byMonth or byMonthDay for a schedule. @@ -99,56 +82,38 @@ While these properties are marked as optional, a data publisher must provide eit - byDay - - Array of DayOfWeek -
- or - -
Array of Text + byDay + + Array of DayOfWeek
- or -
Array of Text -

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

- byMonth - - Array of Integer + byMonth + + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

- byMonthDay - - Array of Integer + byMonthDay + + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

-### **Recommended fields** + + +### **Recommended fields** + @@ -159,84 +124,56 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - Date + endDate + Date -

The end date of the schedule.

-

-
Example -

-

"endDate": "2018-01-27" -

+

The end date of the schedule.


Example

"endDate": "2018-01-27"
idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - identifier (@id) for every event described by the schedule (see below for - more information). This property is required if the data provider is supporting - third-party booking via the Open Booking API.

-

-
Example -

-

"idTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"
startDate - Date + startDate + Date -

The start date of the event.

-

-
Example -

-

"startDate": "2018-01-27" -

+

The start date of the event.


Example

"startDate": "2018-01-27"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - URL (schema:url) for every event described by the schedule (see below for - more information). This property is required if the data provider wants - to provide participants with a unique URL to book to attend an event.

-

-
Example -

-

"urlTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"
### **Optional fields** + + +### **Optional fields** + @@ -247,82 +184,51 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek -
- or - -
Array of Text + 		byDay + Array of DayOfWeek
- or -
Array of Text 		-

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]
byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]
byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]
exceptDate - Array of Date -
- or - -
Array of DateTime + 		exceptDate + Array of Date
- or -
Array of DateTime 		-

Exception dates where the schedule should not generate an event.

-

-
Example -

-

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] -

+

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]
repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.

-

-
Example -

-

"repeatCount": 3 -

+

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3
\ No newline at end of file + + + diff --git a/docs/data-model/types/scheduledsession.md b/docs/data-model/types/scheduledsession.md index 64fc0cff..5ae4a10b 100644 --- a/docs/data-model/types/scheduledsession.md +++ b/docs/data-model/types/scheduledsession.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,84 +20,56 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ScheduledSession" + + Must always be present and set to "type": "ScheduledSession"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Recommended fields** + + +### **Recommended fields** + @@ -108,129 +80,83 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Optional fields** + + +### **Optional fields** + @@ -241,332 +167,195 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/sessionseries.md b/docs/data-model/types/sessionseries.md index cedbdfe8..4c4e26c0 100644 --- a/docs/data-model/types/sessionseries.md +++ b/docs/data-model/types/sessionseries.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,99 +20,65 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "SessionSeries" + + Must always be present and set to "type": "SessionSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -123,132 +89,83 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
### **Optional fields** + + +### **Optional fields** + @@ -259,324 +176,195 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
subEvent + subEvent + Array of ScheduledSession Array of ScheduledSession + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/showers.md b/docs/data-model/types/showers.md index 2f7579e1..33f60e9c 100644 --- a/docs/data-model/types/showers.md +++ b/docs/data-model/types/showers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Showers" + + Must always be present and set to "type": "Showers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Poolside Showers" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Poolside Showers"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/slot.md b/docs/data-model/types/slot.md index 361b211b..34880694 100644 --- a/docs/data-model/types/slot.md +++ b/docs/data-model/types/slot.md @@ -4,10 +4,12 @@ description: This page describes the Slot type. # Slot + + ## **Fields** ### **Required fields** - + @@ -18,75 +20,55 @@ description: This page describes the Slot type. - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Slot" + + Must always be present and set to "type": "Slot"
duration - Duration + duration + Duration -

The duration of the slot given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the slot given in [ISO8601] format.


Example

"duration": "PT1H"
facilityUse - url + facilityUse + url -

URI to the FacilityUse that has this offer

-

-
Example -

-

"facilityUse": "https://example.com/facility-use/1" -

+

URI to the FacilityUse that has this offer


Example

"facilityUse": "https://example.com/facility-use/1"
remainingUses - Integer + remainingUses + Integer -

The remaining available courts or pitches at this time. Must be 0 or 1 - for an IndividualFacilityUse.

-

-
Example -

-

"remainingUses": 5 -

+

The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"remainingUses": 5
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the slot. Can be specified as a schema:Date - or schema:DateTime

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the slot. Can be specified as a schema:Date or schema:DateTime


Example

"startDate": "2018-01-27T12:00:00Z"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional/recommended in the Modelling Specification, one of these must be provided when surfacing a slot through an RPDE feed to ensure that the slots can be processed correctly by data consumers. @@ -100,44 +82,29 @@ While these properties are marked as optional/recommended in the Modelling Speci - id - - url + id + + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/slot/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

- identifier - - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + identifier + + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer -

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

-### **Recommended fields** + + +### **Recommended fields** + @@ -148,37 +115,29 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/slot/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"
maximumUses - Integer + maximumUses + Integer -

The maximum available courts or pitches at this time. Must be 0 or 1 for - an IndividualFacilityUse.

-

-
Example -

-

"maximumUses": 16 -

+

The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"maximumUses": 16
### **Optional fields** + + +### **Optional fields** + @@ -189,59 +148,33 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + - - + -
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the slot. Can be specified as a schema:Date or - schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an slot.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the slot. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an slot.


Example

"endDate": "2018-01-27T12:00:00Z"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/sportsactivitylocation.md b/docs/data-model/types/sportsactivitylocation.md index 44c23b8e..d969ce78 100644 --- a/docs/data-model/types/sportsactivitylocation.md +++ b/docs/data-model/types/sportsactivitylocation.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "SportsActivityLocation" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "SportsActivityLocation"` | ### **Recommended fields** - + @@ -26,22 +44,20 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/place/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"
### **Optional fields** + + +### **Optional fields** + @@ -52,184 +68,114 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - - + - - + -
address - PostalAddress -
- or - -
Text + 		address + PostalAddress
- or -
Text 		-

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}
amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.

-

-
Example -

-

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] -

+

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]
containedInPlace - Place -
- or - -
url + 		containedInPlace + Place
- or -
url 		-

While a url is not specified as an option in the Modelling - Specification, it is necessary to link entities in RPDE.

-

-
Example -

-

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d" -

+

While a url is not specified as an option in the Modelling Specification, it is necessary to link entities in RPDE.


Example

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d"
containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place

-

-
Example -

-

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} -

+

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}
description - Text + description + Text -

The description of the Place

-

-
Example -

-

"description": "Raynes Park High School in London" -

+

The description of the Place


Example

"description": "Raynes Park High School in London"
geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
name - Text + name + Text -

The name of the Place

-

-
Example -

-

"name": "Raynes Park High School" -

+

The name of the Place


Example

"name": "Raynes Park High School"
openingHoursSpecification + openingHoursSpecification + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the Place is open

The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place

-

-
Example -

-

"telephone": "01253 473934" -

+

The telephone number for the Place


Example

"telephone": "01253 473934"
url - url + url + url -

The website for the Place

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

The website for the Place


Example

"url": "http://www.rphs.org.uk/"
\ No newline at end of file + + + diff --git a/docs/data-model/types/toilets.md b/docs/data-model/types/toilets.md index f8e164c9..f5248106 100644 --- a/docs/data-model/types/toilets.md +++ b/docs/data-model/types/toilets.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Toilets" + + Must always be present and set to "type": "Toilets"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Public Toilets" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Public Toilets"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/towels.md b/docs/data-model/types/towels.md index 14fb351e..063eb9c0 100644 --- a/docs/data-model/types/towels.md +++ b/docs/data-model/types/towels.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Towels" + + Must always be present and set to "type": "Towels"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Complementary Towels" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Complementary Towels"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + From 30aa13f795feb381c127d6358da162f5d8ef135f Mon Sep 17 00:00:00 2001 From: Melanie Abraham Date: Thu, 25 Oct 2018 13:25:53 +0000 Subject: [PATCH 05/10] GitBook: [draft] 42 pages modified --- docs/SUMMARY.md | 1 + ...enactive-data-model-part-one-the-basics.md | 258 ++------ ...model-part-two-adding-additional-detail.md | 118 ++++ docs/data-model/types/action.md | 41 +- docs/data-model/types/babychanging.md | 36 +- docs/data-model/types/brand.md | 98 +-- docs/data-model/types/changingfacilities.md | 36 +- docs/data-model/types/concept.md | 118 ++-- docs/data-model/types/conceptscheme.md | 101 ++-- docs/data-model/types/courseinstance.md | 570 ++++++++++++------ docs/data-model/types/creche.md | 36 +- docs/data-model/types/entrypoint.md | 51 +- docs/data-model/types/event.md | 570 ++++++++++++------ docs/data-model/types/eventseries.md | 535 +++++++++++----- docs/data-model/types/facilityuse.md | 292 ++++++--- docs/data-model/types/geocoordinates.md | 41 +- docs/data-model/types/headlineevent.md | 521 +++++++++++----- docs/data-model/types/imageobject.md | 51 +- .../data-model/types/individualfacilityuse.md | 287 +++++---- .../types/locationfeaturespecification.md | 36 +- docs/data-model/types/lockers.md | 36 +- docs/data-model/types/offer.md | 163 +++-- .../types/openinghoursspecification.md | 54 +- docs/data-model/types/organization.md | 142 +++-- docs/data-model/types/parking.md | 36 +- docs/data-model/types/partialschedule.md | 232 ++++--- docs/data-model/types/person.md | 154 +++-- docs/data-model/types/place.md | 204 ++++--- docs/data-model/types/postaladdress.md | 80 ++- docs/data-model/types/propertyvalue.md | 63 +- docs/data-model/types/quantitativevalue.md | 56 +- docs/data-model/types/reserveaction.md | 41 +- docs/data-model/types/schedule.md | 272 ++++++--- docs/data-model/types/scheduledsession.md | 511 +++++++++++----- docs/data-model/types/sessionseries.md | 522 +++++++++++----- docs/data-model/types/showers.md | 36 +- docs/data-model/types/slot.md | 201 ++++-- .../types/sportsactivitylocation.md | 218 ++++--- docs/data-model/types/toilets.md | 36 +- docs/data-model/types/towels.md | 36 +- .../using-data/harvesting-opportunity-data.md | 28 +- ...e-openactive-opportunity-data-dashboard.md | 65 +- 42 files changed, 4511 insertions(+), 2472 deletions(-) create mode 100644 docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-two-adding-additional-detail.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 06911f67..ce5be298 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -58,6 +58,7 @@ * [Toilets](data-model/types/toilets.md) * [Towels](data-model/types/towels.md) * [Tutorial: describing events using the OpenActive data model - part one: the basics](data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md) +* [Tutorial: describing events using the OpenActive data model - part two: adding additional detail](data-model/tutorial-describing-events-using-the-openactive-data-model-part-two-adding-additional-detail.md) ## Specifications diff --git a/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md index 420658bf..103132c2 100644 --- a/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md +++ b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md @@ -1,99 +1,94 @@ # Tutorial: describing events using the OpenActive data model - part one: the basics -**Whether you’re aiming to publish open opportunity data or to use it, familiarity with the OpenActive data model will be key.** +Whether you’re aiming to publish open opportunity data or to use it, familiarity with the OpenActive data model will be key. -**In this tutorial we’ll be looking at how to describe an activity session using the standard data model we have developed with the community. We’ll cover all of the core properties that are** [**required**](https://www.openactive.io/modelling-opportunity-data/#required-and-optional-properties) **as part of the standards.** +In this tutorial we’ll be looking at how to describe an activity session using the standard data model we have developed with the community. The model described here will conform to the [Modelling Opportunity Data 2.0](https://www.openactive.io/modelling-opportunity-data/) specification. If you want to jump ahead for a sneak peek of the final version, you can find it in [the validator](https://validator.openactive.io/?url=https%3A%2F%2Fwww.openactive.io%2Fdata-models%2Fversions%2F2.x%2Fexamples%2Ftutorials%2Fdescribing-events%2Fpart-one-finished.json&version=2.0). We’ll cover all of the core properties that are [required](https://www.openactive.io/modelling-opportunity-data/#required-and-optional-properties) as part of the standards. -**The tutorial covers:** +The tutorial covers: -* **Understanding what the model is** -* **The format of a model** -* **How to describe a basic activity session** -* **Where to go next** +* Understanding what the model is +* The format of a model +* How to describe a basic activity session +* Where to go next -**By the end of this tutorial you should understand the concept behind the model, and be confident in describing your own events.** +By the end of this tutorial you should understand the concept behind the model, and be confident in describing your own events. -**This tutorial requires a general understanding of JSON, and use of a text editor if you wish to follow along or write your own examples.** - - -**The model described here will conform to the Modelling Opportunity Data 2.0 specification. If you want to jump ahead for a sneak peek of the final version, you can find it in the validator.** - +This tutorial requires a general understanding of JSON, and use of a text editor if you wish to follow along or write your own examples. ## **1. Understanding the data model** -**Before jumping in to create one, we first need to understand what we’re trying to create.** +Before jumping in to create one, we first need to understand what we’re trying to create. -**OpenActive is working to bring about change within the sport and physical activity sector by improving access to ‘open opportunity data’. This means making data about where and when sport and physical activities happen open for anyone to access, use and share. By doing this, more places, products and services can better inform people of opportunities to get active.** +OpenActive is working to bring about change within the sport and physical activity sector by improving access to ‘open opportunity data’. This means making data about where and when sport and physical activities happen open for anyone to access, use and share. By doing this, more places, products and services can better inform people of opportunities to get active. -**All of the following types of data can be published as open data, and collectively this is known as opportunity data:** +All of the following types of data can be published as open data, and collectively this is known as opportunity data: -* **descriptions and lists of physical activities** -* **details of the locations and venues at which activities or events takes place** -* **the facilities available at those locations** -* **the details of event involving physical activities e.g. when and where they will take place, restrictions on attendance, costs, etc** -* **any related information, e.g. about the format of the event, its organisers, etc** +* descriptions and lists of physical activities +* details of the locations and venues at which activities or events takes place +* the facilities available at those locations +* the details of event involving physical activities e.g. when and where they will take place, restrictions on attendance, costs, etc +* any related information, e.g. about the format of the event, its organisers, etc -**Having a consistent format is important because it makes it easier for everyone to publish and use data, and so we have standards.** [**Open standards**](https://standards.theodi.org/introduction/what-are-open-standards-for-data/) **for data are documented, reusable agreements that help people and organisations to publish, access, share and use better quality data.** +Having a consistent format is important because it makes it easier for everyone to publish and use data, and so we have standards. [Open standards](https://standards.theodi.org/introduction/what-are-open-standards-for-data/) for data are documented, reusable agreements that help people and organisations to publish, access, share and use better quality data. -**The data model that we’re going to walk through in this tutorial is an example of following the standards that the community have defined. It builds on existing standards \(such as** [**schema.org**](https://schema.org/)**, JSON-LD, and** [**Simple Knowledge Organization System \(SKOS\)**](https://www.w3.org/2004/02/skos/)**\), which has let us focus specifically on the aspects of describing opportunity data that are important to the physical activity sector.** +The data model that we’re going to walk through in this tutorial is an example of following the standards that the community have defined. It builds on existing standards \(such as [schema.org](https://schema.org/), JSON-LD, and [Simple Knowledge Organization System \(SKOS\)](https://www.w3.org/2004/02/skos/)\), which has let us focus specifically on the aspects of describing opportunity data that are important to the physical activity sector. ## **2. The format of a model** -**The recommended approach to publishing open opportunity data is as JSON, and specifically as JSON-LD \(a JSON-based serialization for linked data\). The use of JSON-LD for sharing structured information is also encouraged by people including** [**Google**](https://developers.google.com/search/docs/guides/intro-structured-data)**, and is an example of why it’s useful to have common approaches. In this tutorial all of our examples will be using JSON-LD format.** +The recommended approach to publishing open opportunity data is as JSON, and specifically as JSON-LD \(a JSON-based serialization for linked data\). The use of JSON-LD for sharing structured information is also encouraged by people including [Google](https://developers.google.com/search/docs/guides/intro-structured-data), and is an example of why it’s useful to have common approaches. In this tutorial all of our examples will be using JSON-LD format. ## **3. How to describe an activity session** ### **3.1 Add a context** -**For our starting foundations, all opportunity data should begin with a context contained within an opening and closing bracket \(see below\).** - +For our starting foundations, all opportunity data should begin with a context contained within an opening and closing bracket \(see below\). +**** | **{ "@context": "https://openactive.io/ns/oa.jsonld" }** | | :--- | -**A JSON-LD context maps the terms used in a JSON document to their standard definitions. To indicate that your data conforms to the OpenActive opportunity data specification, include a @context reference that matches the above.** +A JSON-LD context maps the terms used in a JSON document to their standard definitions. To indicate that your data conforms to the OpenActive opportunity data specification, include a @context reference that matches the above. - +**** ### **3.2 Adding basic session details** -**Now we can start to add in the information about the session itself. To illustrate this, we’re going to use a rollerblading fitness class.** +Now we can start to add in the information about the session itself. To illustrate this, we’re going to use a rollerblading fitness class. -**The following are the minimum requirements for modelling opportunity data:** +The following are the minimum requirements for modelling opportunity data: -* **define that it’s an event \(opportunity\)** -* **its name** -* **a URL providing a link to a web page describing the session** -* **an indication of the type of activity that will take place at an event** -* **the time at which the event will take place** -* **the location at which the event will take place** +* define that it’s an event \(opportunity\) +* its name +* a URL providing a link to a web page describing the session +* an indication of the type of activity that will take place at an event +* the time at which the event will take place +* the location at which the event will take place +* the person or organisation responsible for running the event -**Whilst this tutorial will help you to understand what’s necessary to get a basic, validating opportunity, there’s a lot more that you can do with the data. Other fields are optional, but might be recommended as they provide useful information for participants. Generally we encourage people to provide as much useful information as possible, while respecting privacy. We’ll talk a bit more about this in the second half of this tutorial, or you can refer to the** [**Required and Optional properties**](https://www.openactive.io/modelling-opportunity-data/#required-and-optional-properties) **part of the specification.** +Whilst this tutorial will help you to understand what’s necessary to get a basic, validating opportunity, there’s a lot more that you can do with the data. Other fields are optional, but might be recommended as they provide useful information for participants. Generally we encourage people to provide as much useful information as possible, while respecting privacy. We’ll talk a bit more about this in the second half of this tutorial, or you can refer to the [Required and Optional properties](https://www.openactive.io/modelling-opportunity-data/#required-and-optional-properties) part of the specification. -**Let’s walk through and build it up.** +Let’s walk through and build it up. #### **Defining the type of resource** -**Adding to the JSON-LD context that we added in the first step, we now want to start describing the event itself.** - - -**To describe what type of thing we're going to be sharing in our data, we need to add a type property. It’s possible for the data model to describe a number of different types of things, but as we're describing an Event we’ll use that as the value.** +Adding to the JSON-LD context that we added in the first step, we now want to start describing the event itself. +To describe what type of thing we're going to be sharing in our data, we need to add a type property. It’s possible for the data model to describe a number of different types of things, but as we're describing an Event we’ll use that as the value. @@ -109,8 +104,7 @@
#### **Give it a name and URL** -**Add in the name for your individual session, and the public URL where someone could go to find more information, or perhaps sign up to participate.** - +Add in the name for your individual session, and the public URL where someone could go to find more information, or perhaps sign up to participate. | **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1" }** | | :--- | @@ -118,11 +112,9 @@ #### **Defining the activity type** -**Next, we want to describe the type of activity this opportunity is for. As part of the OpenActive standards work there have been some initial efforts to develop a** [**standardised list of activities**](https://www.openactive.io/activity-list/) **for the sector. Where possible consider the terminology already being used, but if these don’t accurately reflect your activity types we’d encourage you to share your list as open data and contribute to the efforts in this area.** - - -**In this case Roller Blading is in the standardised activity list, so we can add it to our model, along with references to the activity list that it has come from. We do this by adding an array of SKOS Concepts, however for our example we only need to define one activity type:** +Next, we want to describe the type of activity this opportunity is for. As part of the OpenActive standards work there have been some initial efforts to develop a [standardised list of activities](https://www.openactive.io/activity-list/) for the sector. Where possible consider the terminology already being used, but if these don’t accurately reflect your activity types we’d encourage you to share your list as open data and contribute to the efforts in this area. +In this case Roller Blading is in the standardised activity list, so we can add it to our model, along with references to the activity list that it has come from. We do this by adding an array of SKOS Concepts, however for our example we only need to define one activity type: | **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], }** | | :--- | @@ -130,184 +122,58 @@ #### **Giving it a time** -**People need to know when the event starts, and so in its most basic form we include a startDate property. The value of this must be a valid \[**[**ISO8601**](https://www.openactive.io/opportunity-data-primer/#bib-ISO8601)**\] date or date time, with a trailing definition of timezone. For example, 2018-08-01T10:51:02Z or 2018-08-01T10:51:02+01:00.** - - -**Whilst this is the only mandatory property, it’s recommended to include information about when the event finishes, and how long the activity part of it takes. Due to this, you may wish to include an EndDate, and a duration.** - - -**The endDate property is the partner to startDate, and is used to signify the end of the event. Furthermore, certain activities may have a start and end point, but the actual duration of activity itself may be less than this total period - for instance a bike ride that meets at 10am and concludes at 3pm, but only includes two hours of cycling with the rest as social time. For activities such as these, we may wish to use the duration property \(defined using an** [**ISO8601**](https://www.openactive.io/opportunity-data-primer/#bib-ISO8601) **duration\) to indicate the length of the activity within the overall period.** +People need to know when the event starts, and so in its most basic form we include a startDate property. The value of this must be a valid \[[ISO8601](https://www.openactive.io/opportunity-data-primer/#bib-ISO8601)\] date or date time, with a trailing definition of timezone. For example, 2018-08-01T10:51:02Z or 2018-08-01T10:51:02+01:00. +Whilst this is the only _mandatory_ property, it’s recommended to include information about when the event finishes, and how long the activity part of it takes. Due to this, you may wish to include an EndDate, and a duration. -**In our example the activity lasts the full hour dictated by the start and end points. For that reason duration is optional, but it has been included here to illustrate usage.** +The endDate property is the partner to startDate, and is used to signify the end of the event. Furthermore, certain activities may have a start and end point, but the actual duration of activity itself may be less than this total period - for instance a bike ride that meets at 10am and concludes at 3pm, but only includes two hours of cycling with the rest as social time. For activities such as these, we may wish to use the duration property \(defined using an [ISO8601](https://www.openactive.io/opportunity-data-primer/#bib-ISO8601) duration\) to indicate the length of the activity within the overall period. +In our example the activity lasts the full hour dictated by the start and end points. For that reason duration is optional, but it has been included here to illustrate usage. -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", }** | +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT1H", }** | | :--- | -**Your event timings may be more complicated than this, and we’ll come onto that in part two of this tutorial.** - +Your event timings may be more complicated than this, and we’ll come onto that in part two of this tutorial. #### **Stating where it happens** -**Finally, people need to know where to go to attend the event. Locations are added to events using the location property, which follows the** [**schema.org standards for address data**](https://schema.org/PostalAddress)**. The minimum requirements for validation are shown below, but the recommendation in the specification is that applications should provide as much information about the Place as possible.** - - -**An example of providing more information is through including geocodes. Whilst this is not mandatory for each event, it’s recommended as people are more likely to use the data if it’s geocoded.** - - - -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } } }** | -| :--- | - - -**An example of providing more information is through including geocodes. Whilst this is not mandatory for each event, it’s recommended as people are more likely to use the data if it’s geocoded.** - - -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }** | -| :--- | - - -**And that’s it! Here we have a valid event described according to the OpenActive opportunity data model.** - - -**You’re able to double-check that you’ve got everything entered correctly by pasting your code into the** [**OpenActive data validator tool**](https://validator.openactive.io/)**.** -**3. How to describe an activity session** - -### **3.1 Add a context** - -**For our starting foundations, all opportunity data should begin with a context contained within an opening and closing bracket \(see below\).** - - -| **{ "@context": "https://openactive.io/ns/oa.jsonld" }** | -| :--- | - - -**A JSON-LD context maps the terms used in a JSON document to their standard definitions. To indicate that your data conforms to the OpenActive opportunity data specification, include a @context reference that matches the above.** - - - -### **3.2 Adding basic session details** - -**Now we can start to add in the information about the session itself. To illustrate this, we’re going to use a rollerblading fitness class.** - - -**The following are the minimum requirements for modelling opportunity data:** - - -* **define that it’s an event \(opportunity\)** -* **its name** -* **a URL providing a link to a web page describing the session** -* **an indication of the type of activity that will take place at an event** -* **the time at which the event will take place** -* **the location at which the event will take place** - -**Whilst this tutorial will help you to understand what’s necessary to get a basic, validating opportunity, there’s a lot more that you can do with the data. Other fields are optional, but might be recommended as they provide useful information for participants. Generally we encourage people to provide as much useful information as possible, while respecting privacy. We’ll talk a bit more about this in the second half of this tutorial, or you can refer to the** [**Required and Optional properties**](https://www.openactive.io/modelling-opportunity-data/#required-and-optional-properties) **part of the specification.** - - -**Let’s walk through and build it up.** - - -#### **Defining the type of resource** - -**Adding to the JSON-LD context that we added in the first step, we now want to start describing the event itself.** - - -**To describe what type of thing we're going to be sharing in our data, we need to add a type property. It’s possible for the data model to describe a number of different types of things, but as we're describing an Event we’ll use that as the value.** - - - - - - - - - -
-

{
"@context": "https://openactive.io/ns/oa.jsonld",
"type": "Event" -

-

} -

-
#### **Give it a name and URL** - -**Add in the name for your individual session, and the public URL where someone could go to find more information, or perhaps sign up to participate.** - - -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1" }** | -| :--- | - - -#### **Defining the activity type** - -**Next, we want to describe the type of activity this opportunity is for. As part of the OpenActive standards work there have been some initial efforts to develop a** [**standardised list of activities**](https://www.openactive.io/activity-list/) **for the sector. Where possible consider the terminology already being used, but if these don’t accurately reflect your activity types we’d encourage you to share your list as open data and contribute to the efforts in this area.** +Finally, people need to know where to go to attend the event. Locations are added to events using the location property, which follows the [schema.org standards for address data](https://schema.org/PostalAddress). The minimum requirements for validation are shown below, but the recommendation in the specification is that applications should provide as much information about the **Place** as possible. - -**In this case Roller Blading is in the standardised activity list, so we can add it to our model, along with references to the activity list that it has come from. We do this by adding an array of SKOS Concepts, however for our example we only need to define one activity type:** - - -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], }** | +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT1H", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } } }** | | :--- | -#### **Giving it a time** - -**People need to know when the event starts, and so in its most basic form we include a startDate property. The value of this must be a valid \[**[**ISO8601**](https://www.openactive.io/opportunity-data-primer/#bib-ISO8601)**\] date or date time, with a trailing definition of timezone. For example, 2018-08-01T10:51:02Z or 2018-08-01T10:51:02+01:00.** - +An example of providing more information is through including geocodes. Whilst this is not mandatory for each event, it’s recommended as people are more likely to use the data if it’s geocoded. -**Whilst this is the only mandatory property, it’s recommended to include information about when the event finishes, and how long the activity part of it takes. Due to this, you may wish to include an EndDate, and a duration.** - - -**The endDate property is the partner to startDate, and is used to signify the end of the event. Furthermore, certain activities may have a start and end point, but the actual duration of activity itself may be less than this total period - for instance a bike ride that meets at 10am and concludes at 3pm, but only includes two hours of cycling with the rest as social time. For activities such as these, we may wish to use the duration property \(defined using an** [**ISO8601**](https://www.openactive.io/opportunity-data-primer/#bib-ISO8601) **duration\) to indicate the length of the activity within the overall period.** - - -**In our example the activity lasts the full hour dictated by the start and end points. For that reason duration is optional, but it has been included here to illustrate usage.** - - -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", }** | +| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT1H", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }** | | :--- | -**Your event timings may be more complicated than this, and we’ll come onto that in part two of this tutorial.** - - -#### **Stating where it happens** - -**Finally, people need to know where to go to attend the event. Locations are added to events using the location property, which follows the** [**schema.org standards for address data**](https://schema.org/PostalAddress)**. The minimum requirements for validation are shown below, but the recommendation in the specification is that applications should provide as much information about the Place as possible.** - - -**An example of providing more information is through including geocodes. Whilst this is not mandatory for each event, it’s recommended as people are more likely to use the data if it’s geocoded.** +**Providing information about the organiser** +And finally, we need to include information about the person or organisation responsible for running the event. With this it’s important to note that personal data must not be published as open data without consent. +Whilst events could be organised by a club, led by a particular individual, or include other named participants of note, we’ll keep it simple for this first example and just use a club. As always, further detail is available in the [spec](https://www.openactive.io/modelling-opportunity-data/#describing-organisers-code-schema-person-code-and-code-schema-organization-code-) if needed. - -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } } }** | +| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT1H", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | | :--- | -**An example of providing more information is through including geocodes. Whilst this is not mandatory for each event, it’s recommended as people are more likely to use the data if it’s geocoded.** - - -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT60M", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }** | -| :--- | - - -**And that’s it! Here we have a valid event described according to the OpenActive opportunity data model.** - - -**You’re able to double-check that you’ve got everything entered correctly by pasting your code into the** [**OpenActive data validator tool**](https://validator.openactive.io/)**.** +And that’s it! Here we have a valid event described according to the OpenActive opportunity data model. +You’re able to double-check that you’ve got everything entered correctly by pasting your code into the [OpenActive data validator tool](https://validator.openactive.io/), or jump to [this pre-populated example](https://validator.openactive.io/?url=https%3A%2F%2Fwww.openactive.io%2Fdata-models%2Fversions%2F2.x%2Fexamples%2Ftutorials%2Fdescribing-events%2Fpart-one-finished.json&version=2.0). ## **4. Where to go next** -**This is all you need to get up and running, but it may be that you’d like a bit more detail. If you’ve taken the time to validate the above, you’ll also see that the validator returns a number of additional recommendations for making the data even better. If you’d like to build the example up even further you can follow along with part two: adding additional timing detail.** +This is all you need to get up and running, but it may be that you’d like a bit more detail. If you’ve taken the time to validate the above, you’ll also see that the validator returns a number of additional recommendations for making the data even better. If you’d like to build the example up even further you can follow along with [part two: adding additional timing detail](tutorial-describing-events-using-the-openactive-data-model-part-two-adding-additional-detail.md). -**Alternatively, if you’d like to jump straight in to creating your own events, the following will probably be useful:** +Alternatively, if you’d like to jump straight in to creating your own events, the following will probably be useful: -* **Data model specification:** [**https://www.openactive.io/modelling-opportunity-data/**](https://www.openactive.io/modelling-opportunity-data/) -* **OpenActive developer area:** [**https://developer.openactive.io/**](https://developer.openactive.io/) -* **A “full fat” Event example, which you may want to use as a starting point and cut down where needed:** [**https://developer.openactive.io/models/event**](https://developer.openactive.io/models/event) +* Data model specification: [https://www.openactive.io/modelling-opportunity-data/](https://www.openactive.io/modelling-opportunity-data/) +* OpenActive developer area: [https://developer.openactive.io/](https://developer.openactive.io/) +* A “full fat” Event example, which you may want to use as a starting point and cut down where needed: [https://developer.openactive.io/models/event](https://developer.openactive.io/models/event) -**Activity list:** [**https://www.openactive.io/activity-list/**](https://www.openactive.io/activity-list/) +Activity list: [https://www.openactive.io/activity-list/](https://www.openactive.io/activity-list/) diff --git a/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-two-adding-additional-detail.md b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-two-adding-additional-detail.md new file mode 100644 index 00000000..45b349bd --- /dev/null +++ b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-two-adding-additional-detail.md @@ -0,0 +1,118 @@ +# Tutorial: describing events using the OpenActive data model - part two: adding additional detail + +In the [first part of this tutorial](tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md) series we looked at putting together a basic example for an event. + +Using our previous example as a starting point we’ll now look at adding additional detail into our model. + +This tutorial will cover: + +* Detailing more complex event times, including recurring activities +* How to add in a description and images +* Revisiting activity types, including multiple activities +* Defining whether an activity is part of a wider programme +* Describing suitability +* Adding in an offer to describe the cost of an activity + +As a reminder, here’s our starting point from the previous tutorial: + +| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT1H", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | +| :--- | + + +## **1. Modelling recurring events** + +Whilst some events may be a one-off, very commonly others recur on a predictable schedule. Where this happens we can model the schedule rather than having to enter each opportunity individually. We do this through the **eventSchedule** property. + +In the below example you’ll see that we’ve removed the previously used **startDate** and **endDate** property, replacing these with an **eventSchedule** block. This details that it’s a \(repeating\) schedule, which starts and ends on specified dates \(leave off the end date if it repeats indefinitely\), and the frequency that repetition of the event should occur. The frequency again uses an ISO8601 duration, and can be \(for example\) daily, weekly, or monthly. + + +We’ve also explicitly stated the **startTime**, **endTime**, and **duration**, and the same logic applies to these as we discussed previously. + +| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | +| :--- | + + +## **2. Adding a description** + +At present, the only information we’ve built up around the content of the session is its name, activity type, and URL. To give our viewers more to go on and encourage them to attend, we may wish to use something more descriptive, in the form of a description. This is possible by using the property description. + +If an event is listed on the web there's probably already a description of some form, and that's the detail that would go in here. We’d suggest things like: + +* how the event will be run +* the types of people who are or will be attending the event +* information on the event organiser +* notes on any equipment required +* suggested apparel, e.g. footwear, kit, etc + +Let’s add in our description. It’s important to note that the order of properties is not important, but you may want to consider logical groupings for human readability. We’ve added it under the name and URL for this reason. + + +| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | +| :--- | + + +## **3. Enhancing with images** + +Another element that can encourage participation is the inclusion of imagery. It’s recommended that you provide images that are representative of your events, and an array allows for the provision of multiple images. + +Let’s add a large image and a smaller thumbnail option under our new description. + +| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", "image": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_large.jpg", "thumbnail": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_thumbnail.jpg" } \] }\], "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | +| :--- | + + +## **4. Defining whether an activity is part of a wider programme** + +As well as having our opportunity repeat, we may have activities that are part of a wider [Programme](https://www.openactive.io/modelling-opportunity-data/#programmes) of events. These Programmes are often associated with specific branding, for instance: "Les Mills BodyPump" or "Back to Netball". + +In our fictional example let’s assume this is the case, and add in an association with a Programme. In its most basic form, we can do this by using the new property programme and adding the required details as follows: + +| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", "image": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_large.jpg", "thumbnail": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_thumbnail.jpg" } \] }\], "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "programme": { "type": "Brand", "name": "BladeFitness™️", "url": "https://www.exampleorgbody.org/blade-fitness/", "description": "A programme of events to encourage participation and get fit through roller blading" }, "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | +| :--- | + + +Here, we’ve added the name of the programme, a link to further detail about it, and a short description. + + +## **5. Describing suitability** + +Next we’ll look at adding in information to describe who your opportunity is suitable for. + +People searching for things to do and ways to be active want to feel confident that opportunities are the right ones for them. Where it’s important, we can encourage participation by highlighting inclusion or restrictions as needed. For example, this could cover whether events are: + +* suitable for a specific age range +* suitable for people within a specific height or weight range +* restricted to a male or female audience, or mixed +* suitable for people with a certain amount of experience +* able to provide support for particular disabilities + +When you come to writing your own suitability criteria it’s recommended that you refer to the [specification](https://www.openactive.io/modelling-opportunity-data/#describing-the-audience-suitability-of-events) to better understand all of the options available, and what is implied by the inclusion or omission or certain properties. + +For our example let’s explicitly state that this is a session for adults, with no gender restriction, at an intermediate level. + +| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", "image": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_large.jpg", "thumbnail": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_thumbnail.jpg" } \] }\], "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "programme": { "type": "Brand", "name": "BladeFitness™️", "url": "https://www.exampleorgbody.org/blade-fitness/", "description": "A programme of events to encourage participation and get fit through roller blading" }, "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" }, "ageRange": { "type": "QuantitativeValue", "minValue": 18 }, "genderRestriction": "https://openactive.io/NoRestriction", "level": \[ "intermediate" \] }** | +| :--- | + + +## **6. Adding offers** + +Some opportunities are freely available for anyone to attend, but where participants need to pay for an event we can use Offers. + +In our final amendment to this example, we’ll add some detail that shows our class has an individual cost of £10 per session. + +| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", "image": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_large.jpg", "thumbnail": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_thumbnail.jpg" } \] }\], "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "programme": { "type": "Brand", "name": "BladeFitness™️", "url": "https://www.exampleorgbody.org/blade-fitness/", "description": "A programme of events to encourage participation and get fit through roller blading" }, "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" }, "ageRange": { "type": "QuantitativeValue", "minValue": 18 }, "genderRestriction": "https://openactive.io/NoRestriction", "level": \[ "intermediate" \], "offers": \[{ "type": "Offer", "name": "Single session", "price": 10, "priceCurrency": "GBP" }\] }** | +| :--- | + + +**As in the previous tutorial we can check that this validates by either copying and pasting the above code into the** [**validation tool**](https://validator.openactive.io)**, or using** [**this pre-populated link**](https://validator.openactive.io/?url=https%3A%2F%2Fwww.openactive.io%2Fdata-models%2Fversions%2F2.x%2Fexamples%2Ftutorials%2Fdescribing-events%2Fpart-two-finished.json&version=2.0)**.** + +## **7. Where to go next** + +At this point you should understand some of the more advanced ways to describe events using the OpenActive data model. To continue on your journey, please refer to the following resources if you’d like more information. + +* Data model specification: [https://www.openactive.io/modelling-opportunity-data/](https://www.openactive.io/modelling-opportunity-data/) +* Primer: [https://www.openactive.io/opportunity-data-primer/](https://www.openactive.io/opportunity-data-primer/) +* Activity list: [https://www.openactive.io/activity-list/](https://www.openactive.io/activity-list/) + + + diff --git a/docs/data-model/types/action.md b/docs/data-model/types/action.md index 6a2d7d3c..69ab11b0 100644 --- a/docs/data-model/types/action.md +++ b/docs/data-model/types/action.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Action" + Text + Must always be present and set to "type": "Action"
name - Text + name + Text -

The name of the action


Example

"name": "Book"

+

The name of the action

+

+
Example +

+

"name": "Book" +

target - EntryPoint + target + EntryPoint -

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}

+

A definition of the target of the action.

+

+
Example +

+

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/babychanging.md b/docs/data-model/types/babychanging.md index afddc50c..96aacca1 100644 --- a/docs/data-model/types/babychanging.md +++ b/docs/data-model/types/babychanging.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "BabyChanging" + Text + Must always be present and set to "type": "BabyChanging"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Baby Changing Facilities"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Baby Changing Facilities" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/brand.md b/docs/data-model/types/brand.md index 80615e68..c4584376 100644 --- a/docs/data-model/types/brand.md +++ b/docs/data-model/types/brand.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), ## **Fields** ### **Required fields** - + @@ -20,38 +20,44 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Brand" + Text + Must always be present and set to "type": "Brand"
name - Text + name + Text -

The name of the brand.


Example

"name": "Play Ball!"

+

The name of the brand.

+

+
Example +

+

"name": "Play Ball!" +

url - url + url + url -

A url where further information can be found for the brand.


Example

"url": "http://example.com/play_ball"

+

A url where further information can be found for the brand.

+

+
Example +

+

"url": "http://example.com/play_ball" +

- +### **Recommended fields** -### **Recommended fields** - @@ -62,29 +68,36 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - + -
description - Text + description + Text -

A text description for the brand.


Example

"description": "Play Ball! is a series of games for people of all abilities."

+

A text description for the brand.

+

+
Example +

+

"description": "Play Ball! is a series of games for people of all abilities." +

logo - ImageObject + logo + ImageObject -

The logo associated with the brand.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

The logo associated with the brand.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

- +### **Optional fields** -### **Optional fields** - @@ -95,15 +108,26 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + -
identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "BR1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "BR1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/changingfacilities.md b/docs/data-model/types/changingfacilities.md index 2b65ac39..c6a201ef 100644 --- a/docs/data-model/types/changingfacilities.md +++ b/docs/data-model/types/changingfacilities.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "ChangingFacilities" + Text + Must always be present and set to "type": "ChangingFacilities"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Changing Rooms"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Changing Rooms" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/concept.md b/docs/data-model/types/concept.md index 367ffb27..8fe8e544 100644 --- a/docs/data-model/types/concept.md +++ b/docs/data-model/types/concept.md @@ -4,12 +4,12 @@ description: This page describes the Concept type. # Concept -This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://www.w3.org/2004/02/skos/core#Concept). +This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http://www.w3.org/2004/02/skos/core#Concept). ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - - + - - + -
type - Text + type - Must always be present and set to "type": "Concept" + Text + Must always be present and set to "type": "Concept"
prefLabel - Text + prefLabel + Text -

A human readable string for use in user interfaces.


Example

"prefLabel": "Speedball"

+

A human readable string for use in user interfaces.

+

+
Example +

+

"prefLabel": "Speedball" +

+### **Recommended fields** - -### **Recommended fields** - @@ -53,29 +54,36 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/concept/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/concept/12345" +

inScheme - url + inScheme + url -

A stable URL reference for the taxonomy.


Example

"inScheme": "https://example.com/reference/activities"

+

A stable URL reference for the taxonomy.

+

+
Example +

+

"inScheme": "https://example.com/reference/activities" +

+### **Optional fields** - -### **Optional fields** - @@ -86,42 +94,60 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - + - - + - - + - - + -
altLabel - Array of Text + altLabel + Array of Text -

An alternative human readable string for use in user interfaces.


Example

"altLabel": "Speedball"

+

An alternative human readable string for use in user interfaces.

+

+
Example +

+

"altLabel": "Speedball" +

broader - Array of url + broader + Array of url -

A broader Concept URI


Example

"broader": "https://example.com/football"

+

A broader Concept URI

+

+
Example +

+

"broader": "https://example.com/football" +

narrower - Array of url + narrower + Array of url -

A more specific concept URI


Example

"narrower": "https://example.com/walking-football"

+

A more specific concept URI

+

+
Example +

+

"narrower": "https://example.com/walking-football" +

notation - Text + notation + Text -

A concept label that is not normally recognisable as natural language.


Example

"notation": "Speedball"

+

A concept label that is not normally recognisable as natural language.

+

+
Example +

+

"notation": "Speedball" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/conceptscheme.md b/docs/data-model/types/conceptscheme.md index d3acfe5e..aa531e69 100644 --- a/docs/data-model/types/conceptscheme.md +++ b/docs/data-model/types/conceptscheme.md @@ -4,12 +4,12 @@ description: This page describes the ConceptScheme type. # ConceptScheme -This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). +This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). ## **Fields** ### **Required fields** - + @@ -20,56 +20,73 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](ht - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ConceptScheme" + Text + Must always be present and set to "type": "ConceptScheme"
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/scheme/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/scheme/12345" +

concept - Array of Concept + concept + Array of Concept -

A collection of concepts that are part of this scheme


Example

"concept": [
  {
    "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"
  }
]

+

A collection of concepts that are part of this scheme

+

+
Example +

+

"concept": [
{
"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"
}
] +

title - Text + title + Text -

The title of the scheme


Example

"title": "Activity List"

+

The title of the scheme

+

+
Example +

+

"title": "Activity List" +

url - url + url + url -

A URL to a web page (or section of a page) that describes the concept scheme.


Example

"url": "https://example.com/scheme/1234"

+

A URL to a web page (or section of a page) that describes the concept + scheme.

+

+
Example +

+

"url": "https://example.com/scheme/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,24 +97,32 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](ht - - + - - + -
description - Text + description + Text -

A free text description of the taxonomy


Example

"description": "An example activity list."

+

A free text description of the taxonomy

+

+
Example +

+

"description": "An example activity list." +

license - url + license + url -

Reference to the license under which the activity list has been published.


Example

"license": "https://example.com/license/MIT"

+

Reference to the license under which the activity list has been published.

+

+
Example +

+

"license": "https://example.com/license/MIT" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/courseinstance.md b/docs/data-model/types/courseinstance.md index 434844f7..11d31e31 100644 --- a/docs/data-model/types/courseinstance.md +++ b/docs/data-model/types/courseinstance.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe ## **Fields** ### **Required fields** - + @@ -20,64 +20,98 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "CourseInstance" + Text + Must always be present and set to "type": "CourseInstance"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. @@ -91,29 +125,40 @@ While these properties are marked as optional, a data publisher must provide eit - startDate - - DateTime
- or -
Date + startDate + + DateTime +
- or - +
Date -

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

- - +### **Recommended fields** -### **Recommended fields** - @@ -124,128 +169,211 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Optional fields** -### **Optional fields** - @@ -256,159 +384,259 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/creche.md b/docs/data-model/types/creche.md index 2ee2db11..1023ec78 100644 --- a/docs/data-model/types/creche.md +++ b/docs/data-model/types/creche.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Creche" + Text + Must always be present and set to "type": "Creche"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Childcare"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Childcare" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/entrypoint.md b/docs/data-model/types/entrypoint.md index 960e3c97..e487be2c 100644 --- a/docs/data-model/types/entrypoint.md +++ b/docs/data-model/types/entrypoint.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent ## **Fields** ### **Required fields** - + @@ -20,42 +20,49 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent - - - + - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "EntryPoint" + Text + Must always be present and set to "type": "EntryPoint"
encodingType - Text + encodingType - Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json" + Text + Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json"
httpMethod - Text + httpMethod + Text -

An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.


Example

"httpMethod": "POST"

+

An HTTP method that specifies the appropriate HTTP method for a request + to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.

+

+
Example +

+

"httpMethod": "POST" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

URL of the item


Example

"urlTemplate": "https://example.com/orders{/var}"

+

URL of the item

+

+
Example +

+

"urlTemplate": "https://example.com/orders{/var}" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/event.md b/docs/data-model/types/event.md index bfc679e5..788ed924 100644 --- a/docs/data-model/types/event.md +++ b/docs/data-model/types/event.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,64 +20,98 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Event" + Text + Must always be present and set to "type": "Event"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. @@ -91,29 +125,40 @@ While these properties are marked as optional, a data publisher must provide eit - startDate - - DateTime
- or -
Date + startDate + + DateTime +
- or - +
Date -

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

- - +### **Recommended fields** -### **Recommended fields** - @@ -124,128 +169,211 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Optional fields** -### **Optional fields** - @@ -256,159 +384,259 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/eventseries.md b/docs/data-model/types/eventseries.md index 7f3bc1b4..c128261b 100644 --- a/docs/data-model/types/eventseries.md +++ b/docs/data-model/types/eventseries.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi ## **Fields** ### **Required fields** - + @@ -20,56 +20,77 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "EventSeries" + Text + Must always be present and set to "type": "EventSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,110 +101,175 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

+### **Optional fields** - -### **Optional fields** - @@ -194,186 +280,317 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/facilityuse.md b/docs/data-model/types/facilityuse.md index c9e80ea3..eccc90b5 100644 --- a/docs/data-model/types/facilityuse.md +++ b/docs/data-model/types/facilityuse.md @@ -4,12 +4,10 @@ description: This page describes the FacilityUse type. # FacilityUse - - ## **Fields** ### **Required fields** - + @@ -20,65 +18,80 @@ description: This page describes the FacilityUse type. - - - + - - + - - + - - + - - - + + - - + -
type - Text + type - Must always be present and set to "type": "FacilityUse" + Text + Must always be present and set to "type": "FacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + a facility use.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the facility use will take place.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the facility use


Example

"name": "Speedball"

+

The name of the facility use

+

+
Example +

+

"name": "Speedball" +

provider - - -

The organisation responsible for providing the facility

+ 		provider The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"

+

A URL to a web page (or section of a page) that describes the facility + use.

+

+
Example +

+

"url": "https://example.com/facility-use/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -89,65 +102,86 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/facility-use/112345" +

description - Text + description + Text -

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the facility use

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

event - Array of Slot + event + Array of Slot -

An array of slots of availability of this FacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 3,
    "maximumUses": 6
  }
]

+

An array of slots of availability of this FacilityUse.

+

+
Example +

+

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 3,
"maximumUses": 6
}
] +

hoursAvailable - Array of OpeningHoursSpecification + hoursAvailable -

The times the facility use is available

+ 		Array of OpeningHoursSpecification The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the facility use, e.g. a photo taken at + a previous event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

- +### **Optional fields** -### **Optional fields** - @@ -158,78 +192,136 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."

+

Provides additional notes and instructions for users of a facility. E.g. + more information on how to find it, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]

+

Provides a set of tags that help categorise and describe a facility.

+

+
Example +

+

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

individualFacilityUse - Array of IndividualFacilityUse + individualFacilityUse + Array of IndividualFacilityUse -

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court).


Example

"individualFacilityUse": [
  {
    "type": "IndividualFacilityUse",
    "id": "http://www.example.org/facility-uses/1",
    "name": "Tennis Court 1"
  }
]

+

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse + (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse + (e.g. an opportunity to play tennis on a specific court).

+

+
Example +

+

"individualFacilityUse": [
{
"type": "IndividualFacilityUse",
"id": "http://www.example.org/facility-uses/1",
"name": "Tennis Court 1"
}
] +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

- - + \ No newline at end of file diff --git a/docs/data-model/types/geocoordinates.md b/docs/data-model/types/geocoordinates.md index 8d98bd79..279b2904 100644 --- a/docs/data-model/types/geocoordinates.md +++ b/docs/data-model/types/geocoordinates.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "GeoCoordinates" + Text + Must always be present and set to "type": "GeoCoordinates"
latitude - Float + latitude + Float -

The latitude of a location. For example 51.522338 (WGS 84).


Example

"latitude": 51.522338

+

The latitude of a location. For example 51.522338 (WGS 84).

+

+
Example +

+

"latitude": 51.522338 +

longitude - Float + longitude + Float -

The longitude of a location. For example -0.083437 (WGS 84).


Example

"longitude": -0.083437

+

The longitude of a location. For example -0.083437 (WGS 84).

+

+
Example +

+

"longitude": -0.083437 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/headlineevent.md b/docs/data-model/types/headlineevent.md index 0e5406ab..2d4cf784 100644 --- a/docs/data-model/types/headlineevent.md +++ b/docs/data-model/types/headlineevent.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,74 +20,116 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "HeadlineEvent" + Text + Must always be present and set to "type": "HeadlineEvent"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -98,119 +140,194 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

+### **Optional fields** - -### **Optional fields** - @@ -221,150 +338,244 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/imageobject.md b/docs/data-model/types/imageobject.md index cdbb0626..3d0cafa7 100644 --- a/docs/data-model/types/imageobject.md +++ b/docs/data-model/types/imageobject.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im ## **Fields** ### **Required fields** - + @@ -20,48 +20,31 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im - - - - - - - - - - -
type - Text + type - Must always be present and set to "type": "ImageObject" + Text
url - url + Must always be present and set to "type": "ImageObject" -

The URL for the display resolution image.


Example

"url": "http://example.com/static/image/speedball_large.jpg"

-
- - -### **Optional fields** - - - - - - - - - - - + -
PropertyExpected TypeDescription
thumbnail - Array of ImageObject + url + url -

The URL for a thumbnail image for an image.

+

The URL for the display resolution image.

+

+
Example +

+

"url": "http://example.com/static/image/speedball_large.jpg" +

+### **Optional fields** +| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **thumbnail** | Array of [`ImageObject`](https://docs.openactive.io/data-model/types/imageobject) | The URL for a thumbnail image for an image. | diff --git a/docs/data-model/types/individualfacilityuse.md b/docs/data-model/types/individualfacilityuse.md index 796fea75..ba69fdef 100644 --- a/docs/data-model/types/individualfacilityuse.md +++ b/docs/data-model/types/individualfacilityuse.md @@ -4,12 +4,10 @@ description: This page describes the IndividualFacilityUse type. # IndividualFacilityUse - - ## **Fields** ### **Required fields** - + @@ -20,65 +18,80 @@ description: This page describes the IndividualFacilityUse type. - - - + - - + - - + - - + - - - + + - - + -
type - Text + type - Must always be present and set to "type": "IndividualFacilityUse" + Text + Must always be present and set to "type": "IndividualFacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + a facility use.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the facility use will take place.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the facility use


Example

"name": "Speedball"

+

The name of the facility use

+

+
Example +

+

"name": "Speedball" +

provider - - -

The organisation responsible for providing the facility

+ 		provider The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"

+

A URL to a web page (or section of a page) that describes the facility + use.

+

+
Example +

+

"url": "https://example.com/facility-use/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -89,65 +102,81 @@ description: This page describes the IndividualFacilityUse type. - - + - - - + - - + - - + - - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/facility-use/112345" +

aggregateFacilityUse - FacilityUse + aggregateFacilityUse -

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location).

+ 		FacilityUse Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse + (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse + (e.g. an opportunity to play tennis at a specific location).
description - Text + description + Text -

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the facility use

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

event - Array of Slot + event + Array of Slot -

An array of slots of availability of this IndividualFacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 0,
    "maximumUses": 1
  }
]

+

An array of slots of availability of this IndividualFacilityUse.

+

+
Example +

+

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 0,
"maximumUses": 1
}
] +

hoursAvailable - Array of OpeningHoursSpecification + hoursAvailable -

The times the facility use is available

+ 		Array of OpeningHoursSpecification The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the facility use, e.g. a photo taken at + a previous event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

- +### **Optional fields** -### **Optional fields** - @@ -158,78 +187,134 @@ description: This page describes the IndividualFacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."

+

Provides additional notes and instructions for users of a facility. E.g. + more information on how to find it, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]

+

Provides a set of tags that help categorise and describe a facility.

+

+
Example +

+

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

- - + \ No newline at end of file diff --git a/docs/data-model/types/locationfeaturespecification.md b/docs/data-model/types/locationfeaturespecification.md index 6962df6d..1b719113 100644 --- a/docs/data-model/types/locationfeaturespecification.md +++ b/docs/data-model/types/locationfeaturespecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "LocationFeatureSpecification" + Text + Must always be present and set to "type": "LocationFeatureSpecification"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Bike Shed"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Bike Shed" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/lockers.md b/docs/data-model/types/lockers.md index ad1972ce..6db45ee7 100644 --- a/docs/data-model/types/lockers.md +++ b/docs/data-model/types/lockers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Lockers" + Text + Must always be present and set to "type": "Lockers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Indoor Lockers"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Indoor Lockers" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/offer.md b/docs/data-model/types/offer.md index 3c608cdc..54853835 100644 --- a/docs/data-model/types/offer.md +++ b/docs/data-model/types/offer.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), ## **Fields** ### **Required fields** - + @@ -20,29 +20,33 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - - + - - + -
type - Text + type - Must always be present and set to "type": "Offer" + Text + Must always be present and set to "type": "Offer"
price - Float + price + Float -

The offer price of the activity.

This price should be specified without currency symbols and as a floating point number with two decimal places.

The currency of the price should be expressed in the priceCurrency field.


Example

"price": 33

+

The offer price of the activity.

+

This price should be specified without currency symbols and as a floating + point number with two decimal places.

+

The currency of the price should be expressed in the priceCurrency field.

+

+
Example +

+

"price": 33 +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,56 +57,82 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/offer/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/offer/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

name - Text + name + Text -

A human readable name for the offer.


Example

"name": "Speedball winger position"

+

A human readable name for the offer.

+

+
Example +

+

"name": "Speedball winger position" +

priceCurrency - Text + priceCurrency + Text -

The currency (in 3-letter ISO 4217 format) of the price.

If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified.


Example

"priceCurrency": "GBP"

+

The currency (in 3-letter ISO 4217 format) of the price.

+

If an Offer has a zero price, then this property is not required. Otherwise + the currency must be specified.

+

+
Example +

+

"priceCurrency": "GBP" +

url - url + url + url -

URL describing the offer


Example

"url": "http://www.rphs.org.uk/"

+

URL describing the offer

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- +### **Optional fields** -### **Optional fields** - @@ -113,33 +143,56 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + + - - + -
advanceBooking - RequiredStatusType + advanceBooking + RequiredStatusType -

Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either.


Example

"advanceBooking": "https://openactive.io/Required"

+

Indicates whether to accept this offer, a participant must book in advance, + whether they must pay on attending, or have option to do either.

+

+
Example +

+

"advanceBooking": "https://openactive.io/Required" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

prepayment - RequiredStatusType + prepayment + RequiredStatusType -

Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either.


Example

"prepayment": "https://openactive.io/Required"

+

Indicates whether to accept this offer, a participant must pay in advance, + pay when attending, or have the option to do either.

+

+
Example +

+

"prepayment": "https://openactive.io/Required" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/openinghoursspecification.md b/docs/data-model/types/openinghoursspecification.md index 1340d446..bf25b3da 100644 --- a/docs/data-model/types/openinghoursspecification.md +++ b/docs/data-model/types/openinghoursspecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ ## **Fields** ### **Required fields** - + @@ -20,42 +20,54 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ - - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "OpeningHoursSpecification" + Text + Must always be present and set to "type": "OpeningHoursSpecification"
closes - Time + closes + Time -

The closing time.


Example

"closes": "17:00"

+

The closing time.

+

+
Example +

+

"closes": "17:00" +

dayOfWeek - DayOfWeek + dayOfWeek + DayOfWeek -

Defines the day of the week upon which the Place is open


Example

"dayOfWeek": "https://schema.org/Monday"

+

Defines the day of the week upon which the Place is open

+

+
Example +

+

"dayOfWeek": "https://schema.org/Monday" +

opens - Time + opens + Time -

The opening time.


Example

"opens": "09:00"

+

The opening time.

+

+
Example +

+

"opens": "09:00" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/organization.md b/docs/data-model/types/organization.md index 2c7ef789..52c565df 100644 --- a/docs/data-model/types/organization.md +++ b/docs/data-model/types/organization.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - - + - - + -
type - Text + type - Must always be present and set to "type": "Organization" + Text + Must always be present and set to "type": "Organization"
name - Text + name + Text -

The name of the Organization


Example

"name": "Central Speedball Association"

+

The name of the Organization

+

+
Example +

+

"name": "Central Speedball Association" +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,47 +54,65 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/organization/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/organization/12345" +

sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated with the organization.


Example

"sameAs": [
  "https://www.facebook.com/everyoneactive/",
  "https://twitter.com/everyoneactive"
]

+

Lists the URL(s) of the official social media profile pages associated + with the organization.

+

+
Example +

+

"sameAs": [
"https://www.facebook.com/everyoneactive/",
"https://twitter.com/everyoneactive"
] +

telephone - Text + telephone + Text -

The telephone number of the Organization


Example

"telephone": "01234 567890"

+

The telephone number of the Organization

+

+
Example +

+

"telephone": "01234 567890" +

url - url + url + url -

A definitive canonical URL for the Organization.


Example

"url": "http://www.speedball-world.com"

+

A definitive canonical URL for the Organization.

+

+
Example +

+

"url": "http://www.speedball-world.com" +

- +### **Optional fields** -### **Optional fields** - @@ -104,33 +123,54 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + + - - + -
description - Text + description + Text -

The description of the Organization


Example

"description": "The national governing body of cycling"

+

The description of the Organization

+

+
Example +

+

"description": "The national governing body of cycling" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

logo - ImageObject + logo + ImageObject -

A logo for the Organization.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

A logo for the Organization.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/parking.md b/docs/data-model/types/parking.md index 1d5b05bd..d18ce763 100644 --- a/docs/data-model/types/parking.md +++ b/docs/data-model/types/parking.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Parking" + Text + Must always be present and set to "type": "Parking"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Roadside Parking"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Roadside Parking" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/partialschedule.md b/docs/data-model/types/partialschedule.md index 852a2ca8..b8cc1d8c 100644 --- a/docs/data-model/types/partialschedule.md +++ b/docs/data-model/types/partialschedule.md @@ -9,31 +9,13 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "PartialSchedule" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "PartialSchedule"` | ### **Recommended fields** - + @@ -44,38 +26,51 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + -
endTime - Time + endTime + Time -

The end time of the event.


Example

"endTime": "12:00:00"

+

The end time of the event.

+

+
Example +

+

"endTime": "12:00:00" +

repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

startTime - Time + startTime + Time -

The start time of the event.


Example

"startTime": "12:00:00"

+

The start time of the event.

+

+
Example +

+

"startTime": "12:00:00" +

- +### **Optional fields** -### **Optional fields** - @@ -86,105 +81,172 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek
- or -
Array of Text + 		byDay + Array of DayOfWeek +
- or - +
Array of Text 		-

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - Date + endDate + Date -

The end date of the schedule.


Example

"endDate": "2018-01-27"

+

The end date of the schedule.

+

+
Example +

+

"endDate": "2018-01-27" +

exceptDate - Array of Date
- or -
Array of DateTime + 		exceptDate + Array of Date +
- or - +
Array of DateTime 		-

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]

+

Exception dates where the schedule should not generate an event.

+

+
Example +

+

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] +

idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + identifier (@id) for every event described by the schedule (see below for + more information). This property is required if the data provider is supporting + third-party booking via the Open Booking API.

+

+
Example +

+

"idTemplate": "https://example.com/event{/id}" +

repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3

+

Defines the number of times a recurring Event will take place.

+

+
Example +

+

"repeatCount": 3 +

scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.


Example

"scheduledEventType": "Event"

+

The type of event this schedule related to.

+

+
Example +

+

"scheduledEventType": "Event" +

startDate - Date + startDate + Date -

The start date of the event.


Example

"startDate": "2018-01-27"

+

The start date of the event.

+

+
Example +

+

"startDate": "2018-01-27" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + URL (schema:url) for every event described by the schedule (see below for + more information). This property is required if the data provider wants + to provide participants with a unique URL to book to attend an event.

+

+
Example +

+

"urlTemplate": "https://example.com/event{/id}" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/person.md b/docs/data-model/types/person.md index 9c59018e..032f9e42 100644 --- a/docs/data-model/types/person.md +++ b/docs/data-model/types/person.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "Person" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "Person"` | ### **Recommended fields** - + @@ -44,20 +26,22 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/person/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/person/12345" +

+### **Optional fields** - -### **Optional fields** - @@ -68,69 +52,113 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + - - - + + - - + - - + - - + - - + - - + -
description - Text + description + Text -

The description of the Person


Example

"description": "The leader of the coaching team"

+

The description of the Person

+

+
Example +

+

"description": "The leader of the coaching team" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

logo - ImageObject + logo + ImageObject -

A logo for the person.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

A logo for the person.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

name - Text + name + Text -

A full name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"name": "Daley Thompson"

+

A full name for the person.

+

This person must give direct permission for their personal information + to be shared as part of the Open Data.

+

+
Example +

+

"name": "Daley Thompson" +

sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated with the person.


Example

"sameAs": "https://example.org/example-org"

+

Lists the URL(s) of the official social media profile pages associated + with the person.

+

+
Example +

+

"sameAs": "https://example.org/example-org" +

telephone - Text + telephone + Text -

The telephone number of the person


Example

"telephone": "01234 567890"

+

The telephone number of the person

+

+
Example +

+

"telephone": "01234 567890" +

url - url + url + url -

A URL where more information about the person may be found


Example

"url": "http://www.example.com/"

+

A URL where more information about the person may be found

+

+
Example +

+

"url": "http://www.example.com/" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/place.md b/docs/data-model/types/place.md index 65e2a20c..ce250875 100644 --- a/docs/data-model/types/place.md +++ b/docs/data-model/types/place.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - - + - - + -
type - Text + type - Must always be present and set to "type": "Place" + Text + Must always be present and set to "type": "Place"
name - Text + name + Text -

The name of the Place


Example

"name": "Raynes Park High School"

+

The name of the Place

+

+
Example +

+

"name": "Raynes Park High School" +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,92 +54,134 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - + - - + - - + - - + - - + - - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/place/12345" +

address - PostalAddress
- or -
Text + 		address + PostalAddress +
- or - +
Text 		-

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]

+

An array listing the Ammenities of the Place.

+

+
Example +

+

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] +

description - Text + description + Text -

The description of the Place


Example

"description": "Raynes Park High School in London"

+

The description of the Place

+

+
Example +

+

"description": "Raynes Park High School in London" +

geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the place, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

openingHoursSpecification - Array of OpeningHoursSpecification + openingHoursSpecification -

The times the Place is open

+ 		Array of OpeningHoursSpecification The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place


Example

"telephone": "01253 473934"

+

The telephone number for the Place

+

+
Example +

+

"telephone": "01253 473934" +

url - url + url + url -

The website for the Place


Example

"url": "http://www.rphs.org.uk/"

+

The website for the Place

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- +### **Optional fields** -### **Optional fields** - @@ -149,33 +192,54 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - + - - + -
containedInPlace - Place + containedInPlace + Place -

The place within which this Place exists


Example

"containedInPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
  "name": "Middlesbrough Sports Village"
}

+

The place within which this Place exists

+

+
Example +

+

"containedInPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
"name": "Middlesbrough Sports Village"
} +

containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}

+

Places that exist within this place

+

+
Example +

+

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/postaladdress.md b/docs/data-model/types/postaladdress.md index 5b57322a..29028dc7 100644 --- a/docs/data-model/types/postaladdress.md +++ b/docs/data-model/types/postaladdress.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,60 +20,82 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "PostalAddress" + Text + Must always be present and set to "type": "PostalAddress"
addressCountry - Text + addressCountry + Text -

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.


Example

"addressCountry": "GB"

+

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.

+

+
Example +

+

"addressCountry": "GB" +

addressLocality - Text + addressLocality + Text -

The locality, a suburb within a city or a town within a county or district.


Example

"addressLocality": "Shoreditch"

+

The locality, a suburb within a city or a town within a county or district.

+

+
Example +

+

"addressLocality": "Shoreditch" +

addressRegion - Text + addressRegion + Text -

The region, either a city or a county or district.


Example

"addressRegion": "London"

+

The region, either a city or a county or district.

+

+
Example +

+

"addressRegion": "London" +

postalCode - Text + postalCode + Text -

The postal code.


Example

"postalCode": "EC2A 4JE"

+

The postal code.

+

+
Example +

+

"postalCode": "EC2A 4JE" +

streetAddress - Text + streetAddress + Text -

The street address.


Example

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St"

+

The street address.

+

+
Example +

+

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/propertyvalue.md b/docs/data-model/types/propertyvalue.md index 6719f4bb..24b8f082 100644 --- a/docs/data-model/types/propertyvalue.md +++ b/docs/data-model/types/propertyvalue.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,38 +20,46 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "PropertyValue" + Text + Must always be present and set to "type": "PropertyValue"
name - Text + name + Text -

The name of this PropertyValue


Example

"name": "Vendor ID"

+

The name of this PropertyValue

+

+
Example +

+

"name": "Vendor ID" +

value - Text
- or -
Integer + 		value + Text +
- or - +
Integer 		-

The actual value of this identifier


Example

"value": "SB1234"

+

The actual value of this identifier

+

+
Example +

+

"value": "SB1234" +

- +### **Optional fields** -### **Optional fields** - @@ -62,15 +70,20 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + -
propertyID - url
- or -
Text + 		propertyID + url +
- or - +
Text 		-

A commonly used identifier for the characteristic represented by the property


Example

"propertyID": "ActivePlaces"

+

A commonly used identifier for the characteristic represented by the property

+

+
Example +

+

"propertyID": "ActivePlaces" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/quantitativevalue.md b/docs/data-model/types/quantitativevalue.md index 28f57819..86fd4b4b 100644 --- a/docs/data-model/types/quantitativevalue.md +++ b/docs/data-model/types/quantitativevalue.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "QuantitativeValue" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "QuantitativeValue"` | ### **Optional fields** - + @@ -44,24 +26,32 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. - - + - - + -
maxValue - Integer + maxValue + Integer -

The maximum value.


Example

"maxValue": 60

+

The maximum value.

+

+
Example +

+

"maxValue": 60 +

minValue - Integer + minValue + Integer -

The minimum value.


Example

"minValue": 16

+

The minimum value.

+

+
Example +

+

"minValue": 16 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/reserveaction.md b/docs/data-model/types/reserveaction.md index ad053fdd..24dbfc4d 100644 --- a/docs/data-model/types/reserveaction.md +++ b/docs/data-model/types/reserveaction.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ReserveAction" + Text + Must always be present and set to "type": "ReserveAction"
name - Text + name + Text -

The name of the action


Example

"name": "Book"

+

The name of the action

+

+
Example +

+

"name": "Book" +

target - EntryPoint + target + EntryPoint -

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}

+

A definition of the target of the action.

+

+
Example +

+

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/schedule.md b/docs/data-model/types/schedule.md index 9d38742f..8cbe81de 100644 --- a/docs/data-model/types/schedule.md +++ b/docs/data-model/types/schedule.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - + @@ -20,55 +20,72 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Schedule" + Text + Must always be present and set to "type": "Schedule"
endTime - Time + endTime + Time -

The end time of the event.


Example

"endTime": "12:00:00"

+

The end time of the event.

+

+
Example +

+

"endTime": "12:00:00" +

repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.


Example

"scheduledEventType": "Event"

+

The type of event this schedule related to.

+

+
Example +

+

"scheduledEventType": "Event" +

startTime - Time + startTime + Time -

The start time of the event.


Example

"startTime": "12:00:00"

+

The start time of the event.

+

+
Example +

+

"startTime": "12:00:00" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional, a data publisher must provide either a schema:byDay, schema:byMonth or byMonthDay for a schedule. @@ -82,38 +99,56 @@ While these properties are marked as optional, a data publisher must provide eit - byDay - - Array of DayOfWeek
- or -
Array of Text + byDay + + Array of DayOfWeek +
- or - +
Array of Text -

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

- byMonth - - Array of Integer + byMonth + + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

- byMonthDay - - Array of Integer + byMonthDay + + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

- +### **Recommended fields** - -### **Recommended fields** - @@ -124,56 +159,84 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - Date + endDate + Date -

The end date of the schedule.


Example

"endDate": "2018-01-27"

+

The end date of the schedule.

+

+
Example +

+

"endDate": "2018-01-27" +

idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + identifier (@id) for every event described by the schedule (see below for + more information). This property is required if the data provider is supporting + third-party booking via the Open Booking API.

+

+
Example +

+

"idTemplate": "https://example.com/event{/id}" +

startDate - Date + startDate + Date -

The start date of the event.


Example

"startDate": "2018-01-27"

+

The start date of the event.

+

+
Example +

+

"startDate": "2018-01-27" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + URL (schema:url) for every event described by the schedule (see below for + more information). This property is required if the data provider wants + to provide participants with a unique URL to book to attend an event.

+

+
Example +

+

"urlTemplate": "https://example.com/event{/id}" +

+### **Optional fields** - -### **Optional fields** - @@ -184,51 +247,82 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek
- or -
Array of Text + 		byDay + Array of DayOfWeek +
- or - +
Array of Text 		-

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

exceptDate - Array of Date
- or -
Array of DateTime + 		exceptDate + Array of Date +
- or - +
Array of DateTime 		-

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]

+

Exception dates where the schedule should not generate an event.

+

+
Example +

+

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] +

repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3

+

Defines the number of times a recurring Event will take place.

+

+
Example +

+

"repeatCount": 3 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/scheduledsession.md b/docs/data-model/types/scheduledsession.md index 5ae4a10b..c6faa751 100644 --- a/docs/data-model/types/scheduledsession.md +++ b/docs/data-model/types/scheduledsession.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,56 +20,84 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ScheduledSession" + Text + Must always be present and set to "type": "ScheduledSession"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,83 +108,129 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Optional fields** -### **Optional fields** - @@ -167,195 +241,332 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/sessionseries.md b/docs/data-model/types/sessionseries.md index 4c4e26c0..2dc0c28a 100644 --- a/docs/data-model/types/sessionseries.md +++ b/docs/data-model/types/sessionseries.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,65 +20,99 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "SessionSeries" + Text + Must always be present and set to "type": "SessionSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": [
  {
    "name": "Central Speedball Association",
    "type": "Organization",
    "url": "http://www.speedball-world.com"
  }
]

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -89,83 +123,132 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

- +### **Optional fields** -### **Optional fields** - @@ -176,195 +259,324 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

subEvent - Array of ScheduledSession + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of ScheduledSession Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/showers.md b/docs/data-model/types/showers.md index 33f60e9c..2f7579e1 100644 --- a/docs/data-model/types/showers.md +++ b/docs/data-model/types/showers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Showers" + Text + Must always be present and set to "type": "Showers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Poolside Showers"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Poolside Showers" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/slot.md b/docs/data-model/types/slot.md index 34880694..361b211b 100644 --- a/docs/data-model/types/slot.md +++ b/docs/data-model/types/slot.md @@ -4,12 +4,10 @@ description: This page describes the Slot type. # Slot - - ## **Fields** ### **Required fields** - + @@ -20,55 +18,75 @@ description: This page describes the Slot type. - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Slot" + Text + Must always be present and set to "type": "Slot"
duration - Duration + duration + Duration -

The duration of the slot given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the slot given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

facilityUse - url + facilityUse + url -

URI to the FacilityUse that has this offer


Example

"facilityUse": "https://example.com/facility-use/1"

+

URI to the FacilityUse that has this offer

+

+
Example +

+

"facilityUse": "https://example.com/facility-use/1" +

remainingUses - Integer + remainingUses + Integer -

The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"remainingUses": 5

+

The remaining available courts or pitches at this time. Must be 0 or 1 + for an IndividualFacilityUse.

+

+
Example +

+

"remainingUses": 5 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the slot. Can be specified as a schema:Date or schema:DateTime


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the slot. Can be specified as a schema:Date + or schema:DateTime

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional/recommended in the Modelling Specification, one of these must be provided when surfacing a slot through an RPDE feed to ensure that the slots can be processed correctly by data consumers. @@ -82,29 +100,44 @@ While these properties are marked as optional/recommended in the Modelling Speci - id - - url + id + + url -

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/slot/12345" +

- identifier - - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + identifier + + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer -

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- +### **Recommended fields** - -### **Recommended fields** - @@ -115,29 +148,37 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/slot/12345" +

maximumUses - Integer + maximumUses + Integer -

The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"maximumUses": 16

+

The maximum available courts or pitches at this time. Must be 0 or 1 for + an IndividualFacilityUse.

+

+
Example +

+

"maximumUses": 16 +

- +### **Optional fields** -### **Optional fields** - @@ -148,33 +189,59 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + - - + -
endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the slot. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an slot.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the slot. Can be specified as a schema:Date or + schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an slot.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/sportsactivitylocation.md b/docs/data-model/types/sportsactivitylocation.md index d969ce78..44c23b8e 100644 --- a/docs/data-model/types/sportsactivitylocation.md +++ b/docs/data-model/types/sportsactivitylocation.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "SportsActivityLocation" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "SportsActivityLocation"` | ### **Recommended fields** - + @@ -44,20 +26,22 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/place/12345" +

- +### **Optional fields** -### **Optional fields** - @@ -68,114 +52,184 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - + - - + -
address - PostalAddress
- or -
Text + 		address + PostalAddress +
- or - +
Text 		-

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]

+

An array listing the Ammenities of the Place.

+

+
Example +

+

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] +

containedInPlace - Place
- or -
url + 		containedInPlace + Place +
- or - +
url 		-

While a url is not specified as an option in the Modelling Specification, it is necessary to link entities in RPDE.


Example

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d"

+

While a url is not specified as an option in the Modelling + Specification, it is necessary to link entities in RPDE.

+

+
Example +

+

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d" +

containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}

+

Places that exist within this place

+

+
Example +

+

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} +

description - Text + description + Text -

The description of the Place


Example

"description": "Raynes Park High School in London"

+

The description of the Place

+

+
Example +

+

"description": "Raynes Park High School in London" +

geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the place, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

name - Text + name + Text -

The name of the Place


Example

"name": "Raynes Park High School"

+

The name of the Place

+

+
Example +

+

"name": "Raynes Park High School" +

openingHoursSpecification - Array of OpeningHoursSpecification + openingHoursSpecification -

The times the Place is open

+ 		Array of OpeningHoursSpecification The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place


Example

"telephone": "01253 473934"

+

The telephone number for the Place

+

+
Example +

+

"telephone": "01253 473934" +

url - url + url + url -

The website for the Place


Example

"url": "http://www.rphs.org.uk/"

+

The website for the Place

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/toilets.md b/docs/data-model/types/toilets.md index f5248106..f8e164c9 100644 --- a/docs/data-model/types/toilets.md +++ b/docs/data-model/types/toilets.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Toilets" + Text + Must always be present and set to "type": "Toilets"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Public Toilets"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Public Toilets" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/towels.md b/docs/data-model/types/towels.md index 063eb9c0..14fb351e 100644 --- a/docs/data-model/types/towels.md +++ b/docs/data-model/types/towels.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Towels" + Text + Must always be present and set to "type": "Towels"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Complementary Towels"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Complementary Towels" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/using-data/harvesting-opportunity-data.md b/docs/using-data/harvesting-opportunity-data.md index 21fb0adf..64654e32 100644 --- a/docs/using-data/harvesting-opportunity-data.md +++ b/docs/using-data/harvesting-opportunity-data.md @@ -1,6 +1,6 @@ # Harvesting opportunity data -## **Introduction** {#introduction} +## **Introduction** To follow along you’ll need some existing knowledge of programming, including familiarity with HTTP, JSON, and APIs. @@ -15,13 +15,13 @@ By the end of this tutorial you’ll have: Whilst you’ll be able to follow along with this tutorial as your sole guide, you may wish to refer to the OpenActive [Realtime Paged Data Exchange](https://www.openactive.io/realtime-paged-data-exchange/) specification for greater detail at points. -## **Before we begin** {#before-we-begin} +## **Before we begin** Before we dive into implementation, let’s start with a bit of background. [OpenActive](https://www.openactive.io/) intends to facilitate the sharing and use of physical activity opportunity data. To date, a number of datasets have been made available for use. You can find out more about them in our upcoming guide ‘How to find physical activity opportunity data using the OpenActive Opportunity Data Dashboard’, or through the [status dashboard](https://status.openactive.io/) itself. This is a tutorial which aims to cover how to harvest the data from these feeds. For simplicity, we’re going to focus on harvesting data from a single source, however at the end of this tutorial we’ll include some prompters for how to approach combining data from multiple sources. -## **Data transport** {#data-transport} +## **Data transport** First of all, it’s important to understand the general approach to how the data is transported. @@ -39,11 +39,11 @@ The RPDE specification recommends use of standard HTTP status codes. So your cod To harvest all of the data from a feed your code will need to make repeated HTTP requests until it has fetched all the data. There’s no need for any authentication as all of the endpoints are freely available.Now that we understand the mechanic for transferring data, let’s move on to understanding the content of what’s returned from a request, and how we navigate through all of the content. -## **Understanding paging** {#understanding-paging} +## **Understanding paging** Before we grab the data there are a few key concepts that are important to understand. -### **Data is returned as pages** {#data-is-returned-as-pages} +### **Data is returned as pages** Looking at the [URL we previously visited](https://opensessions.io/api/Session/GetSessionsForOpenActive), you’ll notice that the data isn’t extensive - there are only 10 items in the items array. @@ -57,7 +57,7 @@ From the link we opened \(and the image above\), you’ll notice the property ne Follow the links a couple of times to get a feel for this, but there’s no need to go to the end \(we’ll come on to that shortly\). -### **How items appear in the overall list \(and pages\)** {#how-items-appear-in-the-overall-list-and-pages} +### **How items appear in the overall list \(and pages\)** If you’ve looked into some of the items that have been returned, you may notice that some opportunities are in the past. The next important point to understand here is that the specification requires strict chronological ordering of items, with newly added and modified data added to the end of the feed. There are some simple rules that govern items in the overall list: @@ -72,11 +72,11 @@ A conceptual view of a first page of items, followed by the rest of the list. No Let’s move on to putting this into practice, to understand it in context. -## **Doing our initial download** {#doing-our-initial-download} +## **Doing our initial download** When consuming the data for the first time, pages are initially downloaded sequentially to catch up with the current state of the data publisher. As we’ve seen, this is achieved by following the next property of each page until the last page is reached. -### **The last page** {#the-last-page} +### **The last page** According to the spec definition, the last page of data must have both of the following properties: @@ -128,7 +128,7 @@ In pseudocode, a very basic \(and unrobust\) page through the dataset for the fi At this point, what you have is an as-is store of all of the items in the dataset, from as far back as they are available. Whilst this tutorial has not covered any processing of the data, so you will need to be mindful of getting it into a sensible state for your needs. -## **Deleted items** {#deleted-items} +## **Deleted items** Whilst we’ve captured all of the items, what we also haven’t done is given any consideration to their state. @@ -184,9 +184,9 @@ For our initial download of data, for now \(we’ll revisit this in the next sec Our initial import of data should therefore now reflect only the current, active records. However, as we’ve seen, records can be amended and deleted. -## **Keeping data up to date** {#keeping-data-up-to-date} +## **Keeping data up to date** -### **Handling updates and deletions** {#handling-updates-and-deletions} +### **Handling updates and deletions** Even with a small initial import, we run the risk of an item that we harvest early on actually being updated or deleted in the publisher’s system at the same time. As we’ve seen, this will lead to that item moving through the queue and being added to the end, so it could show up one to many times before our overall harvest is finished. @@ -247,7 +247,7 @@ Our pseudocode therefore becomes a little bit more detailed: -### **Polling for near real-time updates** {#polling-for-near-real-time-updates} +### **Polling for near real-time updates** Whilst we’ve reached the end of the feed, handled modifications and deletions, the changes don’t stop there. In order to keep your data updated in near real-time, you may wish to keep track of the URL for the last page, and infrequently poll this to check for updates. Revisiting the rules of what defines a page as the last page: @@ -336,7 +336,7 @@ If items are found, your harvester should resume the behaviour of the initial do -## **Extending this example: harvesting from multiple sources** {#extending-this-example-harvesting-from-multiple-sources} +## **Extending this example: harvesting from multiple sources** As mentioned at the start of this tutorial, once you’ve mastered harvesting from a single source you may well wish to extend this by harvesting multiple sources. @@ -346,7 +346,7 @@ Whilst this is beyond the scope of this tutorial, we’ve included some pointers * Whether or not you wish to re-harvest the full set of data every time. * Whether or not you plan to harvest datasets sequentially, or in parallel. -## **Resources** {#resources} +## **Resources** The specification that covers the Realtime Pages Data Exchange format in more detail can be found here: [https://www.openactive.io/realtime-paged-data-exchange/](https://www.openactive.io/realtime-paged-data-exchange/)​ diff --git a/docs/using-data/how-to-find-opportunity-data-using-the-openactive-opportunity-data-dashboard.md b/docs/using-data/how-to-find-opportunity-data-using-the-openactive-opportunity-data-dashboard.md index 756dc3c9..92995f5d 100644 --- a/docs/using-data/how-to-find-opportunity-data-using-the-openactive-opportunity-data-dashboard.md +++ b/docs/using-data/how-to-find-opportunity-data-using-the-openactive-opportunity-data-dashboard.md @@ -2,34 +2,28 @@ ## **Introduction** -**If you’re looking to use physical activity opportunity data within your website or app, you’re probably wanting to understand what’s available to you, and to identify which of it will help you meet your goals. To support people with this we’ve created the OpenActive Opportunity Data Dashboard.** +If you’re looking to use physical activity opportunity data within your website or app, you’re probably wanting to understand what’s available to you, and to identify which of it will help you meet your goals. To support people with this we’ve created the OpenActive Opportunity Data Dashboard. +The status dashboard can be found at [status.openactive.io](http://status.openactive.io/). It lists all of the openly licensed datasets and APIs published as part of the OpenActive initiative, as well as highlighting attributes of each set. -**The status dashboard can be found at** [**status.openactive.io**](http://status.openactive.io/)**. It lists all of the openly licensed datasets and APIs published as part of the OpenActive initiative, as well as highlighting attributes of each set.** +In this guide we’ll cover: - -**In this guide we’ll cover:** - - -* **Seeing what data is available** -* **How you can find data that meets your needs** -* **Taking your next steps** +* Seeing what data is available +* How you can find data that meets your needs +* Taking your next steps ## **How to see all of the open opportunity data that’s available** -**When landing on** [**status.openactive.io**](http://status.openactive.io/)**, you’re presented with a table that contains an overview of each dataset currently available under the OpenActive initiative. Each row on the table represents a different dataset. These are ordered alphabetically by default, but you can sort the table in different ways to help you explore.** - +When landing on [status.openactive.io](http://status.openactive.io/), you’re presented with a table that contains an overview of each dataset currently available under the OpenActive initiative. Each row on the table represents a different dataset. These are ordered alphabetically by default, but you can sort the table in different ways to help you explore. ![The API status dashboard, with a selection of datasets highlighted](https://lh5.googleusercontent.com/is13vfrrV1BvSGpSdgC4V7d9xo4y2IlsqVUo4lgUm4sB7ejgfJSAHlTp2jhMuj0hrsUvlzz-qN3zFQIFmfFjfGpNhEvjelovWq_8jL0TD8cuUt9prik9uXr_Ph_twSJMYQsMMMB9) -**As part of** [**the publishing process**](https://www.openactive.io/getting-started/) **for datasets, we ask publishers to provide some basic information about their feeds, including where the endpoint is located. Because of this, feeds will automatically appear on the dashboard when they’re reviewed and published.** +As part of [the publishing process](https://www.openactive.io/getting-started/) for datasets, we ask publishers to provide some basic information about their feeds, including where the endpoint is located. Because of this, feeds will automatically appear on the dashboard when they’re reviewed and published. +The list of datasets on the dashboard and the summaries are regularly updated. The date and time of the last update is displayed on the main page and the individual dataset summary pages -**The list of datasets on the dashboard and the summaries are regularly updated. The date and time of the last update is displayed on the main page and the individual dataset summary pages** - - -**You can keep up to date with new datasets by checking the site periodically, by signing up to the** [**mailing list**](https://us13.list-manage.com/subscribe?u=9e6648557f84731796a4ac873&id=1665f95799)**, or at the bottom of the page there is an option to ‘**[**Download JSON list**](http://status.openactive.io/datasets.json)**’. This links to a file containing a snapshot of all of the information on the status site, including the sampled output. You can use this machine-readable version to automatically integrate new datasets into your application.** - +You can keep up to date with new datasets by checking the site periodically, by signing up to the [mailing list](https://us13.list-manage.com/subscribe?u=9e6648557f84731796a4ac873&id=1665f95799), or at the bottom of the page there is an option to ‘[Download JSON list](http://status.openactive.io/datasets.json)’. This links to a file containing a snapshot of all of the information on the status site, including the sampled output. You can use this machine-readable version to automatically integrate new datasets into your application. +**** ![A view of the contents of the status dashboard summary JSON file](https://lh4.googleusercontent.com/Sn9bpyu6cJsGBzTTXeVdBZoXU3QJhY8bN_c6HakjrARe02Anxh5IUCCgaH1sQeeQFKjqYqhKflavGNqZJmDU1B8cDvF4UElW6yATLcWvrG2gS9tUpuiiIzMk0ZWVG3W46_vnW8_q) @@ -37,49 +31,40 @@ ## **How to find information that meets your needs** -**Whilst some people may wish to harvest all of the data available, others will be focused on certain types of data - perhaps certain activities or geographies - and may wish to understand more about the content of the datasets. The status site lets you do this in a few different ways. Looking at each row in the table, you may want to consider some or all of the following:** +Whilst some people may wish to harvest all of the data available, others will be focused on certain types of data - perhaps certain activities or geographies - and may wish to understand more about the content of the datasets. The status site lets you do this in a few different ways. Looking at each row in the table, you may want to consider some or all of the following: +### Key dataset information -### **Key dataset information** - -* **Provider - includes the name of the organisation publishing the data. This links through to more information, optionally including mailing list, documentation, and more.** -* **Endpoint - includes an indicator of whether the API is currently up or down. This links through to the URL for the dataset/API.** +* Provider - includes the name of the organisation publishing the data. This links through to more information, optionally including mailing list, documentation, and more. +* Endpoint - includes an indicator of whether the API is currently up or down. This links through to the URL for the dataset/API. **Conformance to standards, and known issues** -* **Uses paging spec - with a link to the specification itself in the header of the table, this column represents whether or not the dataset conforms to the standards around how data is transferred for harvesting. For each feed, clicking on the entry will take you to the validator tool which will tell you of the errors conforming to v1.1 of the RPDE spec.** -* **Uses opportunity model - similarly, the opportunity model specification is linked in the table header. This column represents whether or not the dataset conforms to standards around the model of the data itself. For each feed, clicking on the entry will take you to the validator tool which will tell you of any errors conforming to v2 of the data model spec.** -* **Issues - showing the number of open issues and discussions relating to this dataset. This links through to the dataset’s GitHub issue tracker.** - -\*\*\*\* +* Uses paging spec - with a link to the specification itself in the header of the table, this column represents whether or not the dataset conforms to the standards around how data is transferred for harvesting. For each feed, clicking on the entry will take you to the validator tool which will tell you of the errors conforming to v1.1 of the RPDE spec. +* Uses opportunity model - similarly, the opportunity model specification is linked in the table header. This column represents whether or not the dataset conforms to standards around the model of the data itself. For each feed, clicking on the entry will take you to the validator tool which will tell you of any errors conforming to v2 of the data model spec. +* Issues - showing the number of open issues and discussions relating to this dataset. This links through to the dataset’s GitHub issue tracker. ### **Activity types and geography** -* **Summary - if a dataset conforms to the standard data model then the dashboard will automatically generate a summary page for it. These pages are based on a daily sample of data from the data feed and provide an overview of the most common activities present in the dataset, as well as a summaryof their geographical spread across local authority areas. Please note that as the counts are from a sample, they are not reflective of the total number of opportunities.** -* **Includes coordinates - a recommendation of the standards is that opportunity data should include geographic coordinates for locations, to better support geographical searching. Where there is any evidence of coordinates, this flag is set to yes.** +* Summary - if a dataset conforms to the standard data model then the dashboard will automatically generate a summary page for it. These pages are based on a daily sample of data from the data feed and provide an overview of the most common activities present in the dataset, as well as a summaryof their geographical spread across local authority areas. Please note that as the counts are from a sample, they are not reflective of the total number of opportunities. +* Includes coordinates - a recommendation of the standards is that opportunity data should include geographic coordinates for locations, to better support geographical searching. Where there is any evidence of coordinates, this flag is set to yes. ![An example view of a summary page for a dataset](https://lh5.googleusercontent.com/Egjsca79kyPKii792w-tyDjOkHFxO83msIKjnvCsESeeGky7uO08nQYP7n3J2TQQ5-owneeaPgSCoMtiC7iGa1E9Lt-Pyv8e5S0srpRDhuE269WaooCZ3NrQTbuDcNlGPhWEkFEe) - -**** - ### **How the data can be used** -* **Licence - this indicates which open data licence the publisher has chosen to apply to their dataset. OpenActive recommends the Creative Commons Attribution licence which means you can use the data for any purpose, so long as you attribute your sources.** +* Licence - this indicates which open data licence the publisher has chosen to apply to their dataset. OpenActive recommends the Creative Commons Attribution licence which means you can use the data for any purpose, so long as you attribute your sources. ## **How to use the data that you’ve found** -**Once you’ve identified and made of note of the datasets that meet your needs, you’ll then need to harvest the data for each using their endpoints \(linked through in the endpoint column, or found using the data-url attribute in the JSON file\).** - - -**How to do this is covered in another tutorial, which you can find** [**here**](harvesting-opportunity-data.md)**.** +Once you’ve identified and made of note of the datasets that meet your needs, you’ll then need to harvest the data for each using their endpoints \(linked through in the endpoint column, or found using the data-url attribute in the JSON file\). +How to do this is covered in another tutorial, which you can find [here](harvesting-opportunity-data.md). ## **What if there is other data you want?** -**If there’s data missing from providers with an open feed \(e.g. they’ve only published kids activities and you want to use adult activities, or they haven’t provided detailed enough descriptions\) let them know through their GitHub repository, linked through their line on the status page. You can also let us know at** [**hello@openactive.io**](mailto:hello@openactive.io) **or on** [**Slack** ](https://www.openactive.io/public-openactive-w3c/)**as we can help coordinate you with other data users.** - +**I**f there’s data missing from providers with an open feed \(e.g. they’ve only published kids activities and you want to use adult activities, or they haven’t provided detailed enough descriptions\) let them know through their GitHub repository, linked through their line on the status page. You can also let us know at [hello@openactive.io](mailto:hello@openactive.io) or on [Slack ](https://www.openactive.io/public-openactive-w3c/)as we can help coordinate you with other data users. -**If you’re looking for data from a provider who isn’t yet open, let us know at** [**hello@openactive.io**](mailto:hello@openactive.io)**. We can let you know where that organisation is at in their open data journey, link you up to other data users so you can coordinate efforts, and support you to work directly with the data provider to get the data you want.** +If you’re looking for data from a provider who isn’t yet open, let us know at [hello@openactive.io](mailto:hello@openactive.io). We can let you know where that organisation is at in their open data journey, link you up to other data users so you can coordinate efforts, and support you to work directly with the data provider to get the data you want. From 69a1725c4b96a7e6391ed02cf1b10921fb9e6b96 Mon Sep 17 00:00:00 2001 From: Travis CI Date: Thu, 25 Oct 2018 13:26:52 +0000 Subject: [PATCH 06/10] Updating auto-generated model documentation: 78 [ci skip] --- docs/data-model/types/action.md | 41 +- docs/data-model/types/babychanging.md | 36 +- docs/data-model/types/brand.md | 98 ++- docs/data-model/types/changingfacilities.md | 36 +- docs/data-model/types/concept.md | 118 ++-- docs/data-model/types/conceptscheme.md | 101 ++- docs/data-model/types/courseinstance.md | 578 ++++++------------ docs/data-model/types/creche.md | 36 +- docs/data-model/types/entrypoint.md | 51 +- docs/data-model/types/event.md | 578 ++++++------------ docs/data-model/types/eventseries.md | 535 +++++----------- docs/data-model/types/facilityuse.md | 292 +++------ docs/data-model/types/geocoordinates.md | 41 +- docs/data-model/types/headlineevent.md | 521 +++++----------- docs/data-model/types/imageobject.md | 51 +- .../data-model/types/individualfacilityuse.md | 287 +++------ .../types/locationfeaturespecification.md | 36 +- docs/data-model/types/lockers.md | 36 +- docs/data-model/types/offer.md | 163 ++--- .../types/openinghoursspecification.md | 54 +- docs/data-model/types/organization.md | 142 ++--- docs/data-model/types/parking.md | 36 +- docs/data-model/types/partialschedule.md | 232 +++---- docs/data-model/types/person.md | 154 ++--- docs/data-model/types/place.md | 235 ++++--- docs/data-model/types/postaladdress.md | 80 +-- docs/data-model/types/propertyvalue.md | 63 +- docs/data-model/types/quantitativevalue.md | 56 +- docs/data-model/types/reserveaction.md | 41 +- docs/data-model/types/schedule.md | 287 +++------ docs/data-model/types/scheduledsession.md | 511 +++++----------- docs/data-model/types/sessionseries.md | 528 +++++----------- docs/data-model/types/showers.md | 36 +- docs/data-model/types/slot.md | 207 +++---- .../types/sportsactivitylocation.md | 249 ++++---- docs/data-model/types/toilets.md | 36 +- docs/data-model/types/towels.md | 36 +- 37 files changed, 2314 insertions(+), 4304 deletions(-) diff --git a/docs/data-model/types/action.md b/docs/data-model/types/action.md index 69ab11b0..6a2d7d3c 100644 --- a/docs/data-model/types/action.md +++ b/docs/data-model/types/action.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Action" + + Must always be present and set to "type": "Action"
name - Text + name + Text -

The name of the action

-

-
Example -

-

"name": "Book" -

+

The name of the action


Example

"name": "Book"
target - EntryPoint + target + EntryPoint -

A definition of the target of the action.

-

-
Example -

-

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} -

+

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/babychanging.md b/docs/data-model/types/babychanging.md index 96aacca1..afddc50c 100644 --- a/docs/data-model/types/babychanging.md +++ b/docs/data-model/types/babychanging.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "BabyChanging" + + Must always be present and set to "type": "BabyChanging"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Baby Changing Facilities" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Baby Changing Facilities"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/brand.md b/docs/data-model/types/brand.md index c4584376..80615e68 100644 --- a/docs/data-model/types/brand.md +++ b/docs/data-model/types/brand.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), ## **Fields** ### **Required fields** - + @@ -20,44 +20,38 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Brand" + + Must always be present and set to "type": "Brand"
name - Text + name + Text -

The name of the brand.

-

-
Example -

-

"name": "Play Ball!" -

+

The name of the brand.


Example

"name": "Play Ball!"
url - url + url + url -

A url where further information can be found for the brand.

-

-
Example -

-

"url": "http://example.com/play_ball" -

+

A url where further information can be found for the brand.


Example

"url": "http://example.com/play_ball"
### **Recommended fields** + + +### **Recommended fields** + @@ -68,36 +62,29 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - + -
description - Text + description + Text -

A text description for the brand.

-

-
Example -

-

"description": "Play Ball! is a series of games for people of all abilities." -

+

A text description for the brand.


Example

"description": "Play Ball! is a series of games for people of all abilities."
logo - ImageObject + logo + ImageObject -

The logo associated with the brand.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

The logo associated with the brand.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
### **Optional fields** + + +### **Optional fields** + @@ -108,26 +95,15 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + -
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "BR1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "BR1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/changingfacilities.md b/docs/data-model/types/changingfacilities.md index c6a201ef..2b65ac39 100644 --- a/docs/data-model/types/changingfacilities.md +++ b/docs/data-model/types/changingfacilities.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "ChangingFacilities" + + Must always be present and set to "type": "ChangingFacilities"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Changing Rooms" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Changing Rooms"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/concept.md b/docs/data-model/types/concept.md index 8fe8e544..367ffb27 100644 --- a/docs/data-model/types/concept.md +++ b/docs/data-model/types/concept.md @@ -4,12 +4,12 @@ description: This page describes the Concept type. # Concept -This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http://www.w3.org/2004/02/skos/core#Concept). +This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://www.w3.org/2004/02/skos/core#Concept). ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Concept" + + Must always be present and set to "type": "Concept"
prefLabel - Text + prefLabel + Text -

A human readable string for use in user interfaces.

-

-
Example -

-

"prefLabel": "Speedball" -

+

A human readable string for use in user interfaces.


Example

"prefLabel": "Speedball"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,36 +53,29 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/concept/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/concept/12345"
inScheme - url + inScheme + url -

A stable URL reference for the taxonomy.

-

-
Example -

-

"inScheme": "https://example.com/reference/activities" -

+

A stable URL reference for the taxonomy.


Example

"inScheme": "https://example.com/reference/activities"
### **Optional fields** + + +### **Optional fields** + @@ -94,60 +86,42 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - + - - + - - + -
altLabel - Array of Text + altLabel + Array of Text -

An alternative human readable string for use in user interfaces.

-

-
Example -

-

"altLabel": "Speedball" -

+

An alternative human readable string for use in user interfaces.


Example

"altLabel": "Speedball"
broader - Array of url + broader + Array of url -

A broader Concept URI

-

-
Example -

-

"broader": "https://example.com/football" -

+

A broader Concept URI


Example

"broader": "https://example.com/football"
narrower - Array of url + narrower + Array of url -

A more specific concept URI

-

-
Example -

-

"narrower": "https://example.com/walking-football" -

+

A more specific concept URI


Example

"narrower": "https://example.com/walking-football"
notation - Text + notation + Text -

A concept label that is not normally recognisable as natural language.

-

-
Example -

-

"notation": "Speedball" -

+

A concept label that is not normally recognisable as natural language.


Example

"notation": "Speedball"
\ No newline at end of file + + + diff --git a/docs/data-model/types/conceptscheme.md b/docs/data-model/types/conceptscheme.md index aa531e69..d3acfe5e 100644 --- a/docs/data-model/types/conceptscheme.md +++ b/docs/data-model/types/conceptscheme.md @@ -4,12 +4,12 @@ description: This page describes the ConceptScheme type. # ConceptScheme -This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). +This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). ## **Fields** ### **Required fields** - + @@ -20,73 +20,56 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](h - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ConceptScheme" + + Must always be present and set to "type": "ConceptScheme"
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/scheme/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/scheme/12345"
concept - Array of Concept + concept + Array of Concept -

A collection of concepts that are part of this scheme

-

-
Example -

-

"concept": [
{
"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"
}
] -

+

A collection of concepts that are part of this scheme


Example

"concept": [
  {
    "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"
  }
]
title - Text + title + Text -

The title of the scheme

-

-
Example -

-

"title": "Activity List" -

+

The title of the scheme


Example

"title": "Activity List"
url - url + url + url -

A URL to a web page (or section of a page) that describes the concept - scheme.

-

-
Example -

-

"url": "https://example.com/scheme/1234" -

+

A URL to a web page (or section of a page) that describes the concept scheme.


Example

"url": "https://example.com/scheme/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -97,32 +80,24 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](h - - + - - + -
description - Text + description + Text -

A free text description of the taxonomy

-

-
Example -

-

"description": "An example activity list." -

+

A free text description of the taxonomy


Example

"description": "An example activity list."
license - url + license + url -

Reference to the license under which the activity list has been published.

-

-
Example -

-

"license": "https://example.com/license/MIT" -

+

Reference to the license under which the activity list has been published.


Example

"license": "https://example.com/license/MIT"
\ No newline at end of file + + + diff --git a/docs/data-model/types/courseinstance.md b/docs/data-model/types/courseinstance.md index 11d31e31..47459544 100644 --- a/docs/data-model/types/courseinstance.md +++ b/docs/data-model/types/courseinstance.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe ## **Fields** ### **Required fields** - + @@ -20,100 +20,75 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe - - + - - - + - - + - - + - - + - + + - + + + -
type - Text + type + Text Must always be present and set to "type": "CourseInstance" + + Must always be present and set to "type": "CourseInstance"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		offers + Array of Offer -

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
url + organizer + Organization
- or -
Person + 		+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

 url +
url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Required options** + -While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. + +### ** Required options ** + +While these properties are marked as optional in the specification, a data publisher must provide either a `startDate` or specify an `eventSchedule` for an event. @@ -125,40 +100,29 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + -
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
### **Recommended fields** + + +### **Recommended fields** + @@ -169,211 +133,119 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - - - - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url - id -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

-
ageRange - QuantitativeValue + url -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
description - Text + ageRange + QuantitativeValue -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
endDate - DateTime -
- or - -
Date + 		description + Text -

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
eventStatus - EventStatusType + endDate + DateTime
- or -
Date 		-

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
genderRestriction - GenderRestrictionType + eventStatus + EventStatusType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
image - Array of ImageObject + genderRestriction + GenderRestrictionType -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
leader - Array of Person + image + Array of ImageObject -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
level - Array of Text -
- or - -
Array of Concept + 		leader + Array of Person -

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 -

-

"level": [
"beginner"
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
maximumAttendeeCapacity - Integer + level + Array of Text
- or -
Array of Concept 		-

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

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

"level": [
  "beginner"
]
offers - Array of Offer + maximumAttendeeCapacity + Integer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Optional fields** + + +### **Optional fields** + @@ -384,259 +256,159 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/creche.md b/docs/data-model/types/creche.md index 1023ec78..2ee2db11 100644 --- a/docs/data-model/types/creche.md +++ b/docs/data-model/types/creche.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Creche" + + Must always be present and set to "type": "Creche"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Childcare" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Childcare"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/entrypoint.md b/docs/data-model/types/entrypoint.md index e487be2c..960e3c97 100644 --- a/docs/data-model/types/entrypoint.md +++ b/docs/data-model/types/entrypoint.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent ## **Fields** ### **Required fields** - + @@ -20,49 +20,42 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent - - + - - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "EntryPoint" + + Must always be present and set to "type": "EntryPoint"
encodingType - Text + encodingType + Text Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json" + + Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json"
httpMethod - Text + httpMethod + Text -

An HTTP method that specifies the appropriate HTTP method for a request - to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.

-

-
Example -

-

"httpMethod": "POST" -

+

An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.


Example

"httpMethod": "POST"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

URL of the item

-

-
Example -

-

"urlTemplate": "https://example.com/orders{/var}" -

+

URL of the item


Example

"urlTemplate": "https://example.com/orders{/var}"
\ No newline at end of file + + + diff --git a/docs/data-model/types/event.md b/docs/data-model/types/event.md index 788ed924..4c4108c7 100644 --- a/docs/data-model/types/event.md +++ b/docs/data-model/types/event.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,100 +20,75 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - + + - + + + -
type - Text + type + Text Must always be present and set to "type": "Event" + + Must always be present and set to "type": "Event"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		offers + Array of Offer -

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
url + organizer + Organization
- or -
Person + 		+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

 url +
url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Required options** + -While these properties are marked as optional, a data publisher must provide either a schema:startDate or specify a oa:eventSchedule for an event. + +### ** Required options ** + +While these properties are marked as optional in the specification, a data publisher must provide either a `startDate` or specify an `eventSchedule` for an event. @@ -125,40 +100,29 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + -
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
### **Recommended fields** + + +### **Recommended fields** + @@ -169,211 +133,119 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - - - - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url - id -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

-
ageRange - QuantitativeValue + url -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
description - Text + ageRange + QuantitativeValue -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
endDate - DateTime -
- or - -
Date + 		description + Text -

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
eventStatus - EventStatusType + endDate + DateTime
- or -
Date 		-

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
genderRestriction - GenderRestrictionType + eventStatus + EventStatusType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
image - Array of ImageObject + genderRestriction + GenderRestrictionType -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
leader - Array of Person + image + Array of ImageObject -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
level - Array of Text -
- or - -
Array of Concept + 		leader + Array of Person -

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 -

-

"level": [
"beginner"
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
maximumAttendeeCapacity - Integer + level + Array of Text
- or -
Array of Concept 		-

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

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

"level": [
  "beginner"
]
offers - Array of Offer + maximumAttendeeCapacity + Integer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Optional fields** + + +### **Optional fields** + @@ -384,259 +256,159 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/eventseries.md b/docs/data-model/types/eventseries.md index c128261b..8ec56a3e 100644 --- a/docs/data-model/types/eventseries.md +++ b/docs/data-model/types/eventseries.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi ## **Fields** ### **Required fields** - + @@ -20,77 +20,56 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "EventSeries" + + Must always be present and set to "type": "EventSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -101,175 +80,110 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
### **Optional fields** + + +### **Optional fields** + @@ -280,317 +194,186 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/facilityuse.md b/docs/data-model/types/facilityuse.md index eccc90b5..a0d843b4 100644 --- a/docs/data-model/types/facilityuse.md +++ b/docs/data-model/types/facilityuse.md @@ -4,10 +4,12 @@ description: This page describes the FacilityUse type. # FacilityUse + + ## **Fields** ### **Required fields** - + @@ -18,80 +20,65 @@ description: This page describes the FacilityUse type. - - + - - - + - - + - - + - + + - - - - + -
type - Text + type + Text Must always be present and set to "type": "FacilityUse" + + Must always be present and set to "type": "FacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - a facility use.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the facility use will take place.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the facility use

-

-
Example -

-

"name": "Speedball" -

+

The name of the facility use


Example

"name": "Speedball"
provider + provider + + +

The organisation responsible for providing the facility


Example

"provider": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility - use.

-

-
Example -

-

"url": "https://example.com/facility-use/1234" -

+

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -102,86 +89,65 @@ description: This page describes the FacilityUse type. - - + - - + - - + - + - - - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/facility-use/112345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"
description - Text + description + Text -

A free text description of the facility use

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."
event - Array of Slot + event + Array of Slot -

An array of slots of availability of this FacilityUse.

-

-
Example -

-

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 3,
"maximumUses": 6
}
] -

+

An array of slots of availability of this FacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 3,
    "maximumUses": 6
  }
]
hoursAvailable + hoursAvailable + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the facility use is available

The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at - a previous event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
### **Optional fields** + + +### **Optional fields** + @@ -192,136 +158,78 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. - more information on how to find it, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." -

+

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.

-

-
Example -

-

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] -

+

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
individualFacilityUse - Array of IndividualFacilityUse + individualFacilityUse + Array of IndividualFacilityUse -

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse - (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse - (e.g. an opportunity to play tennis on a specific court).

-

-
Example -

-

"individualFacilityUse": [
{
"type": "IndividualFacilityUse",
"id": "http://www.example.org/facility-uses/1",
"name": "Tennis Court 1"
}
] -

+

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court).


Example

"individualFacilityUse": [
  {
    "type": "IndividualFacilityUse",
    "id": "http://www.example.org/facility-uses/1",
    "name": "Tennis Court 1"
  }
]
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
\ No newline at end of file + + + diff --git a/docs/data-model/types/geocoordinates.md b/docs/data-model/types/geocoordinates.md index 279b2904..8d98bd79 100644 --- a/docs/data-model/types/geocoordinates.md +++ b/docs/data-model/types/geocoordinates.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "GeoCoordinates" + + Must always be present and set to "type": "GeoCoordinates"
latitude - Float + latitude + Float -

The latitude of a location. For example 51.522338 (WGS 84).

-

-
Example -

-

"latitude": 51.522338 -

+

The latitude of a location. For example 51.522338 (WGS 84).


Example

"latitude": 51.522338
longitude - Float + longitude + Float -

The longitude of a location. For example -0.083437 (WGS 84).

-

-
Example -

-

"longitude": -0.083437 -

+

The longitude of a location. For example -0.083437 (WGS 84).


Example

"longitude": -0.083437
\ No newline at end of file + + + diff --git a/docs/data-model/types/headlineevent.md b/docs/data-model/types/headlineevent.md index 2d4cf784..2a62b521 100644 --- a/docs/data-model/types/headlineevent.md +++ b/docs/data-model/types/headlineevent.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,116 +20,74 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "HeadlineEvent" + + Must always be present and set to "type": "HeadlineEvent"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -140,194 +98,119 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
### **Optional fields** + + +### **Optional fields** + @@ -338,244 +221,150 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/imageobject.md b/docs/data-model/types/imageobject.md index 3d0cafa7..cdbb0626 100644 --- a/docs/data-model/types/imageobject.md +++ b/docs/data-model/types/imageobject.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im ## **Fields** ### **Required fields** - + @@ -20,31 +20,48 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im - - + - - + - + + +
type - Text + type + Text Must always be present and set to "type": "ImageObject" + + Must always be present and set to "type": "ImageObject"
url + url + url url + +

The URL for the display resolution image.


Example

"url": "http://example.com/static/image/speedball_large.jpg"

+
+ + +### **Optional fields** + + + + + + + + + + + + + -
PropertyExpected TypeDescription
thumbnail + Array of ImageObject -

The URL for the display resolution image.

-

-
Example -

-

"url": "http://example.com/static/image/speedball_large.jpg" -

+

The URL for a thumbnail image for an image.
### **Optional fields** + -| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **thumbnail** | Array of [`ImageObject`](https://docs.openactive.io/data-model/types/imageobject) | The URL for a thumbnail image for an image. | diff --git a/docs/data-model/types/individualfacilityuse.md b/docs/data-model/types/individualfacilityuse.md index ba69fdef..bbab228a 100644 --- a/docs/data-model/types/individualfacilityuse.md +++ b/docs/data-model/types/individualfacilityuse.md @@ -4,10 +4,12 @@ description: This page describes the IndividualFacilityUse type. # IndividualFacilityUse + + ## **Fields** ### **Required fields** - + @@ -18,80 +20,65 @@ description: This page describes the IndividualFacilityUse type. - - + - - - + - - + - - + - + + - - - - + -
type - Text + type + Text Must always be present and set to "type": "IndividualFacilityUse" + + Must always be present and set to "type": "IndividualFacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - a facility use.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the facility use will take place.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the facility use

-

-
Example -

-

"name": "Speedball" -

+

The name of the facility use


Example

"name": "Speedball"
provider + provider + + +

The organisation responsible for providing the facility


Example

"provider": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

The organisation responsible for providing the facility
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility - use.

-

-
Example -

-

"url": "https://example.com/facility-use/1234" -

+

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -102,81 +89,65 @@ description: This page describes the IndividualFacilityUse type. - - + - + - - - - + - - + - + - - - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/facility-use/112345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"
aggregateFacilityUse + aggregateFacilityUse + FacilityUse FacilityUse + +

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location).

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse - (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse - (e.g. an opportunity to play tennis at a specific location).
description - Text + description + Text -

A free text description of the facility use

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."
event - Array of Slot + event + Array of Slot -

An array of slots of availability of this IndividualFacilityUse.

-

-
Example -

-

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 0,
"maximumUses": 1
}
] -

+

An array of slots of availability of this IndividualFacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 0,
    "maximumUses": 1
  }
]
hoursAvailable + hoursAvailable + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the facility use is available

The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at - a previous event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
### **Optional fields** + + +### **Optional fields** + @@ -187,134 +158,78 @@ description: This page describes the IndividualFacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. - more information on how to find it, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." -

+

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.

-

-
Example -

-

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] -

+

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
\ No newline at end of file + + + diff --git a/docs/data-model/types/locationfeaturespecification.md b/docs/data-model/types/locationfeaturespecification.md index 1b719113..6962df6d 100644 --- a/docs/data-model/types/locationfeaturespecification.md +++ b/docs/data-model/types/locationfeaturespecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "LocationFeatureSpecification" + + Must always be present and set to "type": "LocationFeatureSpecification"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Bike Shed" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Bike Shed"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/lockers.md b/docs/data-model/types/lockers.md index 6db45ee7..ad1972ce 100644 --- a/docs/data-model/types/lockers.md +++ b/docs/data-model/types/lockers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Lockers" + + Must always be present and set to "type": "Lockers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Indoor Lockers" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Indoor Lockers"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/offer.md b/docs/data-model/types/offer.md index 54853835..3c608cdc 100644 --- a/docs/data-model/types/offer.md +++ b/docs/data-model/types/offer.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), ## **Fields** ### **Required fields** - + @@ -20,33 +20,29 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Offer" + + Must always be present and set to "type": "Offer"
price - Float + price + Float -

The offer price of the activity.

-

This price should be specified without currency symbols and as a floating - point number with two decimal places.

-

The currency of the price should be expressed in the priceCurrency field.

-

-
Example -

-

"price": 33 -

+

The offer price of the activity.

This price should be specified without currency symbols and as a floating point number with two decimal places.

The currency of the price should be expressed in the priceCurrency field.


Example

"price": 33
### **Recommended fields** + + +### **Recommended fields** + @@ -57,82 +53,56 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/offer/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/offer/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
name - Text + name + Text -

A human readable name for the offer.

-

-
Example -

-

"name": "Speedball winger position" -

+

A human readable name for the offer.


Example

"name": "Speedball winger position"
priceCurrency - Text + priceCurrency + Text -

The currency (in 3-letter ISO 4217 format) of the price.

-

If an Offer has a zero price, then this property is not required. Otherwise - the currency must be specified.

-

-
Example -

-

"priceCurrency": "GBP" -

+

The currency (in 3-letter ISO 4217 format) of the price.

If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified.


Example

"priceCurrency": "GBP"
url - url + url + url -

URL describing the offer

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

URL describing the offer


Example

"url": "http://www.rphs.org.uk/"
### **Optional fields** + + +### **Optional fields** + @@ -143,56 +113,33 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + + - - + -
advanceBooking - RequiredStatusType + advanceBooking + RequiredStatusType -

Indicates whether to accept this offer, a participant must book in advance, - whether they must pay on attending, or have option to do either.

-

-
Example -

-

"advanceBooking": "https://openactive.io/Required" -

+

Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either.


Example

"advanceBooking": "https://openactive.io/Required"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
prepayment - RequiredStatusType + prepayment + RequiredStatusType -

Indicates whether to accept this offer, a participant must pay in advance, - pay when attending, or have the option to do either.

-

-
Example -

-

"prepayment": "https://openactive.io/Required" -

+

Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either.


Example

"prepayment": "https://openactive.io/Required"
\ No newline at end of file + + + diff --git a/docs/data-model/types/openinghoursspecification.md b/docs/data-model/types/openinghoursspecification.md index bf25b3da..1340d446 100644 --- a/docs/data-model/types/openinghoursspecification.md +++ b/docs/data-model/types/openinghoursspecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ ## **Fields** ### **Required fields** - + @@ -20,54 +20,42 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ - - + - - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "OpeningHoursSpecification" + + Must always be present and set to "type": "OpeningHoursSpecification"
closes - Time + closes + Time -

The closing time.

-

-
Example -

-

"closes": "17:00" -

+

The closing time.


Example

"closes": "17:00"
dayOfWeek - DayOfWeek + dayOfWeek + DayOfWeek -

Defines the day of the week upon which the Place is open

-

-
Example -

-

"dayOfWeek": "https://schema.org/Monday" -

+

Defines the day of the week upon which the Place is open


Example

"dayOfWeek": "https://schema.org/Monday"
opens - Time + opens + Time -

The opening time.

-

-
Example -

-

"opens": "09:00" -

+

The opening time.


Example

"opens": "09:00"
\ No newline at end of file + + + diff --git a/docs/data-model/types/organization.md b/docs/data-model/types/organization.md index 52c565df..2c7ef789 100644 --- a/docs/data-model/types/organization.md +++ b/docs/data-model/types/organization.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Organization" + + Must always be present and set to "type": "Organization"
name - Text + name + Text -

The name of the Organization

-

-
Example -

-

"name": "Central Speedball Association" -

+

The name of the Organization


Example

"name": "Central Speedball Association"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,65 +53,47 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/organization/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/organization/12345"
sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated - with the organization.

-

-
Example -

-

"sameAs": [
"https://www.facebook.com/everyoneactive/",
"https://twitter.com/everyoneactive"
] -

+

Lists the URL(s) of the official social media profile pages associated with the organization.


Example

"sameAs": [
  "https://www.facebook.com/everyoneactive/",
  "https://twitter.com/everyoneactive"
]
telephone - Text + telephone + Text -

The telephone number of the Organization

-

-
Example -

-

"telephone": "01234 567890" -

+

The telephone number of the Organization


Example

"telephone": "01234 567890"
url - url + url + url -

A definitive canonical URL for the Organization.

-

-
Example -

-

"url": "http://www.speedball-world.com" -

+

A definitive canonical URL for the Organization.


Example

"url": "http://www.speedball-world.com"
### **Optional fields** + + +### **Optional fields** + @@ -123,54 +104,33 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + + - - + -
description - Text + description + Text -

The description of the Organization

-

-
Example -

-

"description": "The national governing body of cycling" -

+

The description of the Organization


Example

"description": "The national governing body of cycling"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
logo - ImageObject + logo + ImageObject -

A logo for the Organization.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

A logo for the Organization.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/parking.md b/docs/data-model/types/parking.md index d18ce763..1d5b05bd 100644 --- a/docs/data-model/types/parking.md +++ b/docs/data-model/types/parking.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Parking" + + Must always be present and set to "type": "Parking"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Roadside Parking" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Roadside Parking"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/partialschedule.md b/docs/data-model/types/partialschedule.md index b8cc1d8c..852a2ca8 100644 --- a/docs/data-model/types/partialschedule.md +++ b/docs/data-model/types/partialschedule.md @@ -9,13 +9,31 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "PartialSchedule" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "PartialSchedule"` | ### **Recommended fields** - + @@ -26,51 +44,38 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + -
endTime - Time + endTime + Time -

The end time of the event.

-

-
Example -

-

"endTime": "12:00:00" -

+

The end time of the event.


Example

"endTime": "12:00:00"
repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"
startTime - Time + startTime + Time -

The start time of the event.

-

-
Example -

-

"startTime": "12:00:00" -

+

The start time of the event.


Example

"startTime": "12:00:00"
### **Optional fields** + + +### **Optional fields** + @@ -81,172 +86,105 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek -
- or - -
Array of Text + 		byDay + Array of DayOfWeek
- or -
Array of Text 		-

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]
byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]
byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - Date + endDate + Date -

The end date of the schedule.

-

-
Example -

-

"endDate": "2018-01-27" -

+

The end date of the schedule.


Example

"endDate": "2018-01-27"
exceptDate - Array of Date -
- or - -
Array of DateTime + 		exceptDate + Array of Date
- or -
Array of DateTime 		-

Exception dates where the schedule should not generate an event.

-

-
Example -

-

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] -

+

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]
idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - identifier (@id) for every event described by the schedule (see below for - more information). This property is required if the data provider is supporting - third-party booking via the Open Booking API.

-

-
Example -

-

"idTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"
repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.

-

-
Example -

-

"repeatCount": 3 -

+

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3
scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.

-

-
Example -

-

"scheduledEventType": "Event" -

+

The type of event this schedule related to.


Example

"scheduledEventType": "Event"
startDate - Date + startDate + Date -

The start date of the event.

-

-
Example -

-

"startDate": "2018-01-27" -

+

The start date of the event.


Example

"startDate": "2018-01-27"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - URL (schema:url) for every event described by the schedule (see below for - more information). This property is required if the data provider wants - to provide participants with a unique URL to book to attend an event.

-

-
Example -

-

"urlTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"
\ No newline at end of file + + + diff --git a/docs/data-model/types/person.md b/docs/data-model/types/person.md index 032f9e42..9c59018e 100644 --- a/docs/data-model/types/person.md +++ b/docs/data-model/types/person.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "Person" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "Person"` | ### **Recommended fields** - + @@ -26,22 +44,20 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/person/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/person/12345"
### **Optional fields** + + +### **Optional fields** + @@ -52,113 +68,69 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + - - - + + - - + - - + - - + - - + - - + -
description - Text + description + Text -

The description of the Person

-

-
Example -

-

"description": "The leader of the coaching team" -

+

The description of the Person


Example

"description": "The leader of the coaching team"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
logo - ImageObject + logo + ImageObject -

A logo for the person.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

A logo for the person.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
name - Text + name + Text -

A full name for the person.

-

This person must give direct permission for their personal information - to be shared as part of the Open Data.

-

-
Example -

-

"name": "Daley Thompson" -

+

A full name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"name": "Daley Thompson"
sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated - with the person.

-

-
Example -

-

"sameAs": "https://example.org/example-org" -

+

Lists the URL(s) of the official social media profile pages associated with the person.


Example

"sameAs": "https://example.org/example-org"
telephone - Text + telephone + Text -

The telephone number of the person

-

-
Example -

-

"telephone": "01234 567890" -

+

The telephone number of the person


Example

"telephone": "01234 567890"
url - url + url + url -

A URL where more information about the person may be found

-

-
Example -

-

"url": "http://www.example.com/" -

+

A URL where more information about the person may be found


Example

"url": "http://www.example.com/"
\ No newline at end of file + + + diff --git a/docs/data-model/types/place.md b/docs/data-model/types/place.md index ce250875..17beda2e 100644 --- a/docs/data-model/types/place.md +++ b/docs/data-model/types/place.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Place" + + Must always be present and set to "type": "Place"
name - Text + name + Text -

The name of the Place

-

-
Example -

-

"name": "Raynes Park High School" -

+

The name of the Place


Example

"name": "Raynes Park High School"
### **Recommended fields** + + + +### ** Required options ** + +While these properties are marked as recommended in the specification, a data publisher must provide as much detail in both `address` and `geo` for an event as possible. @@ -54,134 +55,107 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - + + +
id - url + address + PostalAddress
- or -
Text 		-

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/place/12345" -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}
address - PostalAddress -
- or - -
Text + 		geo + GeoCoordinates -

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}
+ + +### **Recommended fields** + + + + + + + + + + - - + - - + - - + - - + - + - - - - + - - + -
PropertyExpected TypeDescription
amenityFeature - Array of LocationFeatureSpecification + id + url -

An array listing the Ammenities of the Place.

-

-
Example -

-

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] -

+

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"
description - Text + amenityFeature + Array of LocationFeatureSpecification -

The description of the Place

-

-
Example -

-

"description": "Raynes Park High School in London" -

+

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]
geo - GeoCoordinates + description + Text -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The description of the Place


Example

"description": "Raynes Park High School in London"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
openingHoursSpecification + openingHoursSpecification + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the Place is open

The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place

-

-
Example -

-

"telephone": "01253 473934" -

+

The telephone number for the Place


Example

"telephone": "01253 473934"
url - url + url + url -

The website for the Place

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

The website for the Place


Example

"url": "http://www.rphs.org.uk/"
### **Optional fields** + + +### **Optional fields** + @@ -192,54 +166,51 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - + - + + + + - + - + + + + -
containedInPlace - Place + address + PostalAddress
- or -
Text 		-

The place within which this Place exists

-

-
Example -

-

"containedInPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
"name": "Middlesbrough Sports Village"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}
containsPlace + containedInPlace + Place Array of Place + +

The place within which this Place exists


Example

"containedInPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
  "name": "Middlesbrough Sports Village"
}

containsPlace -

Places that exist within this place

-

-
Example -

-

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} -

+ Array of Place + 		+

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}
identifier + geo + GeoCoordinates Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

identifier -

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/postaladdress.md b/docs/data-model/types/postaladdress.md index 29028dc7..5b57322a 100644 --- a/docs/data-model/types/postaladdress.md +++ b/docs/data-model/types/postaladdress.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,82 +20,60 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "PostalAddress" + + Must always be present and set to "type": "PostalAddress"
addressCountry - Text + addressCountry + Text -

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.

-

-
Example -

-

"addressCountry": "GB" -

+

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.


Example

"addressCountry": "GB"
addressLocality - Text + addressLocality + Text -

The locality, a suburb within a city or a town within a county or district.

-

-
Example -

-

"addressLocality": "Shoreditch" -

+

The locality, a suburb within a city or a town within a county or district.


Example

"addressLocality": "Shoreditch"
addressRegion - Text + addressRegion + Text -

The region, either a city or a county or district.

-

-
Example -

-

"addressRegion": "London" -

+

The region, either a city or a county or district.


Example

"addressRegion": "London"
postalCode - Text + postalCode + Text -

The postal code.

-

-
Example -

-

"postalCode": "EC2A 4JE" -

+

The postal code.


Example

"postalCode": "EC2A 4JE"
streetAddress - Text + streetAddress + Text -

The street address.

-

-
Example -

-

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St" -

+

The street address.


Example

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St"
\ No newline at end of file + + + diff --git a/docs/data-model/types/propertyvalue.md b/docs/data-model/types/propertyvalue.md index 24b8f082..6719f4bb 100644 --- a/docs/data-model/types/propertyvalue.md +++ b/docs/data-model/types/propertyvalue.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,46 +20,38 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "PropertyValue" + + Must always be present and set to "type": "PropertyValue"
name - Text + name + Text -

The name of this PropertyValue

-

-
Example -

-

"name": "Vendor ID" -

+

The name of this PropertyValue


Example

"name": "Vendor ID"
value - Text -
- or - -
Integer + 		value + Text
- or -
Integer 		-

The actual value of this identifier

-

-
Example -

-

"value": "SB1234" -

+

The actual value of this identifier


Example

"value": "SB1234"
### **Optional fields** + + +### **Optional fields** + @@ -70,20 +62,15 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + -
propertyID - url -
- or - -
Text + 		propertyID + url
- or -
Text 		-

A commonly used identifier for the characteristic represented by the property

-

-
Example -

-

"propertyID": "ActivePlaces" -

+

A commonly used identifier for the characteristic represented by the property


Example

"propertyID": "ActivePlaces"
\ No newline at end of file + + + diff --git a/docs/data-model/types/quantitativevalue.md b/docs/data-model/types/quantitativevalue.md index 86fd4b4b..28f57819 100644 --- a/docs/data-model/types/quantitativevalue.md +++ b/docs/data-model/types/quantitativevalue.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "QuantitativeValue" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "QuantitativeValue"` | ### **Optional fields** - + @@ -26,32 +44,24 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. - - + - - + -
maxValue - Integer + maxValue + Integer -

The maximum value.

-

-
Example -

-

"maxValue": 60 -

+

The maximum value.


Example

"maxValue": 60
minValue - Integer + minValue + Integer -

The minimum value.

-

-
Example -

-

"minValue": 16 -

+

The minimum value.


Example

"minValue": 16
\ No newline at end of file + + + diff --git a/docs/data-model/types/reserveaction.md b/docs/data-model/types/reserveaction.md index 24dbfc4d..ad053fdd 100644 --- a/docs/data-model/types/reserveaction.md +++ b/docs/data-model/types/reserveaction.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ReserveAction" + + Must always be present and set to "type": "ReserveAction"
name - Text + name + Text -

The name of the action

-

-
Example -

-

"name": "Book" -

+

The name of the action


Example

"name": "Book"
target - EntryPoint + target + EntryPoint -

A definition of the target of the action.

-

-
Example -

-

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} -

+

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/schedule.md b/docs/data-model/types/schedule.md index 8cbe81de..77c89bd8 100644 --- a/docs/data-model/types/schedule.md +++ b/docs/data-model/types/schedule.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - + @@ -20,74 +20,48 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - - - - - - + - - + - - + - - + -
type - Text - Must always be present and set to "type": "Schedule" -
endTime - Time + type + Text -

The end time of the event.

-

-
Example -

-

"endTime": "12:00:00" -

+ Must always be present and set to "type": "Schedule"
repeatFrequency - Duration + endTime + Time -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

The end time of the event.


Example

"endTime": "12:00:00"
scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.

-

-
Example -

-

"scheduledEventType": "Event" -

+

The type of event this schedule related to.


Example

"scheduledEventType": "Event"
startTime - Time + startTime + Time -

The start time of the event.

-

-
Example -

-

"startTime": "12:00:00" -

+

The start time of the event.


Example

"startTime": "12:00:00"
### **Required options** + -While these properties are marked as optional, a data publisher must provide either a schema:byDay, schema:byMonth or byMonthDay for a schedule. + +### ** Required options ** + +While these properties are marked as optional, a data publisher must provide either a `byDay`, `byMonth`, `byMonthDay` or `repeatFrequency` for a schedule. @@ -99,56 +73,47 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - + - + + + + -
byDay - Array of DayOfWeek -
- or - -
Array of Text + 		byDay + Array of DayOfWeek
- or -
Array of Text 		-

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]
byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]
byMonthDay + byMonthDay + Array of Integer Array of Integer + +

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+
repeatFrequency + Duration -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"
### **Recommended fields** + + +### **Recommended fields** + @@ -159,84 +124,56 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - Date + endDate + Date -

The end date of the schedule.

-

-
Example -

-

"endDate": "2018-01-27" -

+

The end date of the schedule.


Example

"endDate": "2018-01-27"
idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - identifier (@id) for every event described by the schedule (see below for - more information). This property is required if the data provider is supporting - third-party booking via the Open Booking API.

-

-
Example -

-

"idTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"
startDate - Date + startDate + Date -

The start date of the event.

-

-
Example -

-

"startDate": "2018-01-27" -

+

The start date of the event.


Example

"startDate": "2018-01-27"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - URL (schema:url) for every event described by the schedule (see below for - more information). This property is required if the data provider wants - to provide participants with a unique URL to book to attend an event.

-

-
Example -

-

"urlTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"
### **Optional fields** + + +### **Optional fields** + @@ -247,82 +184,60 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - + - + + + + -
byDay - Array of DayOfWeek -
- or - -
Array of Text + 		byDay + Array of DayOfWeek
- or -
Array of Text 		-

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]
byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]
byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]
exceptDate - Array of Date -
- or - -
Array of DateTime + 		exceptDate + Array of Date
- or -
Array of DateTime 		-

Exception dates where the schedule should not generate an event.

-

-
Example -

-

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] -

+

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]
repeatCount + repeatCount + Integer Integer + +

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3

+
repeatFrequency + Duration -

Defines the number of times a recurring Event will take place.

-

-
Example -

-

"repeatCount": 3 -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"
\ No newline at end of file + + + diff --git a/docs/data-model/types/scheduledsession.md b/docs/data-model/types/scheduledsession.md index c6faa751..6c219234 100644 --- a/docs/data-model/types/scheduledsession.md +++ b/docs/data-model/types/scheduledsession.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,84 +20,56 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ScheduledSession" + + Must always be present and set to "type": "ScheduledSession"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Recommended fields** + + +### **Recommended fields** + @@ -108,129 +80,83 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Optional fields** + + +### **Optional fields** + @@ -241,332 +167,195 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/sessionseries.md b/docs/data-model/types/sessionseries.md index 2dc0c28a..d75d43b4 100644 --- a/docs/data-model/types/sessionseries.md +++ b/docs/data-model/types/sessionseries.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,99 +20,74 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - + - + + + + -
type - Text + type + Text Must always be present and set to "type": "SessionSeries" + + Must always be present and set to "type": "SessionSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		offers + Array of Offer -

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": [
{
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
url + organizer + Organization
- or -
Person 		url + +

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+
url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -123,132 +98,74 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - - - - + - - + - - + - - + - - + - - + -
id - url - id -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

-
ageRange - QuantitativeValue + url -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
description - Text + ageRange + QuantitativeValue -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
genderRestriction - GenderRestrictionType + description + Text -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
image - Array of ImageObject + genderRestriction + GenderRestrictionType -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
leader - Array of Person + image + Array of ImageObject -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
level - Array of Text -
- or - -
Array of Concept + 		leader + Array of Person -

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 -

-

"level": [
"beginner"
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
offers - Array of Offer + level + Array of Text
- or -
Array of Concept 		-

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

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

"level": [
  "beginner"
]
### **Optional fields** + + +### **Optional fields** + @@ -259,324 +176,195 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
subEvent + subEvent + Array of ScheduledSession Array of ScheduledSession + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/showers.md b/docs/data-model/types/showers.md index 2f7579e1..33f60e9c 100644 --- a/docs/data-model/types/showers.md +++ b/docs/data-model/types/showers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Showers" + + Must always be present and set to "type": "Showers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Poolside Showers" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Poolside Showers"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/slot.md b/docs/data-model/types/slot.md index 361b211b..1e0e4c96 100644 --- a/docs/data-model/types/slot.md +++ b/docs/data-model/types/slot.md @@ -4,10 +4,12 @@ description: This page describes the Slot type. # Slot + + ## **Fields** ### **Required fields** - + @@ -18,75 +20,64 @@ description: This page describes the Slot type. - - + - - - + - - + - - + - + + - + + + -
type - Text + type + Text Must always be present and set to "type": "Slot" + + Must always be present and set to "type": "Slot"
duration - Duration + duration + Duration -

The duration of the slot given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the slot given in [ISO8601] format.


Example

"duration": "PT1H"
facilityUse - url + facilityUse + url -

URI to the FacilityUse that has this offer

-

-
Example -

-

"facilityUse": "https://example.com/facility-use/1" -

+

URI to the FacilityUse that has this offer


Example

"facilityUse": "https://example.com/facility-use/1"
remainingUses - Integer + offers + Array of Offer -

The remaining available courts or pitches at this time. Must be 0 or 1 - for an IndividualFacilityUse.

-

-
Example -

-

"remainingUses": 5 -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
startDate + remainingUses + Integer + +

The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"remainingUses": 5

 DateTime -
- or - -
Date +
startDate + DateTime
- or -
Date 		-

The start date and time of the slot. Can be specified as a schema:Date - or schema:DateTime

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the slot. Can be specified as a schema:Date or schema:DateTime


Example

"startDate": "2018-01-27T12:00:00Z"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional/recommended in the Modelling Specification, one of these must be provided when surfacing a slot through an RPDE feed to ensure that the slots can be processed correctly by data consumers. @@ -100,44 +91,29 @@ While these properties are marked as optional/recommended in the Modelling Speci - id - - url + id + + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/slot/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

- identifier - - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + identifier + + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer -

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

-### **Recommended fields** + + +### **Recommended fields** + @@ -148,37 +124,29 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/slot/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"
maximumUses - Integer + maximumUses + Integer -

The maximum available courts or pitches at this time. Must be 0 or 1 for - an IndividualFacilityUse.

-

-
Example -

-

"maximumUses": 16 -

+

The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"maximumUses": 16
### **Optional fields** + + +### **Optional fields** + @@ -189,59 +157,24 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - - - - - + -
endDate - DateTime -
- or - -
Date - 		endDate -

The end date and time of the slot. Can be specified as a schema:Date or - schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an slot.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

-
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + DateTime
- or -
Date 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

The end date and time of the slot. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an slot.


Example

"endDate": "2018-01-27T12:00:00Z"
offers - Array of Offer + identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/sportsactivitylocation.md b/docs/data-model/types/sportsactivitylocation.md index 44c23b8e..8aeb6e17 100644 --- a/docs/data-model/types/sportsactivitylocation.md +++ b/docs/data-model/types/sportsactivitylocation.md @@ -9,12 +9,32 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "SportsActivityLocation" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "SportsActivityLocation"` | -### **Recommended fields** +### ** Required options ** + +While these properties are marked as recommended in the specification, a data publisher must provide as much detail in both `address` and `geo` for an event as possible. @@ -26,22 +46,29 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - + - + + + + -
id + address + PostalAddress
- or -
Text 		url + +

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

geo -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/place/12345" -

+ GeoCoordinates + 		+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}
### **Optional fields** + + +### **Recommended fields** + @@ -52,184 +79,138 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc - - + + +
address - PostalAddress -
- or - -
Text + 		id + url -

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"
+ + +### **Optional fields** + + + - - + + + + + + + + - - + - - + - - + - - + - - + - - + - - + - + - - - - + - + + - + + + -
amenityFeature - Array of LocationFeatureSpecification + PropertyExpected TypeDescription
address + PostalAddress
- or -
Text 		-

An array listing the Ammenities of the Place.

-

-
Example -

-

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}
containedInPlace - Place -
- or - -
url + 		amenityFeature + Array of LocationFeatureSpecification -

While a url is not specified as an option in the Modelling - Specification, it is necessary to link entities in RPDE.

-

-
Example -

-

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d" -

+

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]
containsPlace - Array of Place + containedInPlace + Place
- or -
url 		-

Places that exist within this place

-

-
Example -

-

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} -

+

While a url is not specified as an option in the Modelling Specification, it is necessary to link entities in RPDE.


Example

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d"
description - Text + containsPlace + Array of Place -

The description of the Place

-

-
Example -

-

"description": "Raynes Park High School in London" -

+

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}
geo - GeoCoordinates + description + Text -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The description of the Place


Example

"description": "Raynes Park High School in London"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		geo + GeoCoordinates -

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}
image - Array of ImageObject + identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

An image or photo that depicts the place, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
name - Text + image + Array of ImageObject -

The name of the Place

-

-
Example -

-

"name": "Raynes Park High School" -

+

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
openingHoursSpecification + name + Text Array of OpeningHoursSpecification + +

The name of the Place


Example

"name": "Raynes Park High School"

The times the Place is open
telephone - Text + openingHoursSpecification + Array of OpeningHoursSpecification -

The telephone number for the Place

-

-
Example -

-

"telephone": "01253 473934" -

+

The times the Place is open
url + telephone + Text + +

The telephone number for the Place


Example

"telephone": "01253 473934"

 url +
url + url -

The website for the Place

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

The website for the Place


Example

"url": "http://www.rphs.org.uk/"
\ No newline at end of file + + + diff --git a/docs/data-model/types/toilets.md b/docs/data-model/types/toilets.md index f8e164c9..f5248106 100644 --- a/docs/data-model/types/toilets.md +++ b/docs/data-model/types/toilets.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Toilets" + + Must always be present and set to "type": "Toilets"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Public Toilets" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Public Toilets"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/towels.md b/docs/data-model/types/towels.md index 14fb351e..063eb9c0 100644 --- a/docs/data-model/types/towels.md +++ b/docs/data-model/types/towels.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Towels" + + Must always be present and set to "type": "Towels"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Complementary Towels" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Complementary Towels"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + From e7e5305d220782db7c8512265cb807c2e752bb72 Mon Sep 17 00:00:00 2001 From: Melanie Abraham Date: Thu, 25 Oct 2018 15:24:32 +0000 Subject: [PATCH 07/10] GitBook: [draft] 39 pages modified --- ...enactive-data-model-part-one-the-basics.md | 211 +++++-- ...model-part-two-adding-additional-detail.md | 487 ++++++++++++++- docs/data-model/types/action.md | 41 +- docs/data-model/types/babychanging.md | 36 +- docs/data-model/types/brand.md | 98 +-- docs/data-model/types/changingfacilities.md | 36 +- docs/data-model/types/concept.md | 118 ++-- docs/data-model/types/conceptscheme.md | 101 ++-- docs/data-model/types/courseinstance.md | 570 ++++++++++++------ docs/data-model/types/creche.md | 36 +- docs/data-model/types/entrypoint.md | 51 +- docs/data-model/types/event.md | 570 ++++++++++++------ docs/data-model/types/eventseries.md | 535 +++++++++++----- docs/data-model/types/facilityuse.md | 295 ++++++--- docs/data-model/types/geocoordinates.md | 41 +- docs/data-model/types/headlineevent.md | 521 +++++++++++----- docs/data-model/types/imageobject.md | 51 +- .../data-model/types/individualfacilityuse.md | 290 ++++++--- .../types/locationfeaturespecification.md | 36 +- docs/data-model/types/lockers.md | 36 +- docs/data-model/types/offer.md | 163 +++-- .../types/openinghoursspecification.md | 54 +- docs/data-model/types/organization.md | 142 +++-- docs/data-model/types/parking.md | 36 +- docs/data-model/types/partialschedule.md | 232 ++++--- docs/data-model/types/person.md | 154 +++-- docs/data-model/types/place.md | 245 +++++--- docs/data-model/types/postaladdress.md | 80 ++- docs/data-model/types/propertyvalue.md | 63 +- docs/data-model/types/quantitativevalue.md | 56 +- docs/data-model/types/reserveaction.md | 41 +- docs/data-model/types/schedule.md | 286 ++++++--- docs/data-model/types/scheduledsession.md | 511 +++++++++++----- docs/data-model/types/sessionseries.md | 522 +++++++++++----- docs/data-model/types/showers.md | 36 +- docs/data-model/types/slot.md | 201 ++++-- .../types/sportsactivitylocation.md | 259 +++++--- docs/data-model/types/toilets.md | 36 +- docs/data-model/types/towels.md | 36 +- 39 files changed, 5004 insertions(+), 2309 deletions(-) diff --git a/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md index 103132c2..119b6153 100644 --- a/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md +++ b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md @@ -51,12 +51,13 @@ The recommended approach to publishing open opportunity data is as JSON, and spe ### **3.1 Add a context** -For our starting foundations, all opportunity data should begin with a context contained within an opening and closing bracket \(see below\). -**** - -| **{ "@context": "https://openactive.io/ns/oa.jsonld" }** | -| :--- | +For our starting foundations, all opportunity data should begin with a context contained within an opening and closing bracket \(see below\). +```text +{ +"@context": "https://openactive.io/ns/oa.jsonld" +} +``` A JSON-LD context maps the terms used in a JSON document to their standard definitions. To indicate that your data conforms to the OpenActive opportunity data specification, include a @context reference that matches the above. @@ -90,25 +91,25 @@ Adding to the JSON-LD context that we added in the first step, we now want to st To describe what type of thing we're going to be sharing in our data, we need to add a type property. It’s possible for the data model to describe a number of different types of things, but as we're describing an Event we’ll use that as the value. - - - - - - - -
-

{
"@context": "https://openactive.io/ns/oa.jsonld",
"type": "Event" -

-

} -

-
#### **Give it a name and URL** +```text +{ +"@context": "https://openactive.io/ns/oa.jsonld", +"type": "Event" +} +``` -Add in the name for your individual session, and the public URL where someone could go to find more information, or perhaps sign up to participate. +#### **Give it a name and URL** -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1" }** | -| :--- | +Add in the name for your individual session, and the public URL where someone could go to find more information, or perhaps sign up to participate. +```text +{ + "@context": "https://openactive.io/ns/oa.jsonld", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1" +} +``` #### **Defining the activity type** @@ -116,9 +117,24 @@ Next, we want to describe the type of activity this opportunity is for. As part In this case Roller Blading is in the standardised activity list, so we can add it to our model, along with references to the activity list that it has come from. We do this by adding an array of SKOS Concepts, however for our example we only need to define one activity type: -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], }** | -| :--- | - +```text +{ + "@context": "https://openactive.io/ns/oa.jsonld", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list/activity-list.jsonld +" + }], +} +``` #### **Giving it a time** @@ -130,9 +146,27 @@ The endDate property is the partner to startDate, and is used to signify the end In our example the activity lasts the full hour dictated by the start and end points. For that reason duration is optional, but it has been included here to illustrate usage. -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT1H", }** | -| :--- | - +```text +{ + "@context": "https://openactive.io/ns/oa.jsonld", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list/activity-list.jsonld +" + }], + "startDate": "2018-08-13T20:00:00Z", + "endDate": "2018-08-13T21:00:00Z", + "duration": "PT1H", +} +``` Your event timings may be more complicated than this, and we’ll come onto that in part two of this tutorial. @@ -140,24 +174,129 @@ Your event timings may be more complicated than this, and we’ll come onto that Finally, people need to know where to go to attend the event. Locations are added to events using the location property, which follows the [schema.org standards for address data](https://schema.org/PostalAddress). The minimum requirements for validation are shown below, but the recommendation in the specification is that applications should provide as much information about the **Place** as possible. -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT1H", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } } }** | -| :--- | - +```text +{ + "@context": "https://openactive.io/ns/oa.jsonld", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list/activity-list.jsonld +" + }], + "startDate": "2018-08-13T20:00:00Z", + "endDate": "2018-08-13T21:00:00Z", + "duration": "PT1H", + "location": { + "type": "Place", + "name": "ExampleCo Gym", + "address": { + "type": "PostalAddress", + "streetAddress": "1 High Street", + "addressLocality": "Colchester", + "addressRegion": "Essex", + "postalCode": "AB1 2CD", + "addressCountry": "GB" + } + } +} +``` An example of providing more information is through including geocodes. Whilst this is not mandatory for each event, it’s recommended as people are more likely to use the data if it’s geocoded. -| **{ "@context": "https://openactive.io/ns/oa.jsonld", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list/activity-list.jsonld**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT1H", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" } }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }** | -| :--- | - +```text +{ + "@context": "https://openactive.io/ns/oa.jsonld", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list/activity-list.jsonld +" + }], + "startDate": "2018-08-13T20:00:00Z", + "endDate": "2018-08-13T21:00:00Z", + "duration": "PT1H", + "location": { + "type": "Place", + "name": "ExampleCo Gym", + "address": { + "type": "PostalAddress", + "streetAddress": "1 High Street", + "addressLocality": "Colchester", + "addressRegion": "Essex", + "postalCode": "AB1 2CD", + "addressCountry": "GB" + } + }, + "geo": { + "type": "GeoCoordinates", + "latitude": 51.88805, + "longitude": 0.90286 + } +} +``` **Providing information about the organiser** And finally, we need to include information about the person or organisation responsible for running the event. With this it’s important to note that personal data must not be published as open data without consent. Whilst events could be organised by a club, led by a particular individual, or include other named participants of note, we’ll keep it simple for this first example and just use a club. As always, further detail is available in the [spec](https://www.openactive.io/modelling-opportunity-data/#describing-organisers-code-schema-person-code-and-code-schema-organization-code-) if needed. -| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT1H", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | -| :--- | - +```text +{ + "@context": "https://openactive.io/", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list +" + }], + "startDate": "2018-08-13T20:00:00Z", + "endDate": "2018-08-13T21:00:00Z", + "duration": "PT1H", + "location": { + "type": "Place", + "name": "ExampleCo Gym", + "address": { + "type": "PostalAddress", + "streetAddress": "1 High Street", + "addressLocality": "Colchester", + "addressRegion": "Essex", + "postalCode": "AB1 2CD", + "addressCountry": "GB" + }, + "geo": { + "type": "GeoCoordinates", + "latitude": 51.88805, + "longitude": 0.90286 + } + }, + "organizer": { + "name": "Colchester Bladers", + "type": "Organization", + "url": "https://www.examplecluburl.com" + } + } +``` And that’s it! Here we have a valid event described according to the OpenActive opportunity data model. You’re able to double-check that you’ve got everything entered correctly by pasting your code into the [OpenActive data validator tool](https://validator.openactive.io/), or jump to [this pre-populated example](https://validator.openactive.io/?url=https%3A%2F%2Fwww.openactive.io%2Fdata-models%2Fversions%2F2.x%2Fexamples%2Ftutorials%2Fdescribing-events%2Fpart-one-finished.json&version=2.0). diff --git a/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-two-adding-additional-detail.md b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-two-adding-additional-detail.md index 45b349bd..e1edfb54 100644 --- a/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-two-adding-additional-detail.md +++ b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-two-adding-additional-detail.md @@ -15,9 +15,49 @@ This tutorial will cover: As a reminder, here’s our starting point from the previous tutorial: -| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "startDate": "2018-08-13T20:00:00Z", "endDate": "2018-08-13T21:00:00Z", "duration": "PT1H", "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | -| :--- | - +```text +{ + "@context": "https://openactive.io/", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list +" + }], + "startDate": "2018-08-13T20:00:00Z", + "endDate": "2018-08-13T21:00:00Z", + "duration": "PT1H", + "location": { + "type": "Place", + "name": "ExampleCo Gym", + "address": { + "type": "PostalAddress", + "streetAddress": "1 High Street", + "addressLocality": "Colchester", + "addressRegion": "Essex", + "postalCode": "AB1 2CD", + "addressCountry": "GB" + }, + "geo": { + "type": "GeoCoordinates", + "latitude": 51.88805, + "longitude": 0.90286 + } + }, + "organizer": { + "name": "Colchester Bladers", + "type": "Organization", + "url": "https://www.examplecluburl.com" + } + } +``` ## **1. Modelling recurring events** @@ -28,9 +68,61 @@ In the below example you’ll see that we’ve removed the previously used **sta We’ve also explicitly stated the **startTime**, **endTime**, and **duration**, and the same logic applies to these as we discussed previously. -| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | -| :--- | - +```text +{ + "@context": "https://openactive.io/", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list +" + }], + "eventSchedule": [ + { + "type": "Schedule", + "startDate": "2018-08-13", + "endDate": "2020-08-13", + "duration": "PT1H", + "repeatFrequency": "P1W", + "byDay": [ + "https://schema.org/Thursday" + ], + "startTime": "20:00", + "endTime": "21:00", + "scheduledEventType": "ScheduledSession" + } + ], +"location": { + "type": "Place", + "name": "ExampleCo Gym", + "address": { + "type": "PostalAddress", + "streetAddress": "1 High Street", + "addressLocality": "Colchester", + "addressRegion": "Essex", + "postalCode": "AB1 2CD", + "addressCountry": "GB" + }, + "geo": { + "type": "GeoCoordinates", + "latitude": 51.88805, + "longitude": 0.90286 + } + }, + "organizer": { + "name": "Colchester Bladers", + "type": "Organization", + "url": "https://www.examplecluburl.com" + } + } +``` ## **2. Adding a description** @@ -47,9 +139,62 @@ If an event is listed on the web there's probably already a description of some Let’s add in our description. It’s important to note that the order of properties is not important, but you may want to consider logical groupings for human readability. We’ve added it under the name and URL for this reason. -| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | -| :--- | - +```text +{ + "@context": "https://openactive.io/", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list +" + }], + "eventSchedule": [ + { + "type": "Schedule", + "startDate": "2018-08-13", + "endDate": "2020-08-13", + "duration": "PT1H", + "repeatFrequency": "P1W", + "byDay": [ + "https://schema.org/Thursday" + ], + "startTime": "20:00", + "endTime": "21:00", + "scheduledEventType": "ScheduledSession" + } + ], +"location": { + "type": "Place", + "name": "ExampleCo Gym", + "address": { + "type": "PostalAddress", + "streetAddress": "1 High Street", + "addressLocality": "Colchester", + "addressRegion": "Essex", + "postalCode": "AB1 2CD", + "addressCountry": "GB" + }, + "geo": { + "type": "GeoCoordinates", + "latitude": 51.88805, + "longitude": 0.90286 + } + }, + "organizer": { + "name": "Colchester Bladers", + "type": "Organization", + "url": "https://www.examplecluburl.com" + } + } +``` ## **3. Enhancing with images** @@ -57,9 +202,73 @@ Another element that can encourage participation is the inclusion of imagery. It Let’s add a large image and a smaller thumbnail option under our new description. -| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", "image": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_large.jpg", "thumbnail": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_thumbnail.jpg" } \] }\], "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | -| :--- | - +```text +{ + "@context": "https://openactive.io/", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", + "image": [ + { + "type": "ImageObject", + "url": "https://example.com/static/image/yourimage_large.jpg", + "thumbnail": [ + { + "type": "ImageObject", + "url": "https://example.com/static/image/yourimage_thumbnail.jpg" + } + ] + }], + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list +" + }], + "eventSchedule": [ + { + "type": "Schedule", + "startDate": "2018-08-13", + "endDate": "2020-08-13", + "duration": "PT1H", + "repeatFrequency": "P1W", + "byDay": [ + "https://schema.org/Thursday" + ], + "startTime": "20:00", + "endTime": "21:00", + "scheduledEventType": "ScheduledSession" + } + ], +"location": { + "type": "Place", + "name": "ExampleCo Gym", + "address": { + "type": "PostalAddress", + "streetAddress": "1 High Street", + "addressLocality": "Colchester", + "addressRegion": "Essex", + "postalCode": "AB1 2CD", + "addressCountry": "GB" + }, + "geo": { + "type": "GeoCoordinates", + "latitude": 51.88805, + "longitude": 0.90286 + } + }, + "organizer": { + "name": "Colchester Bladers", + "type": "Organization", + "url": "https://www.examplecluburl.com" + } + } +``` ## **4. Defining whether an activity is part of a wider programme** @@ -67,9 +276,79 @@ As well as having our opportunity repeat, we may have activities that are part o In our fictional example let’s assume this is the case, and add in an association with a Programme. In its most basic form, we can do this by using the new property programme and adding the required details as follows: -| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", "image": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_large.jpg", "thumbnail": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_thumbnail.jpg" } \] }\], "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "programme": { "type": "Brand", "name": "BladeFitness™️", "url": "https://www.exampleorgbody.org/blade-fitness/", "description": "A programme of events to encourage participation and get fit through roller blading" }, "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" } }** | -| :--- | - +```text +{ + "@context": "https://openactive.io/", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", + "image": [ + { + "type": "ImageObject", + "url": "https://example.com/static/image/yourimage_large.jpg", + "thumbnail": [ + { + "type": "ImageObject", + "url": "https://example.com/static/image/yourimage_thumbnail.jpg" + } + ] + }], + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list +" + }], + "eventSchedule": [ + { + "type": "Schedule", + "startDate": "2018-08-13", + "endDate": "2020-08-13", + "duration": "PT1H", + "repeatFrequency": "P1W", + "byDay": [ + "https://schema.org/Thursday" + ], + "startTime": "20:00", + "endTime": "21:00", + "scheduledEventType": "ScheduledSession" + } + ], + "programme": { + "type": "Brand", + "name": "BladeFitness™️", + "url": "https://www.exampleorgbody.org/blade-fitness/", + "description": "A programme of events to encourage participation and get fit through roller blading" + }, + "location": { + "type": "Place", + "name": "ExampleCo Gym", + "address": { + "type": "PostalAddress", + "streetAddress": "1 High Street", + "addressLocality": "Colchester", + "addressRegion": "Essex", + "postalCode": "AB1 2CD", + "addressCountry": "GB" + }, + "geo": { + "type": "GeoCoordinates", + "latitude": 51.88805, + "longitude": 0.90286 + } + }, + "organizer": { + "name": "Colchester Bladers", + "type": "Organization", + "url": "https://www.examplecluburl.com" + } + } +``` Here, we’ve added the name of the programme, a link to further detail about it, and a short description. @@ -90,9 +369,87 @@ When you come to writing your own suitability criteria it’s recommended that y For our example let’s explicitly state that this is a session for adults, with no gender restriction, at an intermediate level. -| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", "image": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_large.jpg", "thumbnail": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_thumbnail.jpg" } \] }\], "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "programme": { "type": "Brand", "name": "BladeFitness™️", "url": "https://www.exampleorgbody.org/blade-fitness/", "description": "A programme of events to encourage participation and get fit through roller blading" }, "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" }, "ageRange": { "type": "QuantitativeValue", "minValue": 18 }, "genderRestriction": "https://openactive.io/NoRestriction", "level": \[ "intermediate" \] }** | -| :--- | - +```text +{ + "@context": "https://openactive.io/", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", + "image": [ + { + "type": "ImageObject", + "url": "https://example.com/static/image/yourimage_large.jpg", + "thumbnail": [ + { + "type": "ImageObject", + "url": "https://example.com/static/image/yourimage_thumbnail.jpg" + } + ] + }], + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list +" + }], + "eventSchedule": [ + { + "type": "Schedule", + "startDate": "2018-08-13", + "endDate": "2020-08-13", + "duration": "PT1H", + "repeatFrequency": "P1W", + "byDay": [ + "https://schema.org/Thursday" + ], + "startTime": "20:00", + "endTime": "21:00", + "scheduledEventType": "ScheduledSession" + } + ], + "programme": { + "type": "Brand", + "name": "BladeFitness™️", + "url": "https://www.exampleorgbody.org/blade-fitness/", + "description": "A programme of events to encourage participation and get fit through roller blading" + }, + "location": { + "type": "Place", + "name": "ExampleCo Gym", + "address": { + "type": "PostalAddress", + "streetAddress": "1 High Street", + "addressLocality": "Colchester", + "addressRegion": "Essex", + "postalCode": "AB1 2CD", + "addressCountry": "GB" + }, + "geo": { + "type": "GeoCoordinates", + "latitude": 51.88805, + "longitude": 0.90286 + } + }, + "organizer": { + "name": "Colchester Bladers", + "type": "Organization", + "url": "https://www.examplecluburl.com" + }, + "ageRange": { + "type": "QuantitativeValue", + "minValue": 18 + }, + "genderRestriction": "https://openactive.io/NoRestriction", + "level": [ + "intermediate" + ] +} +``` ## **6. Adding offers** @@ -100,11 +457,95 @@ Some opportunities are freely available for anyone to attend, but where particip In our final amendment to this example, we’ll add some detail that shows our class has an individual cost of £10 per session. -| **{ "@context": "https://openactive.io/", "type": "Event", "name": "Blade and tone", "url": "http://www.example.org/events/1", "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", "image": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_large.jpg", "thumbnail": \[ { "type": "ImageObject", "url": "https://example.com/static/image/yourimage\_thumbnail.jpg" } \] }\], "activity": \[{ "id":"**[**https://openactive.io/activity-list/\#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3**](https://www.openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3)**", "type": "Concept", "prefLabel": "Roller blading", "inScheme": "**[**https://openactive.io/activity-list**](https://www.openactive.io/activity-list/activity-list.jsonld)**" }\], "eventSchedule": \[ { "type": "Schedule", "startDate": "2018-08-13", "endDate": "2020-08-13", "duration": "PT1H", "repeatFrequency": "P1W", "byDay": \[ "https://schema.org/Thursday" \], "startTime": "20:00", "endTime": "21:00", "scheduledEventType": "ScheduledSession" } \], "programme": { "type": "Brand", "name": "BladeFitness™️", "url": "https://www.exampleorgbody.org/blade-fitness/", "description": "A programme of events to encourage participation and get fit through roller blading" }, "location": { "type": "Place", "name": "ExampleCo Gym", "address": { "type": "PostalAddress", "streetAddress": "1 High Street", "addressLocality": "Colchester", "addressRegion": "Essex", "postalCode": "AB1 2CD", "addressCountry": "GB" }, "geo": { "type": "GeoCoordinates", "latitude": 51.88805, "longitude": 0.90286 } }, "organizer": { "name": "Colchester Bladers", "type": "Organization", "url": "https://www.examplecluburl.com" }, "ageRange": { "type": "QuantitativeValue", "minValue": 18 }, "genderRestriction": "https://openactive.io/NoRestriction", "level": \[ "intermediate" \], "offers": \[{ "type": "Offer", "name": "Single session", "price": 10, "priceCurrency": "GBP" }\] }** | -| :--- | - - -**As in the previous tutorial we can check that this validates by either copying and pasting the above code into the** [**validation tool**](https://validator.openactive.io)**, or using** [**this pre-populated link**](https://validator.openactive.io/?url=https%3A%2F%2Fwww.openactive.io%2Fdata-models%2Fversions%2F2.x%2Fexamples%2Ftutorials%2Fdescribing-events%2Fpart-two-finished.json&version=2.0)**.** +```text +{ + "@context": "https://openactive.io/", + "type": "Event", + "name": "Blade and tone", + "url": "http://www.example.org/events/1", + "description": "Run by our head instructor, this is an intermediate class for those with existing roller blading experience, where we focus on exercises to tone key muscle groups. Bring your own boots, shape up, and have fun!", + "image": [ + { + "type": "ImageObject", + "url": "https://example.com/static/image/yourimage_large.jpg", + "thumbnail": [ + { + "type": "ImageObject", + "url": "https://example.com/static/image/yourimage_thumbnail.jpg" + } + ] + }], + "activity": [{ + "id":" +https://openactive.io/activity-list/#7e5cb3ee-8c91-4f85-8c97-e335e0013eb3 +", + "type": "Concept", + "prefLabel": "Roller blading", + "inScheme": " +https://openactive.io/activity-list +" + }], + "eventSchedule": [ + { + "type": "Schedule", + "startDate": "2018-08-13", + "endDate": "2020-08-13", + "duration": "PT1H", + "repeatFrequency": "P1W", + "byDay": [ + "https://schema.org/Thursday" + ], + "startTime": "20:00", + "endTime": "21:00", + "scheduledEventType": "ScheduledSession" + } + ], + "programme": { + "type": "Brand", + "name": "BladeFitness™️", + "url": "https://www.exampleorgbody.org/blade-fitness/", + "description": "A programme of events to encourage participation and get fit through roller blading" + }, + "location": { + "type": "Place", + "name": "ExampleCo Gym", + "address": { + "type": "PostalAddress", + "streetAddress": "1 High Street", + "addressLocality": "Colchester", + "addressRegion": "Essex", + "postalCode": "AB1 2CD", + "addressCountry": "GB" + }, + "geo": { + "type": "GeoCoordinates", + "latitude": 51.88805, + "longitude": 0.90286 + } + }, + "organizer": { + "name": "Colchester Bladers", + "type": "Organization", + "url": "https://www.examplecluburl.com" + }, + "ageRange": { + "type": "QuantitativeValue", + "minValue": 18 + }, + "genderRestriction": "https://openactive.io/NoRestriction", + "level": [ + "intermediate" + ], + "offers": [{ + "type": "Offer", + "name": "Single session", + "price": 10, + "priceCurrency": "GBP" + }] +} +``` + +As in the previous tutorial we can check that this validates by either copying and pasting the above code into the [validation tool](https://validator.openactive.io), or using [this pre-populated link](https://validator.openactive.io/?url=https%3A%2F%2Fwww.openactive.io%2Fdata-models%2Fversions%2F2.x%2Fexamples%2Ftutorials%2Fdescribing-events%2Fpart-two-finished.json&version=2.0). ## **7. Where to go next** diff --git a/docs/data-model/types/action.md b/docs/data-model/types/action.md index 6a2d7d3c..69ab11b0 100644 --- a/docs/data-model/types/action.md +++ b/docs/data-model/types/action.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Action" + Text + Must always be present and set to "type": "Action"
name - Text + name + Text -

The name of the action


Example

"name": "Book"

+

The name of the action

+

+
Example +

+

"name": "Book" +

target - EntryPoint + target + EntryPoint -

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}

+

A definition of the target of the action.

+

+
Example +

+

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/babychanging.md b/docs/data-model/types/babychanging.md index afddc50c..96aacca1 100644 --- a/docs/data-model/types/babychanging.md +++ b/docs/data-model/types/babychanging.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "BabyChanging" + Text + Must always be present and set to "type": "BabyChanging"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Baby Changing Facilities"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Baby Changing Facilities" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/brand.md b/docs/data-model/types/brand.md index 80615e68..c4584376 100644 --- a/docs/data-model/types/brand.md +++ b/docs/data-model/types/brand.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), ## **Fields** ### **Required fields** - + @@ -20,38 +20,44 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Brand" + Text + Must always be present and set to "type": "Brand"
name - Text + name + Text -

The name of the brand.


Example

"name": "Play Ball!"

+

The name of the brand.

+

+
Example +

+

"name": "Play Ball!" +

url - url + url + url -

A url where further information can be found for the brand.


Example

"url": "http://example.com/play_ball"

+

A url where further information can be found for the brand.

+

+
Example +

+

"url": "http://example.com/play_ball" +

- +### **Recommended fields** -### **Recommended fields** - @@ -62,29 +68,36 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - + -
description - Text + description + Text -

A text description for the brand.


Example

"description": "Play Ball! is a series of games for people of all abilities."

+

A text description for the brand.

+

+
Example +

+

"description": "Play Ball! is a series of games for people of all abilities." +

logo - ImageObject + logo + ImageObject -

The logo associated with the brand.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

The logo associated with the brand.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

- +### **Optional fields** -### **Optional fields** - @@ -95,15 +108,26 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + -
identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "BR1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "BR1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/changingfacilities.md b/docs/data-model/types/changingfacilities.md index 2b65ac39..c6a201ef 100644 --- a/docs/data-model/types/changingfacilities.md +++ b/docs/data-model/types/changingfacilities.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "ChangingFacilities" + Text + Must always be present and set to "type": "ChangingFacilities"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Changing Rooms"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Changing Rooms" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/concept.md b/docs/data-model/types/concept.md index 367ffb27..8fe8e544 100644 --- a/docs/data-model/types/concept.md +++ b/docs/data-model/types/concept.md @@ -4,12 +4,12 @@ description: This page describes the Concept type. # Concept -This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://www.w3.org/2004/02/skos/core#Concept). +This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http://www.w3.org/2004/02/skos/core#Concept). ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - - + - - + -
type - Text + type - Must always be present and set to "type": "Concept" + Text + Must always be present and set to "type": "Concept"
prefLabel - Text + prefLabel + Text -

A human readable string for use in user interfaces.


Example

"prefLabel": "Speedball"

+

A human readable string for use in user interfaces.

+

+
Example +

+

"prefLabel": "Speedball" +

+### **Recommended fields** - -### **Recommended fields** - @@ -53,29 +54,36 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/concept/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/concept/12345" +

inScheme - url + inScheme + url -

A stable URL reference for the taxonomy.


Example

"inScheme": "https://example.com/reference/activities"

+

A stable URL reference for the taxonomy.

+

+
Example +

+

"inScheme": "https://example.com/reference/activities" +

+### **Optional fields** - -### **Optional fields** - @@ -86,42 +94,60 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - + - - + - - + - - + -
altLabel - Array of Text + altLabel + Array of Text -

An alternative human readable string for use in user interfaces.


Example

"altLabel": "Speedball"

+

An alternative human readable string for use in user interfaces.

+

+
Example +

+

"altLabel": "Speedball" +

broader - Array of url + broader + Array of url -

A broader Concept URI


Example

"broader": "https://example.com/football"

+

A broader Concept URI

+

+
Example +

+

"broader": "https://example.com/football" +

narrower - Array of url + narrower + Array of url -

A more specific concept URI


Example

"narrower": "https://example.com/walking-football"

+

A more specific concept URI

+

+
Example +

+

"narrower": "https://example.com/walking-football" +

notation - Text + notation + Text -

A concept label that is not normally recognisable as natural language.


Example

"notation": "Speedball"

+

A concept label that is not normally recognisable as natural language.

+

+
Example +

+

"notation": "Speedball" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/conceptscheme.md b/docs/data-model/types/conceptscheme.md index d3acfe5e..aa531e69 100644 --- a/docs/data-model/types/conceptscheme.md +++ b/docs/data-model/types/conceptscheme.md @@ -4,12 +4,12 @@ description: This page describes the ConceptScheme type. # ConceptScheme -This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). +This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). ## **Fields** ### **Required fields** - + @@ -20,56 +20,73 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](ht - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ConceptScheme" + Text + Must always be present and set to "type": "ConceptScheme"
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/scheme/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/scheme/12345" +

concept - Array of Concept + concept + Array of Concept -

A collection of concepts that are part of this scheme


Example

"concept": [
  {
    "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"
  }
]

+

A collection of concepts that are part of this scheme

+

+
Example +

+

"concept": [
{
"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"
}
] +

title - Text + title + Text -

The title of the scheme


Example

"title": "Activity List"

+

The title of the scheme

+

+
Example +

+

"title": "Activity List" +

url - url + url + url -

A URL to a web page (or section of a page) that describes the concept scheme.


Example

"url": "https://example.com/scheme/1234"

+

A URL to a web page (or section of a page) that describes the concept + scheme.

+

+
Example +

+

"url": "https://example.com/scheme/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,24 +97,32 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](ht - - + - - + -
description - Text + description + Text -

A free text description of the taxonomy


Example

"description": "An example activity list."

+

A free text description of the taxonomy

+

+
Example +

+

"description": "An example activity list." +

license - url + license + url -

Reference to the license under which the activity list has been published.


Example

"license": "https://example.com/license/MIT"

+

Reference to the license under which the activity list has been published.

+

+
Example +

+

"license": "https://example.com/license/MIT" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/courseinstance.md b/docs/data-model/types/courseinstance.md index 47459544..ca23b1bc 100644 --- a/docs/data-model/types/courseinstance.md +++ b/docs/data-model/types/courseinstance.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe ## **Fields** ### **Required fields** - + @@ -20,73 +20,112 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe - - - + - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "CourseInstance" + Text + Must always be present and set to "type": "CourseInstance"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional in the specification, a data publisher must provide either a `startDate` or specify an `eventSchedule` for an event. @@ -100,29 +139,40 @@ While these properties are marked as optional in the specification, a data publi - startDate - - DateTime
- or -
Date + startDate + + DateTime +
- or - +
Date -

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

- - +### **Recommended fields** -### **Recommended fields** - @@ -133,119 +183,197 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Optional fields** -### **Optional fields** - @@ -256,159 +384,259 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/creche.md b/docs/data-model/types/creche.md index 2ee2db11..1023ec78 100644 --- a/docs/data-model/types/creche.md +++ b/docs/data-model/types/creche.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Creche" + Text + Must always be present and set to "type": "Creche"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Childcare"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Childcare" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/entrypoint.md b/docs/data-model/types/entrypoint.md index 960e3c97..e487be2c 100644 --- a/docs/data-model/types/entrypoint.md +++ b/docs/data-model/types/entrypoint.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent ## **Fields** ### **Required fields** - + @@ -20,42 +20,49 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent - - - + - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "EntryPoint" + Text + Must always be present and set to "type": "EntryPoint"
encodingType - Text + encodingType - Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json" + Text + Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json"
httpMethod - Text + httpMethod + Text -

An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.


Example

"httpMethod": "POST"

+

An HTTP method that specifies the appropriate HTTP method for a request + to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.

+

+
Example +

+

"httpMethod": "POST" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

URL of the item


Example

"urlTemplate": "https://example.com/orders{/var}"

+

URL of the item

+

+
Example +

+

"urlTemplate": "https://example.com/orders{/var}" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/event.md b/docs/data-model/types/event.md index 4c4108c7..babd168a 100644 --- a/docs/data-model/types/event.md +++ b/docs/data-model/types/event.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,73 +20,112 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Event" + Text + Must always be present and set to "type": "Event"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional in the specification, a data publisher must provide either a `startDate` or specify an `eventSchedule` for an event. @@ -100,29 +139,40 @@ While these properties are marked as optional in the specification, a data publi - startDate - - DateTime
- or -
Date + startDate + + DateTime +
- or - +
Date -

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

- - +### **Recommended fields** -### **Recommended fields** - @@ -133,119 +183,197 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Optional fields** -### **Optional fields** - @@ -256,159 +384,259 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/eventseries.md b/docs/data-model/types/eventseries.md index 8ec56a3e..f6e48b0b 100644 --- a/docs/data-model/types/eventseries.md +++ b/docs/data-model/types/eventseries.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi ## **Fields** ### **Required fields** - + @@ -20,56 +20,77 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "EventSeries" + Text + Must always be present and set to "type": "EventSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,110 +101,175 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

+### **Optional fields** - -### **Optional fields** - @@ -194,186 +280,317 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/facilityuse.md b/docs/data-model/types/facilityuse.md index a0d843b4..f7887176 100644 --- a/docs/data-model/types/facilityuse.md +++ b/docs/data-model/types/facilityuse.md @@ -4,12 +4,10 @@ description: This page describes the FacilityUse type. # FacilityUse - - ## **Fields** ### **Required fields** - + @@ -20,65 +18,87 @@ description: This page describes the FacilityUse type. - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "FacilityUse" + Text + Must always be present and set to "type": "FacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + a facility use.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the facility use will take place.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the facility use


Example

"name": "Speedball"

+

The name of the facility use

+

+
Example +

+

"name": "Speedball" +

provider - + provider -

The organisation responsible for providing the facility


Example

"provider": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The organisation responsible for providing the facility

+

+
Example +

+

"provider": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"

+

A URL to a web page (or section of a page) that describes the facility + use.

+

+
Example +

+

"url": "https://example.com/facility-use/1234" +

+### **Recommended fields** - -### **Recommended fields** - @@ -89,65 +109,86 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/facility-use/112345" +

description - Text + description + Text -

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the facility use

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

event - Array of Slot + event + Array of Slot -

An array of slots of availability of this FacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 3,
    "maximumUses": 6
  }
]

+

An array of slots of availability of this FacilityUse.

+

+
Example +

+

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 3,
"maximumUses": 6
}
] +

hoursAvailable - Array of OpeningHoursSpecification + hoursAvailable -

The times the facility use is available

+ 		Array of OpeningHoursSpecification The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the facility use, e.g. a photo taken at + a previous event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

- +### **Optional fields** -### **Optional fields** - @@ -158,78 +199,136 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."

+

Provides additional notes and instructions for users of a facility. E.g. + more information on how to find it, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]

+

Provides a set of tags that help categorise and describe a facility.

+

+
Example +

+

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

individualFacilityUse - Array of IndividualFacilityUse + individualFacilityUse + Array of IndividualFacilityUse -

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court).


Example

"individualFacilityUse": [
  {
    "type": "IndividualFacilityUse",
    "id": "http://www.example.org/facility-uses/1",
    "name": "Tennis Court 1"
  }
]

+

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse + (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse + (e.g. an opportunity to play tennis on a specific court).

+

+
Example +

+

"individualFacilityUse": [
{
"type": "IndividualFacilityUse",
"id": "http://www.example.org/facility-uses/1",
"name": "Tennis Court 1"
}
] +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

- - + \ No newline at end of file diff --git a/docs/data-model/types/geocoordinates.md b/docs/data-model/types/geocoordinates.md index 8d98bd79..279b2904 100644 --- a/docs/data-model/types/geocoordinates.md +++ b/docs/data-model/types/geocoordinates.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "GeoCoordinates" + Text + Must always be present and set to "type": "GeoCoordinates"
latitude - Float + latitude + Float -

The latitude of a location. For example 51.522338 (WGS 84).


Example

"latitude": 51.522338

+

The latitude of a location. For example 51.522338 (WGS 84).

+

+
Example +

+

"latitude": 51.522338 +

longitude - Float + longitude + Float -

The longitude of a location. For example -0.083437 (WGS 84).


Example

"longitude": -0.083437

+

The longitude of a location. For example -0.083437 (WGS 84).

+

+
Example +

+

"longitude": -0.083437 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/headlineevent.md b/docs/data-model/types/headlineevent.md index 2a62b521..97c60edb 100644 --- a/docs/data-model/types/headlineevent.md +++ b/docs/data-model/types/headlineevent.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,74 +20,116 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "HeadlineEvent" + Text + Must always be present and set to "type": "HeadlineEvent"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -98,119 +140,194 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

+### **Optional fields** - -### **Optional fields** - @@ -221,150 +338,244 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/imageobject.md b/docs/data-model/types/imageobject.md index cdbb0626..3d0cafa7 100644 --- a/docs/data-model/types/imageobject.md +++ b/docs/data-model/types/imageobject.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im ## **Fields** ### **Required fields** - + @@ -20,48 +20,31 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im - - - - - - - - - - -
type - Text + type - Must always be present and set to "type": "ImageObject" + Text
url - url + Must always be present and set to "type": "ImageObject" -

The URL for the display resolution image.


Example

"url": "http://example.com/static/image/speedball_large.jpg"

-
- - -### **Optional fields** - - - - - - - - - - - + -
PropertyExpected TypeDescription
thumbnail - Array of ImageObject + url + url -

The URL for a thumbnail image for an image.

+

The URL for the display resolution image.

+

+
Example +

+

"url": "http://example.com/static/image/speedball_large.jpg" +

+### **Optional fields** +| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **thumbnail** | Array of [`ImageObject`](https://docs.openactive.io/data-model/types/imageobject) | The URL for a thumbnail image for an image. | diff --git a/docs/data-model/types/individualfacilityuse.md b/docs/data-model/types/individualfacilityuse.md index bbab228a..28c8a1ef 100644 --- a/docs/data-model/types/individualfacilityuse.md +++ b/docs/data-model/types/individualfacilityuse.md @@ -4,12 +4,10 @@ description: This page describes the IndividualFacilityUse type. # IndividualFacilityUse - - ## **Fields** ### **Required fields** - + @@ -20,65 +18,87 @@ description: This page describes the IndividualFacilityUse type. - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "IndividualFacilityUse" + Text + Must always be present and set to "type": "IndividualFacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + a facility use.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the facility use will take place.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the facility use


Example

"name": "Speedball"

+

The name of the facility use

+

+
Example +

+

"name": "Speedball" +

provider - + provider -

The organisation responsible for providing the facility


Example

"provider": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The organisation responsible for providing the facility

+

+
Example +

+

"provider": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"

+

A URL to a web page (or section of a page) that describes the facility + use.

+

+
Example +

+

"url": "https://example.com/facility-use/1234" +

+### **Recommended fields** - -### **Recommended fields** - @@ -89,65 +109,81 @@ description: This page describes the IndividualFacilityUse type. - - + - - - + - - + - - + - - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/facility-use/112345" +

aggregateFacilityUse - FacilityUse + aggregateFacilityUse -

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location).

+ 		FacilityUse Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse + (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse + (e.g. an opportunity to play tennis at a specific location).
description - Text + description + Text -

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the facility use

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

event - Array of Slot + event + Array of Slot -

An array of slots of availability of this IndividualFacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 0,
    "maximumUses": 1
  }
]

+

An array of slots of availability of this IndividualFacilityUse.

+

+
Example +

+

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 0,
"maximumUses": 1
}
] +

hoursAvailable - Array of OpeningHoursSpecification + hoursAvailable -

The times the facility use is available

+ 		Array of OpeningHoursSpecification The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the facility use, e.g. a photo taken at + a previous event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

- +### **Optional fields** -### **Optional fields** - @@ -158,78 +194,134 @@ description: This page describes the IndividualFacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."

+

Provides additional notes and instructions for users of a facility. E.g. + more information on how to find it, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]

+

Provides a set of tags that help categorise and describe a facility.

+

+
Example +

+

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

- - + \ No newline at end of file diff --git a/docs/data-model/types/locationfeaturespecification.md b/docs/data-model/types/locationfeaturespecification.md index 6962df6d..1b719113 100644 --- a/docs/data-model/types/locationfeaturespecification.md +++ b/docs/data-model/types/locationfeaturespecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "LocationFeatureSpecification" + Text + Must always be present and set to "type": "LocationFeatureSpecification"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Bike Shed"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Bike Shed" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/lockers.md b/docs/data-model/types/lockers.md index ad1972ce..6db45ee7 100644 --- a/docs/data-model/types/lockers.md +++ b/docs/data-model/types/lockers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Lockers" + Text + Must always be present and set to "type": "Lockers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Indoor Lockers"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Indoor Lockers" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/offer.md b/docs/data-model/types/offer.md index 3c608cdc..54853835 100644 --- a/docs/data-model/types/offer.md +++ b/docs/data-model/types/offer.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), ## **Fields** ### **Required fields** - + @@ -20,29 +20,33 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - - + - - + -
type - Text + type - Must always be present and set to "type": "Offer" + Text + Must always be present and set to "type": "Offer"
price - Float + price + Float -

The offer price of the activity.

This price should be specified without currency symbols and as a floating point number with two decimal places.

The currency of the price should be expressed in the priceCurrency field.


Example

"price": 33

+

The offer price of the activity.

+

This price should be specified without currency symbols and as a floating + point number with two decimal places.

+

The currency of the price should be expressed in the priceCurrency field.

+

+
Example +

+

"price": 33 +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,56 +57,82 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/offer/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/offer/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

name - Text + name + Text -

A human readable name for the offer.


Example

"name": "Speedball winger position"

+

A human readable name for the offer.

+

+
Example +

+

"name": "Speedball winger position" +

priceCurrency - Text + priceCurrency + Text -

The currency (in 3-letter ISO 4217 format) of the price.

If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified.


Example

"priceCurrency": "GBP"

+

The currency (in 3-letter ISO 4217 format) of the price.

+

If an Offer has a zero price, then this property is not required. Otherwise + the currency must be specified.

+

+
Example +

+

"priceCurrency": "GBP" +

url - url + url + url -

URL describing the offer


Example

"url": "http://www.rphs.org.uk/"

+

URL describing the offer

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- +### **Optional fields** -### **Optional fields** - @@ -113,33 +143,56 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + + - - + -
advanceBooking - RequiredStatusType + advanceBooking + RequiredStatusType -

Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either.


Example

"advanceBooking": "https://openactive.io/Required"

+

Indicates whether to accept this offer, a participant must book in advance, + whether they must pay on attending, or have option to do either.

+

+
Example +

+

"advanceBooking": "https://openactive.io/Required" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

prepayment - RequiredStatusType + prepayment + RequiredStatusType -

Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either.


Example

"prepayment": "https://openactive.io/Required"

+

Indicates whether to accept this offer, a participant must pay in advance, + pay when attending, or have the option to do either.

+

+
Example +

+

"prepayment": "https://openactive.io/Required" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/openinghoursspecification.md b/docs/data-model/types/openinghoursspecification.md index 1340d446..bf25b3da 100644 --- a/docs/data-model/types/openinghoursspecification.md +++ b/docs/data-model/types/openinghoursspecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ ## **Fields** ### **Required fields** - + @@ -20,42 +20,54 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ - - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "OpeningHoursSpecification" + Text + Must always be present and set to "type": "OpeningHoursSpecification"
closes - Time + closes + Time -

The closing time.


Example

"closes": "17:00"

+

The closing time.

+

+
Example +

+

"closes": "17:00" +

dayOfWeek - DayOfWeek + dayOfWeek + DayOfWeek -

Defines the day of the week upon which the Place is open


Example

"dayOfWeek": "https://schema.org/Monday"

+

Defines the day of the week upon which the Place is open

+

+
Example +

+

"dayOfWeek": "https://schema.org/Monday" +

opens - Time + opens + Time -

The opening time.


Example

"opens": "09:00"

+

The opening time.

+

+
Example +

+

"opens": "09:00" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/organization.md b/docs/data-model/types/organization.md index 2c7ef789..52c565df 100644 --- a/docs/data-model/types/organization.md +++ b/docs/data-model/types/organization.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - - + - - + -
type - Text + type - Must always be present and set to "type": "Organization" + Text + Must always be present and set to "type": "Organization"
name - Text + name + Text -

The name of the Organization


Example

"name": "Central Speedball Association"

+

The name of the Organization

+

+
Example +

+

"name": "Central Speedball Association" +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,47 +54,65 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/organization/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/organization/12345" +

sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated with the organization.


Example

"sameAs": [
  "https://www.facebook.com/everyoneactive/",
  "https://twitter.com/everyoneactive"
]

+

Lists the URL(s) of the official social media profile pages associated + with the organization.

+

+
Example +

+

"sameAs": [
"https://www.facebook.com/everyoneactive/",
"https://twitter.com/everyoneactive"
] +

telephone - Text + telephone + Text -

The telephone number of the Organization


Example

"telephone": "01234 567890"

+

The telephone number of the Organization

+

+
Example +

+

"telephone": "01234 567890" +

url - url + url + url -

A definitive canonical URL for the Organization.


Example

"url": "http://www.speedball-world.com"

+

A definitive canonical URL for the Organization.

+

+
Example +

+

"url": "http://www.speedball-world.com" +

- +### **Optional fields** -### **Optional fields** - @@ -104,33 +123,54 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + + - - + -
description - Text + description + Text -

The description of the Organization


Example

"description": "The national governing body of cycling"

+

The description of the Organization

+

+
Example +

+

"description": "The national governing body of cycling" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

logo - ImageObject + logo + ImageObject -

A logo for the Organization.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

A logo for the Organization.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/parking.md b/docs/data-model/types/parking.md index 1d5b05bd..d18ce763 100644 --- a/docs/data-model/types/parking.md +++ b/docs/data-model/types/parking.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Parking" + Text + Must always be present and set to "type": "Parking"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Roadside Parking"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Roadside Parking" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/partialschedule.md b/docs/data-model/types/partialschedule.md index 852a2ca8..b8cc1d8c 100644 --- a/docs/data-model/types/partialschedule.md +++ b/docs/data-model/types/partialschedule.md @@ -9,31 +9,13 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "PartialSchedule" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "PartialSchedule"` | ### **Recommended fields** - + @@ -44,38 +26,51 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + -
endTime - Time + endTime + Time -

The end time of the event.


Example

"endTime": "12:00:00"

+

The end time of the event.

+

+
Example +

+

"endTime": "12:00:00" +

repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

startTime - Time + startTime + Time -

The start time of the event.


Example

"startTime": "12:00:00"

+

The start time of the event.

+

+
Example +

+

"startTime": "12:00:00" +

- +### **Optional fields** -### **Optional fields** - @@ -86,105 +81,172 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek
- or -
Array of Text + 		byDay + Array of DayOfWeek +
- or - +
Array of Text 		-

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - Date + endDate + Date -

The end date of the schedule.


Example

"endDate": "2018-01-27"

+

The end date of the schedule.

+

+
Example +

+

"endDate": "2018-01-27" +

exceptDate - Array of Date
- or -
Array of DateTime + 		exceptDate + Array of Date +
- or - +
Array of DateTime 		-

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]

+

Exception dates where the schedule should not generate an event.

+

+
Example +

+

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] +

idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + identifier (@id) for every event described by the schedule (see below for + more information). This property is required if the data provider is supporting + third-party booking via the Open Booking API.

+

+
Example +

+

"idTemplate": "https://example.com/event{/id}" +

repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3

+

Defines the number of times a recurring Event will take place.

+

+
Example +

+

"repeatCount": 3 +

scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.


Example

"scheduledEventType": "Event"

+

The type of event this schedule related to.

+

+
Example +

+

"scheduledEventType": "Event" +

startDate - Date + startDate + Date -

The start date of the event.


Example

"startDate": "2018-01-27"

+

The start date of the event.

+

+
Example +

+

"startDate": "2018-01-27" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + URL (schema:url) for every event described by the schedule (see below for + more information). This property is required if the data provider wants + to provide participants with a unique URL to book to attend an event.

+

+
Example +

+

"urlTemplate": "https://example.com/event{/id}" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/person.md b/docs/data-model/types/person.md index 9c59018e..032f9e42 100644 --- a/docs/data-model/types/person.md +++ b/docs/data-model/types/person.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "Person" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "Person"` | ### **Recommended fields** - + @@ -44,20 +26,22 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/person/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/person/12345" +

+### **Optional fields** - -### **Optional fields** - @@ -68,69 +52,113 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + - - - + + - - + - - + - - + - - + - - + -
description - Text + description + Text -

The description of the Person


Example

"description": "The leader of the coaching team"

+

The description of the Person

+

+
Example +

+

"description": "The leader of the coaching team" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

logo - ImageObject + logo + ImageObject -

A logo for the person.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

A logo for the person.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

name - Text + name + Text -

A full name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"name": "Daley Thompson"

+

A full name for the person.

+

This person must give direct permission for their personal information + to be shared as part of the Open Data.

+

+
Example +

+

"name": "Daley Thompson" +

sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated with the person.


Example

"sameAs": "https://example.org/example-org"

+

Lists the URL(s) of the official social media profile pages associated + with the person.

+

+
Example +

+

"sameAs": "https://example.org/example-org" +

telephone - Text + telephone + Text -

The telephone number of the person


Example

"telephone": "01234 567890"

+

The telephone number of the person

+

+
Example +

+

"telephone": "01234 567890" +

url - url + url + url -

A URL where more information about the person may be found


Example

"url": "http://www.example.com/"

+

A URL where more information about the person may be found

+

+
Example +

+

"url": "http://www.example.com/" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/place.md b/docs/data-model/types/place.md index 17beda2e..ebb91aca 100644 --- a/docs/data-model/types/place.md +++ b/docs/data-model/types/place.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), ## **Fields** ### **Required fields** - + @@ -20,28 +20,29 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - - + - - + -
type - Text + type - Must always be present and set to "type": "Place" + Text + Must always be present and set to "type": "Place"
name - Text + name + Text -

The name of the Place


Example

"name": "Raynes Park High School"

+

The name of the Place

+

+
Example +

+

"name": "Raynes Park High School" +

- - -### ** Required options ** +### **Required options** While these properties are marked as recommended in the specification, a data publisher must provide as much detail in both `address` and `geo` for an event as possible. @@ -55,29 +56,42 @@ While these properties are marked as recommended in the specification, a data pu - address - - PostalAddress
- or -
Text + address + + PostalAddress +
- or - +
Text -

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

- geo - - GeoCoordinates + geo + + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

- - +### **Recommended fields** -### **Recommended fields** - @@ -88,74 +102,100 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/place/12345" +

amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]

+

An array listing the Ammenities of the Place.

+

+
Example +

+

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] +

description - Text + description + Text -

The description of the Place


Example

"description": "Raynes Park High School in London"

+

The description of the Place

+

+
Example +

+

"description": "Raynes Park High School in London" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the place, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

openingHoursSpecification - Array of OpeningHoursSpecification + openingHoursSpecification -

The times the Place is open

+ 		Array of OpeningHoursSpecification The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place


Example

"telephone": "01253 473934"

+

The telephone number for the Place

+

+
Example +

+

"telephone": "01253 473934" +

url - url + url + url -

The website for the Place


Example

"url": "http://www.rphs.org.uk/"

+

The website for the Place

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- +### **Optional fields** -### **Optional fields** - @@ -166,51 +206,88 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - - - + + -
address - PostalAddress
- or -
Text + 		address + PostalAddress +
- or - +
Text 		-

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

containedInPlace - Place + containedInPlace + Place -

The place within which this Place exists


Example

"containedInPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
  "name": "Middlesbrough Sports Village"
}

+

The place within which this Place exists

+

+
Example +

+

"containedInPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
"name": "Middlesbrough Sports Village"
} +

containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}

+

Places that exist within this place

+

+
Example +

+

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} +

geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/postaladdress.md b/docs/data-model/types/postaladdress.md index 5b57322a..29028dc7 100644 --- a/docs/data-model/types/postaladdress.md +++ b/docs/data-model/types/postaladdress.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,60 +20,82 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "PostalAddress" + Text + Must always be present and set to "type": "PostalAddress"
addressCountry - Text + addressCountry + Text -

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.


Example

"addressCountry": "GB"

+

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.

+

+
Example +

+

"addressCountry": "GB" +

addressLocality - Text + addressLocality + Text -

The locality, a suburb within a city or a town within a county or district.


Example

"addressLocality": "Shoreditch"

+

The locality, a suburb within a city or a town within a county or district.

+

+
Example +

+

"addressLocality": "Shoreditch" +

addressRegion - Text + addressRegion + Text -

The region, either a city or a county or district.


Example

"addressRegion": "London"

+

The region, either a city or a county or district.

+

+
Example +

+

"addressRegion": "London" +

postalCode - Text + postalCode + Text -

The postal code.


Example

"postalCode": "EC2A 4JE"

+

The postal code.

+

+
Example +

+

"postalCode": "EC2A 4JE" +

streetAddress - Text + streetAddress + Text -

The street address.


Example

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St"

+

The street address.

+

+
Example +

+

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/propertyvalue.md b/docs/data-model/types/propertyvalue.md index 6719f4bb..24b8f082 100644 --- a/docs/data-model/types/propertyvalue.md +++ b/docs/data-model/types/propertyvalue.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,38 +20,46 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "PropertyValue" + Text + Must always be present and set to "type": "PropertyValue"
name - Text + name + Text -

The name of this PropertyValue


Example

"name": "Vendor ID"

+

The name of this PropertyValue

+

+
Example +

+

"name": "Vendor ID" +

value - Text
- or -
Integer + 		value + Text +
- or - +
Integer 		-

The actual value of this identifier


Example

"value": "SB1234"

+

The actual value of this identifier

+

+
Example +

+

"value": "SB1234" +

- +### **Optional fields** -### **Optional fields** - @@ -62,15 +70,20 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + -
propertyID - url
- or -
Text + 		propertyID + url +
- or - +
Text 		-

A commonly used identifier for the characteristic represented by the property


Example

"propertyID": "ActivePlaces"

+

A commonly used identifier for the characteristic represented by the property

+

+
Example +

+

"propertyID": "ActivePlaces" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/quantitativevalue.md b/docs/data-model/types/quantitativevalue.md index 28f57819..86fd4b4b 100644 --- a/docs/data-model/types/quantitativevalue.md +++ b/docs/data-model/types/quantitativevalue.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "QuantitativeValue" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "QuantitativeValue"` | ### **Optional fields** - + @@ -44,24 +26,32 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. - - + - - + -
maxValue - Integer + maxValue + Integer -

The maximum value.


Example

"maxValue": 60

+

The maximum value.

+

+
Example +

+

"maxValue": 60 +

minValue - Integer + minValue + Integer -

The minimum value.


Example

"minValue": 16

+

The minimum value.

+

+
Example +

+

"minValue": 16 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/reserveaction.md b/docs/data-model/types/reserveaction.md index ad053fdd..24dbfc4d 100644 --- a/docs/data-model/types/reserveaction.md +++ b/docs/data-model/types/reserveaction.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ReserveAction" + Text + Must always be present and set to "type": "ReserveAction"
name - Text + name + Text -

The name of the action


Example

"name": "Book"

+

The name of the action

+

+
Example +

+

"name": "Book" +

target - EntryPoint + target + EntryPoint -

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}

+

A definition of the target of the action.

+

+
Example +

+

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/schedule.md b/docs/data-model/types/schedule.md index 77c89bd8..beb09f7c 100644 --- a/docs/data-model/types/schedule.md +++ b/docs/data-model/types/schedule.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - + @@ -20,46 +20,57 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Schedule" + Text + Must always be present and set to "type": "Schedule"
endTime - Time + endTime + Time -

The end time of the event.


Example

"endTime": "12:00:00"

+

The end time of the event.

+

+
Example +

+

"endTime": "12:00:00" +

scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.


Example

"scheduledEventType": "Event"

+

The type of event this schedule related to.

+

+
Example +

+

"scheduledEventType": "Event" +

startTime - Time + startTime + Time -

The start time of the event.


Example

"startTime": "12:00:00"

+

The start time of the event.

+

+
Example +

+

"startTime": "12:00:00" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional, a data publisher must provide either a `byDay`, `byMonth`, `byMonthDay` or `repeatFrequency` for a schedule. @@ -73,47 +84,71 @@ While these properties are marked as optional, a data publisher must provide eit - byDay - - Array of DayOfWeek
- or -
Array of Text + byDay + + Array of DayOfWeek +
- or - +
Array of Text -

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

- byMonth - - Array of Integer + byMonth + + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

- byMonthDay - - Array of Integer + byMonthDay + + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

- repeatFrequency - - Duration + repeatFrequency + + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

- - +### **Recommended fields** -### **Recommended fields** - @@ -124,56 +159,84 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - Date + endDate + Date -

The end date of the schedule.


Example

"endDate": "2018-01-27"

+

The end date of the schedule.

+

+
Example +

+

"endDate": "2018-01-27" +

idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + identifier (@id) for every event described by the schedule (see below for + more information). This property is required if the data provider is supporting + third-party booking via the Open Booking API.

+

+
Example +

+

"idTemplate": "https://example.com/event{/id}" +

startDate - Date + startDate + Date -

The start date of the event.


Example

"startDate": "2018-01-27"

+

The start date of the event.

+

+
Example +

+

"startDate": "2018-01-27" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + URL (schema:url) for every event described by the schedule (see below for + more information). This property is required if the data provider wants + to provide participants with a unique URL to book to attend an event.

+

+
Example +

+

"urlTemplate": "https://example.com/event{/id}" +

- +### **Optional fields** -### **Optional fields** - @@ -184,60 +247,97 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek
- or -
Array of Text + 		byDay + Array of DayOfWeek +
- or - +
Array of Text 		-

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

exceptDate - Array of Date
- or -
Array of DateTime + 		exceptDate + Array of Date +
- or - +
Array of DateTime 		-

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]

+

Exception dates where the schedule should not generate an event.

+

+
Example +

+

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] +

repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3

+

Defines the number of times a recurring Event will take place.

+

+
Example +

+

"repeatCount": 3 +

repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/scheduledsession.md b/docs/data-model/types/scheduledsession.md index 6c219234..fe1b4ec1 100644 --- a/docs/data-model/types/scheduledsession.md +++ b/docs/data-model/types/scheduledsession.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,56 +20,84 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ScheduledSession" + Text + Must always be present and set to "type": "ScheduledSession"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,83 +108,129 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Optional fields** -### **Optional fields** - @@ -167,195 +241,332 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/sessionseries.md b/docs/data-model/types/sessionseries.md index d75d43b4..c074952f 100644 --- a/docs/data-model/types/sessionseries.md +++ b/docs/data-model/types/sessionseries.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,74 +20,113 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "SessionSeries" + Text + Must always be present and set to "type": "SessionSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -98,74 +137,118 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

- +### **Optional fields** -### **Optional fields** - @@ -176,195 +259,324 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

subEvent - Array of ScheduledSession + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of ScheduledSession Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/showers.md b/docs/data-model/types/showers.md index 33f60e9c..2f7579e1 100644 --- a/docs/data-model/types/showers.md +++ b/docs/data-model/types/showers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Showers" + Text + Must always be present and set to "type": "Showers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Poolside Showers"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Poolside Showers" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/slot.md b/docs/data-model/types/slot.md index 1e0e4c96..ab9af02c 100644 --- a/docs/data-model/types/slot.md +++ b/docs/data-model/types/slot.md @@ -4,12 +4,10 @@ description: This page describes the Slot type. # Slot - - ## **Fields** ### **Required fields** - + @@ -20,64 +18,89 @@ description: This page describes the Slot type. - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Slot" + Text + Must always be present and set to "type": "Slot"
duration - Duration + duration + Duration -

The duration of the slot given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the slot given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

facilityUse - url + facilityUse + url -

URI to the FacilityUse that has this offer


Example

"facilityUse": "https://example.com/facility-use/1"

+

URI to the FacilityUse that has this offer

+

+
Example +

+

"facilityUse": "https://example.com/facility-use/1" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

remainingUses - Integer + remainingUses + Integer -

The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"remainingUses": 5

+

The remaining available courts or pitches at this time. Must be 0 or 1 + for an IndividualFacilityUse.

+

+
Example +

+

"remainingUses": 5 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the slot. Can be specified as a schema:Date or schema:DateTime


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the slot. Can be specified as a schema:Date + or schema:DateTime

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional/recommended in the Modelling Specification, one of these must be provided when surfacing a slot through an RPDE feed to ensure that the slots can be processed correctly by data consumers. @@ -91,29 +114,44 @@ While these properties are marked as optional/recommended in the Modelling Speci - id - - url + id + + url -

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/slot/12345" +

- identifier - - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + identifier + + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer -

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- +### **Recommended fields** - -### **Recommended fields** - @@ -124,29 +162,37 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/slot/12345" +

maximumUses - Integer + maximumUses + Integer -

The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"maximumUses": 16

+

The maximum available courts or pitches at this time. Must be 0 or 1 for + an IndividualFacilityUse.

+

+
Example +

+

"maximumUses": 16 +

- +### **Optional fields** -### **Optional fields** - @@ -157,24 +203,45 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the slot. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an slot.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the slot. Can be specified as a schema:Date or + schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an slot.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/sportsactivitylocation.md b/docs/data-model/types/sportsactivitylocation.md index 8aeb6e17..9ba98a91 100644 --- a/docs/data-model/types/sportsactivitylocation.md +++ b/docs/data-model/types/sportsactivitylocation.md @@ -9,30 +9,12 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "SportsActivityLocation" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "SportsActivityLocation"` | -### ** Required options ** +### **Required options** While these properties are marked as recommended in the specification, a data publisher must provide as much detail in both `address` and `geo` for an event as possible. @@ -46,29 +28,42 @@ While these properties are marked as recommended in the specification, a data pu - address - - PostalAddress
- or -
Text + address + + PostalAddress +
- or - +
Text -

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

- geo - - GeoCoordinates + geo + + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

- +### **Recommended fields** - -### **Recommended fields** - @@ -79,20 +74,22 @@ While these properties are marked as recommended in the specification, a data pu - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/place/12345" +

+### **Optional fields** - -### **Optional fields** - @@ -103,114 +100,184 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - - + - - + - - - + + - - + - - + - - - + - - + - - + -
address - PostalAddress
- or -
Text + 		address + PostalAddress +
- or - +
Text 		-

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]

+

An array listing the Ammenities of the Place.

+

+
Example +

+

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] +

containedInPlace - Place
- or -
url + 		containedInPlace + Place +
- or - +
url 		-

While a url is not specified as an option in the Modelling Specification, it is necessary to link entities in RPDE.


Example

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d"

+

While a url is not specified as an option in the Modelling + Specification, it is necessary to link entities in RPDE.

+

+
Example +

+

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d" +

containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}

+

Places that exist within this place

+

+
Example +

+

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} +

description - Text + description + Text -

The description of the Place


Example

"description": "Raynes Park High School in London"

+

The description of the Place

+

+
Example +

+

"description": "Raynes Park High School in London" +

geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the place, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

name - Text + name + Text -

The name of the Place


Example

"name": "Raynes Park High School"

+

The name of the Place

+

+
Example +

+

"name": "Raynes Park High School" +

openingHoursSpecification - Array of OpeningHoursSpecification + openingHoursSpecification -

The times the Place is open

+ 		Array of OpeningHoursSpecification The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place


Example

"telephone": "01253 473934"

+

The telephone number for the Place

+

+
Example +

+

"telephone": "01253 473934" +

url - url + url + url -

The website for the Place


Example

"url": "http://www.rphs.org.uk/"

+

The website for the Place

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/toilets.md b/docs/data-model/types/toilets.md index f5248106..f8e164c9 100644 --- a/docs/data-model/types/toilets.md +++ b/docs/data-model/types/toilets.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Toilets" + Text + Must always be present and set to "type": "Toilets"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Public Toilets"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Public Toilets" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/towels.md b/docs/data-model/types/towels.md index 063eb9c0..14fb351e 100644 --- a/docs/data-model/types/towels.md +++ b/docs/data-model/types/towels.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Towels" + Text + Must always be present and set to "type": "Towels"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Complementary Towels"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Complementary Towels" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file From 1e7770c98eaab48ef5f2d936fb94c639be0f5efb Mon Sep 17 00:00:00 2001 From: Travis CI Date: Thu, 25 Oct 2018 15:25:41 +0000 Subject: [PATCH 08/10] Updating auto-generated model documentation: 79 [ci skip] --- docs/data-model/types/action.md | 41 +- docs/data-model/types/babychanging.md | 36 +- docs/data-model/types/brand.md | 98 ++- docs/data-model/types/changingfacilities.md | 36 +- docs/data-model/types/concept.md | 118 ++-- docs/data-model/types/conceptscheme.md | 101 ++-- docs/data-model/types/courseinstance.md | 570 ++++++------------ docs/data-model/types/creche.md | 36 +- docs/data-model/types/entrypoint.md | 51 +- docs/data-model/types/event.md | 570 ++++++------------ docs/data-model/types/eventseries.md | 535 +++++----------- docs/data-model/types/facilityuse.md | 295 +++------ docs/data-model/types/geocoordinates.md | 41 +- docs/data-model/types/headlineevent.md | 521 +++++----------- docs/data-model/types/imageobject.md | 51 +- .../data-model/types/individualfacilityuse.md | 290 +++------ .../types/locationfeaturespecification.md | 36 +- docs/data-model/types/lockers.md | 36 +- docs/data-model/types/offer.md | 163 ++--- .../types/openinghoursspecification.md | 54 +- docs/data-model/types/organization.md | 142 ++--- docs/data-model/types/parking.md | 36 +- docs/data-model/types/partialschedule.md | 232 +++---- docs/data-model/types/person.md | 154 ++--- docs/data-model/types/place.md | 245 +++----- docs/data-model/types/postaladdress.md | 80 +-- docs/data-model/types/propertyvalue.md | 63 +- docs/data-model/types/quantitativevalue.md | 56 +- docs/data-model/types/reserveaction.md | 41 +- docs/data-model/types/schedule.md | 286 +++------ docs/data-model/types/scheduledsession.md | 511 +++++----------- docs/data-model/types/sessionseries.md | 522 +++++----------- docs/data-model/types/showers.md | 36 +- docs/data-model/types/slot.md | 201 ++---- .../types/sportsactivitylocation.md | 259 +++----- docs/data-model/types/toilets.md | 36 +- docs/data-model/types/towels.md | 36 +- 37 files changed, 2250 insertions(+), 4365 deletions(-) diff --git a/docs/data-model/types/action.md b/docs/data-model/types/action.md index 69ab11b0..6a2d7d3c 100644 --- a/docs/data-model/types/action.md +++ b/docs/data-model/types/action.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Action" + + Must always be present and set to "type": "Action"
name - Text + name + Text -

The name of the action

-

-
Example -

-

"name": "Book" -

+

The name of the action


Example

"name": "Book"
target - EntryPoint + target + EntryPoint -

A definition of the target of the action.

-

-
Example -

-

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} -

+

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/babychanging.md b/docs/data-model/types/babychanging.md index 96aacca1..afddc50c 100644 --- a/docs/data-model/types/babychanging.md +++ b/docs/data-model/types/babychanging.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "BabyChanging" + + Must always be present and set to "type": "BabyChanging"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Baby Changing Facilities" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Baby Changing Facilities"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/brand.md b/docs/data-model/types/brand.md index c4584376..80615e68 100644 --- a/docs/data-model/types/brand.md +++ b/docs/data-model/types/brand.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), ## **Fields** ### **Required fields** - + @@ -20,44 +20,38 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Brand" + + Must always be present and set to "type": "Brand"
name - Text + name + Text -

The name of the brand.

-

-
Example -

-

"name": "Play Ball!" -

+

The name of the brand.


Example

"name": "Play Ball!"
url - url + url + url -

A url where further information can be found for the brand.

-

-
Example -

-

"url": "http://example.com/play_ball" -

+

A url where further information can be found for the brand.


Example

"url": "http://example.com/play_ball"
### **Recommended fields** + + +### **Recommended fields** + @@ -68,36 +62,29 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - + -
description - Text + description + Text -

A text description for the brand.

-

-
Example -

-

"description": "Play Ball! is a series of games for people of all abilities." -

+

A text description for the brand.


Example

"description": "Play Ball! is a series of games for people of all abilities."
logo - ImageObject + logo + ImageObject -

The logo associated with the brand.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

The logo associated with the brand.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
### **Optional fields** + + +### **Optional fields** + @@ -108,26 +95,15 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + -
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "BR1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "BR1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/changingfacilities.md b/docs/data-model/types/changingfacilities.md index c6a201ef..2b65ac39 100644 --- a/docs/data-model/types/changingfacilities.md +++ b/docs/data-model/types/changingfacilities.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "ChangingFacilities" + + Must always be present and set to "type": "ChangingFacilities"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Changing Rooms" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Changing Rooms"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/concept.md b/docs/data-model/types/concept.md index 8fe8e544..367ffb27 100644 --- a/docs/data-model/types/concept.md +++ b/docs/data-model/types/concept.md @@ -4,12 +4,12 @@ description: This page describes the Concept type. # Concept -This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http://www.w3.org/2004/02/skos/core#Concept). +This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://www.w3.org/2004/02/skos/core#Concept). ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Concept" + + Must always be present and set to "type": "Concept"
prefLabel - Text + prefLabel + Text -

A human readable string for use in user interfaces.

-

-
Example -

-

"prefLabel": "Speedball" -

+

A human readable string for use in user interfaces.


Example

"prefLabel": "Speedball"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,36 +53,29 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/concept/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/concept/12345"
inScheme - url + inScheme + url -

A stable URL reference for the taxonomy.

-

-
Example -

-

"inScheme": "https://example.com/reference/activities" -

+

A stable URL reference for the taxonomy.


Example

"inScheme": "https://example.com/reference/activities"
### **Optional fields** + + +### **Optional fields** + @@ -94,60 +86,42 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - + - - + - - + -
altLabel - Array of Text + altLabel + Array of Text -

An alternative human readable string for use in user interfaces.

-

-
Example -

-

"altLabel": "Speedball" -

+

An alternative human readable string for use in user interfaces.


Example

"altLabel": "Speedball"
broader - Array of url + broader + Array of url -

A broader Concept URI

-

-
Example -

-

"broader": "https://example.com/football" -

+

A broader Concept URI


Example

"broader": "https://example.com/football"
narrower - Array of url + narrower + Array of url -

A more specific concept URI

-

-
Example -

-

"narrower": "https://example.com/walking-football" -

+

A more specific concept URI


Example

"narrower": "https://example.com/walking-football"
notation - Text + notation + Text -

A concept label that is not normally recognisable as natural language.

-

-
Example -

-

"notation": "Speedball" -

+

A concept label that is not normally recognisable as natural language.


Example

"notation": "Speedball"
\ No newline at end of file + + + diff --git a/docs/data-model/types/conceptscheme.md b/docs/data-model/types/conceptscheme.md index aa531e69..d3acfe5e 100644 --- a/docs/data-model/types/conceptscheme.md +++ b/docs/data-model/types/conceptscheme.md @@ -4,12 +4,12 @@ description: This page describes the ConceptScheme type. # ConceptScheme -This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). +This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). ## **Fields** ### **Required fields** - + @@ -20,73 +20,56 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](h - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ConceptScheme" + + Must always be present and set to "type": "ConceptScheme"
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/scheme/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/scheme/12345"
concept - Array of Concept + concept + Array of Concept -

A collection of concepts that are part of this scheme

-

-
Example -

-

"concept": [
{
"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"
}
] -

+

A collection of concepts that are part of this scheme


Example

"concept": [
  {
    "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"
  }
]
title - Text + title + Text -

The title of the scheme

-

-
Example -

-

"title": "Activity List" -

+

The title of the scheme


Example

"title": "Activity List"
url - url + url + url -

A URL to a web page (or section of a page) that describes the concept - scheme.

-

-
Example -

-

"url": "https://example.com/scheme/1234" -

+

A URL to a web page (or section of a page) that describes the concept scheme.


Example

"url": "https://example.com/scheme/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -97,32 +80,24 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](h - - + - - + -
description - Text + description + Text -

A free text description of the taxonomy

-

-
Example -

-

"description": "An example activity list." -

+

A free text description of the taxonomy


Example

"description": "An example activity list."
license - url + license + url -

Reference to the license under which the activity list has been published.

-

-
Example -

-

"license": "https://example.com/license/MIT" -

+

Reference to the license under which the activity list has been published.


Example

"license": "https://example.com/license/MIT"
\ No newline at end of file + + + diff --git a/docs/data-model/types/courseinstance.md b/docs/data-model/types/courseinstance.md index ca23b1bc..47459544 100644 --- a/docs/data-model/types/courseinstance.md +++ b/docs/data-model/types/courseinstance.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe ## **Fields** ### **Required fields** - + @@ -20,112 +20,73 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe - - + - - - + - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "CourseInstance" + + Must always be present and set to "type": "CourseInstance"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional in the specification, a data publisher must provide either a `startDate` or specify an `eventSchedule` for an event. @@ -139,40 +100,29 @@ While these properties are marked as optional in the specification, a data publi - startDate - - DateTime -
- or - -
Date + startDate + + DateTime
- or -
Date -

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

-### **Recommended fields** + + +### **Recommended fields** + @@ -183,197 +133,119 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Optional fields** + + +### **Optional fields** + @@ -384,259 +256,159 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/creche.md b/docs/data-model/types/creche.md index 1023ec78..2ee2db11 100644 --- a/docs/data-model/types/creche.md +++ b/docs/data-model/types/creche.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Creche" + + Must always be present and set to "type": "Creche"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Childcare" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Childcare"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/entrypoint.md b/docs/data-model/types/entrypoint.md index e487be2c..960e3c97 100644 --- a/docs/data-model/types/entrypoint.md +++ b/docs/data-model/types/entrypoint.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent ## **Fields** ### **Required fields** - + @@ -20,49 +20,42 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent - - + - - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "EntryPoint" + + Must always be present and set to "type": "EntryPoint"
encodingType - Text + encodingType + Text Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json" + + Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json"
httpMethod - Text + httpMethod + Text -

An HTTP method that specifies the appropriate HTTP method for a request - to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.

-

-
Example -

-

"httpMethod": "POST" -

+

An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.


Example

"httpMethod": "POST"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

URL of the item

-

-
Example -

-

"urlTemplate": "https://example.com/orders{/var}" -

+

URL of the item


Example

"urlTemplate": "https://example.com/orders{/var}"
\ No newline at end of file + + + diff --git a/docs/data-model/types/event.md b/docs/data-model/types/event.md index babd168a..4c4108c7 100644 --- a/docs/data-model/types/event.md +++ b/docs/data-model/types/event.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,112 +20,73 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Event" + + Must always be present and set to "type": "Event"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional in the specification, a data publisher must provide either a `startDate` or specify an `eventSchedule` for an event. @@ -139,40 +100,29 @@ While these properties are marked as optional in the specification, a data publi - startDate - - DateTime -
- or - -
Date + startDate + + DateTime
- or -
Date -

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

-### **Recommended fields** + + +### **Recommended fields** + @@ -183,197 +133,119 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Optional fields** + + +### **Optional fields** + @@ -384,259 +256,159 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/eventseries.md b/docs/data-model/types/eventseries.md index f6e48b0b..8ec56a3e 100644 --- a/docs/data-model/types/eventseries.md +++ b/docs/data-model/types/eventseries.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi ## **Fields** ### **Required fields** - + @@ -20,77 +20,56 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "EventSeries" + + Must always be present and set to "type": "EventSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -101,175 +80,110 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
### **Optional fields** + + +### **Optional fields** + @@ -280,317 +194,186 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/facilityuse.md b/docs/data-model/types/facilityuse.md index f7887176..a0d843b4 100644 --- a/docs/data-model/types/facilityuse.md +++ b/docs/data-model/types/facilityuse.md @@ -4,10 +4,12 @@ description: This page describes the FacilityUse type. # FacilityUse + + ## **Fields** ### **Required fields** - + @@ -18,87 +20,65 @@ description: This page describes the FacilityUse type. - - + - - - + - - + - - + - + - - - + -
type - Text + type + Text Must always be present and set to "type": "FacilityUse" + + Must always be present and set to "type": "FacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - a facility use.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the facility use will take place.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the facility use

-

-
Example -

-

"name": "Speedball" -

+

The name of the facility use


Example

"name": "Speedball"
provider + provider + -

The organisation responsible for providing the facility

-

-
Example -

-

"provider": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The organisation responsible for providing the facility


Example

"provider": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility - use.

-

-
Example -

-

"url": "https://example.com/facility-use/1234" -

+

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -109,86 +89,65 @@ description: This page describes the FacilityUse type. - - + - - + - - + - + - - - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/facility-use/112345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"
description - Text + description + Text -

A free text description of the facility use

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."
event - Array of Slot + event + Array of Slot -

An array of slots of availability of this FacilityUse.

-

-
Example -

-

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 3,
"maximumUses": 6
}
] -

+

An array of slots of availability of this FacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 3,
    "maximumUses": 6
  }
]
hoursAvailable + hoursAvailable + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the facility use is available

The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at - a previous event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
### **Optional fields** + + +### **Optional fields** + @@ -199,136 +158,78 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. - more information on how to find it, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." -

+

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.

-

-
Example -

-

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] -

+

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
individualFacilityUse - Array of IndividualFacilityUse + individualFacilityUse + Array of IndividualFacilityUse -

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse - (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse - (e.g. an opportunity to play tennis on a specific court).

-

-
Example -

-

"individualFacilityUse": [
{
"type": "IndividualFacilityUse",
"id": "http://www.example.org/facility-uses/1",
"name": "Tennis Court 1"
}
] -

+

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court).


Example

"individualFacilityUse": [
  {
    "type": "IndividualFacilityUse",
    "id": "http://www.example.org/facility-uses/1",
    "name": "Tennis Court 1"
  }
]
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
\ No newline at end of file + + + diff --git a/docs/data-model/types/geocoordinates.md b/docs/data-model/types/geocoordinates.md index 279b2904..8d98bd79 100644 --- a/docs/data-model/types/geocoordinates.md +++ b/docs/data-model/types/geocoordinates.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "GeoCoordinates" + + Must always be present and set to "type": "GeoCoordinates"
latitude - Float + latitude + Float -

The latitude of a location. For example 51.522338 (WGS 84).

-

-
Example -

-

"latitude": 51.522338 -

+

The latitude of a location. For example 51.522338 (WGS 84).


Example

"latitude": 51.522338
longitude - Float + longitude + Float -

The longitude of a location. For example -0.083437 (WGS 84).

-

-
Example -

-

"longitude": -0.083437 -

+

The longitude of a location. For example -0.083437 (WGS 84).


Example

"longitude": -0.083437
\ No newline at end of file + + + diff --git a/docs/data-model/types/headlineevent.md b/docs/data-model/types/headlineevent.md index 97c60edb..2a62b521 100644 --- a/docs/data-model/types/headlineevent.md +++ b/docs/data-model/types/headlineevent.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,116 +20,74 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "HeadlineEvent" + + Must always be present and set to "type": "HeadlineEvent"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -140,194 +98,119 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
### **Optional fields** + + +### **Optional fields** + @@ -338,244 +221,150 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/imageobject.md b/docs/data-model/types/imageobject.md index 3d0cafa7..cdbb0626 100644 --- a/docs/data-model/types/imageobject.md +++ b/docs/data-model/types/imageobject.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im ## **Fields** ### **Required fields** - + @@ -20,31 +20,48 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im - - + - - + - + + +
type - Text + type + Text Must always be present and set to "type": "ImageObject" + + Must always be present and set to "type": "ImageObject"
url + url + url url + +

The URL for the display resolution image.


Example

"url": "http://example.com/static/image/speedball_large.jpg"

+
+ + +### **Optional fields** + + + + + + + + + + + + + -
PropertyExpected TypeDescription
thumbnail + Array of ImageObject -

The URL for the display resolution image.

-

-
Example -

-

"url": "http://example.com/static/image/speedball_large.jpg" -

+

The URL for a thumbnail image for an image.
### **Optional fields** + -| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **thumbnail** | Array of [`ImageObject`](https://docs.openactive.io/data-model/types/imageobject) | The URL for a thumbnail image for an image. | diff --git a/docs/data-model/types/individualfacilityuse.md b/docs/data-model/types/individualfacilityuse.md index 28c8a1ef..bbab228a 100644 --- a/docs/data-model/types/individualfacilityuse.md +++ b/docs/data-model/types/individualfacilityuse.md @@ -4,10 +4,12 @@ description: This page describes the IndividualFacilityUse type. # IndividualFacilityUse + + ## **Fields** ### **Required fields** - + @@ -18,87 +20,65 @@ description: This page describes the IndividualFacilityUse type. - - + - - - + - - + - - + - + - - - + -
type - Text + type + Text Must always be present and set to "type": "IndividualFacilityUse" + + Must always be present and set to "type": "IndividualFacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - a facility use.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the facility use will take place.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the facility use

-

-
Example -

-

"name": "Speedball" -

+

The name of the facility use


Example

"name": "Speedball"
provider + provider + -

The organisation responsible for providing the facility

-

-
Example -

-

"provider": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The organisation responsible for providing the facility


Example

"provider": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility - use.

-

-
Example -

-

"url": "https://example.com/facility-use/1234" -

+

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -109,81 +89,65 @@ description: This page describes the IndividualFacilityUse type. - - + - + - - - - + - - + - + - - - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/facility-use/112345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"
aggregateFacilityUse + aggregateFacilityUse + FacilityUse FacilityUse + +

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location).

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse - (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse - (e.g. an opportunity to play tennis at a specific location).
description - Text + description + Text -

A free text description of the facility use

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."
event - Array of Slot + event + Array of Slot -

An array of slots of availability of this IndividualFacilityUse.

-

-
Example -

-

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 0,
"maximumUses": 1
}
] -

+

An array of slots of availability of this IndividualFacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 0,
    "maximumUses": 1
  }
]
hoursAvailable + hoursAvailable + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the facility use is available

The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at - a previous event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
### **Optional fields** + + +### **Optional fields** + @@ -194,134 +158,78 @@ description: This page describes the IndividualFacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. - more information on how to find it, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." -

+

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.

-

-
Example -

-

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] -

+

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
\ No newline at end of file + + + diff --git a/docs/data-model/types/locationfeaturespecification.md b/docs/data-model/types/locationfeaturespecification.md index 1b719113..6962df6d 100644 --- a/docs/data-model/types/locationfeaturespecification.md +++ b/docs/data-model/types/locationfeaturespecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "LocationFeatureSpecification" + + Must always be present and set to "type": "LocationFeatureSpecification"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Bike Shed" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Bike Shed"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/lockers.md b/docs/data-model/types/lockers.md index 6db45ee7..ad1972ce 100644 --- a/docs/data-model/types/lockers.md +++ b/docs/data-model/types/lockers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Lockers" + + Must always be present and set to "type": "Lockers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Indoor Lockers" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Indoor Lockers"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/offer.md b/docs/data-model/types/offer.md index 54853835..3c608cdc 100644 --- a/docs/data-model/types/offer.md +++ b/docs/data-model/types/offer.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), ## **Fields** ### **Required fields** - + @@ -20,33 +20,29 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Offer" + + Must always be present and set to "type": "Offer"
price - Float + price + Float -

The offer price of the activity.

-

This price should be specified without currency symbols and as a floating - point number with two decimal places.

-

The currency of the price should be expressed in the priceCurrency field.

-

-
Example -

-

"price": 33 -

+

The offer price of the activity.

This price should be specified without currency symbols and as a floating point number with two decimal places.

The currency of the price should be expressed in the priceCurrency field.


Example

"price": 33
### **Recommended fields** + + +### **Recommended fields** + @@ -57,82 +53,56 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/offer/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/offer/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
name - Text + name + Text -

A human readable name for the offer.

-

-
Example -

-

"name": "Speedball winger position" -

+

A human readable name for the offer.


Example

"name": "Speedball winger position"
priceCurrency - Text + priceCurrency + Text -

The currency (in 3-letter ISO 4217 format) of the price.

-

If an Offer has a zero price, then this property is not required. Otherwise - the currency must be specified.

-

-
Example -

-

"priceCurrency": "GBP" -

+

The currency (in 3-letter ISO 4217 format) of the price.

If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified.


Example

"priceCurrency": "GBP"
url - url + url + url -

URL describing the offer

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

URL describing the offer


Example

"url": "http://www.rphs.org.uk/"
### **Optional fields** + + +### **Optional fields** + @@ -143,56 +113,33 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + + - - + -
advanceBooking - RequiredStatusType + advanceBooking + RequiredStatusType -

Indicates whether to accept this offer, a participant must book in advance, - whether they must pay on attending, or have option to do either.

-

-
Example -

-

"advanceBooking": "https://openactive.io/Required" -

+

Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either.


Example

"advanceBooking": "https://openactive.io/Required"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
prepayment - RequiredStatusType + prepayment + RequiredStatusType -

Indicates whether to accept this offer, a participant must pay in advance, - pay when attending, or have the option to do either.

-

-
Example -

-

"prepayment": "https://openactive.io/Required" -

+

Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either.


Example

"prepayment": "https://openactive.io/Required"
\ No newline at end of file + + + diff --git a/docs/data-model/types/openinghoursspecification.md b/docs/data-model/types/openinghoursspecification.md index bf25b3da..1340d446 100644 --- a/docs/data-model/types/openinghoursspecification.md +++ b/docs/data-model/types/openinghoursspecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ ## **Fields** ### **Required fields** - + @@ -20,54 +20,42 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ - - + - - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "OpeningHoursSpecification" + + Must always be present and set to "type": "OpeningHoursSpecification"
closes - Time + closes + Time -

The closing time.

-

-
Example -

-

"closes": "17:00" -

+

The closing time.


Example

"closes": "17:00"
dayOfWeek - DayOfWeek + dayOfWeek + DayOfWeek -

Defines the day of the week upon which the Place is open

-

-
Example -

-

"dayOfWeek": "https://schema.org/Monday" -

+

Defines the day of the week upon which the Place is open


Example

"dayOfWeek": "https://schema.org/Monday"
opens - Time + opens + Time -

The opening time.

-

-
Example -

-

"opens": "09:00" -

+

The opening time.


Example

"opens": "09:00"
\ No newline at end of file + + + diff --git a/docs/data-model/types/organization.md b/docs/data-model/types/organization.md index 52c565df..2c7ef789 100644 --- a/docs/data-model/types/organization.md +++ b/docs/data-model/types/organization.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Organization" + + Must always be present and set to "type": "Organization"
name - Text + name + Text -

The name of the Organization

-

-
Example -

-

"name": "Central Speedball Association" -

+

The name of the Organization


Example

"name": "Central Speedball Association"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,65 +53,47 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/organization/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/organization/12345"
sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated - with the organization.

-

-
Example -

-

"sameAs": [
"https://www.facebook.com/everyoneactive/",
"https://twitter.com/everyoneactive"
] -

+

Lists the URL(s) of the official social media profile pages associated with the organization.


Example

"sameAs": [
  "https://www.facebook.com/everyoneactive/",
  "https://twitter.com/everyoneactive"
]
telephone - Text + telephone + Text -

The telephone number of the Organization

-

-
Example -

-

"telephone": "01234 567890" -

+

The telephone number of the Organization


Example

"telephone": "01234 567890"
url - url + url + url -

A definitive canonical URL for the Organization.

-

-
Example -

-

"url": "http://www.speedball-world.com" -

+

A definitive canonical URL for the Organization.


Example

"url": "http://www.speedball-world.com"
### **Optional fields** + + +### **Optional fields** + @@ -123,54 +104,33 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + + - - + -
description - Text + description + Text -

The description of the Organization

-

-
Example -

-

"description": "The national governing body of cycling" -

+

The description of the Organization


Example

"description": "The national governing body of cycling"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
logo - ImageObject + logo + ImageObject -

A logo for the Organization.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

A logo for the Organization.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/parking.md b/docs/data-model/types/parking.md index d18ce763..1d5b05bd 100644 --- a/docs/data-model/types/parking.md +++ b/docs/data-model/types/parking.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Parking" + + Must always be present and set to "type": "Parking"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Roadside Parking" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Roadside Parking"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/partialschedule.md b/docs/data-model/types/partialschedule.md index b8cc1d8c..852a2ca8 100644 --- a/docs/data-model/types/partialschedule.md +++ b/docs/data-model/types/partialschedule.md @@ -9,13 +9,31 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "PartialSchedule" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "PartialSchedule"` | ### **Recommended fields** - + @@ -26,51 +44,38 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + -
endTime - Time + endTime + Time -

The end time of the event.

-

-
Example -

-

"endTime": "12:00:00" -

+

The end time of the event.


Example

"endTime": "12:00:00"
repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"
startTime - Time + startTime + Time -

The start time of the event.

-

-
Example -

-

"startTime": "12:00:00" -

+

The start time of the event.


Example

"startTime": "12:00:00"
### **Optional fields** + + +### **Optional fields** + @@ -81,172 +86,105 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek -
- or - -
Array of Text + 		byDay + Array of DayOfWeek
- or -
Array of Text 		-

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]
byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]
byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - Date + endDate + Date -

The end date of the schedule.

-

-
Example -

-

"endDate": "2018-01-27" -

+

The end date of the schedule.


Example

"endDate": "2018-01-27"
exceptDate - Array of Date -
- or - -
Array of DateTime + 		exceptDate + Array of Date
- or -
Array of DateTime 		-

Exception dates where the schedule should not generate an event.

-

-
Example -

-

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] -

+

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]
idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - identifier (@id) for every event described by the schedule (see below for - more information). This property is required if the data provider is supporting - third-party booking via the Open Booking API.

-

-
Example -

-

"idTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"
repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.

-

-
Example -

-

"repeatCount": 3 -

+

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3
scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.

-

-
Example -

-

"scheduledEventType": "Event" -

+

The type of event this schedule related to.


Example

"scheduledEventType": "Event"
startDate - Date + startDate + Date -

The start date of the event.

-

-
Example -

-

"startDate": "2018-01-27" -

+

The start date of the event.


Example

"startDate": "2018-01-27"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - URL (schema:url) for every event described by the schedule (see below for - more information). This property is required if the data provider wants - to provide participants with a unique URL to book to attend an event.

-

-
Example -

-

"urlTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"
\ No newline at end of file + + + diff --git a/docs/data-model/types/person.md b/docs/data-model/types/person.md index 032f9e42..9c59018e 100644 --- a/docs/data-model/types/person.md +++ b/docs/data-model/types/person.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "Person" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "Person"` | ### **Recommended fields** - + @@ -26,22 +44,20 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/person/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/person/12345"
### **Optional fields** + + +### **Optional fields** + @@ -52,113 +68,69 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + - - - + + - - + - - + - - + - - + - - + -
description - Text + description + Text -

The description of the Person

-

-
Example -

-

"description": "The leader of the coaching team" -

+

The description of the Person


Example

"description": "The leader of the coaching team"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
logo - ImageObject + logo + ImageObject -

A logo for the person.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

A logo for the person.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
name - Text + name + Text -

A full name for the person.

-

This person must give direct permission for their personal information - to be shared as part of the Open Data.

-

-
Example -

-

"name": "Daley Thompson" -

+

A full name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"name": "Daley Thompson"
sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated - with the person.

-

-
Example -

-

"sameAs": "https://example.org/example-org" -

+

Lists the URL(s) of the official social media profile pages associated with the person.


Example

"sameAs": "https://example.org/example-org"
telephone - Text + telephone + Text -

The telephone number of the person

-

-
Example -

-

"telephone": "01234 567890" -

+

The telephone number of the person


Example

"telephone": "01234 567890"
url - url + url + url -

A URL where more information about the person may be found

-

-
Example -

-

"url": "http://www.example.com/" -

+

A URL where more information about the person may be found


Example

"url": "http://www.example.com/"
\ No newline at end of file + + + diff --git a/docs/data-model/types/place.md b/docs/data-model/types/place.md index ebb91aca..17beda2e 100644 --- a/docs/data-model/types/place.md +++ b/docs/data-model/types/place.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), ## **Fields** ### **Required fields** - + @@ -20,29 +20,28 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Place" + + Must always be present and set to "type": "Place"
name - Text + name + Text -

The name of the Place

-

-
Example -

-

"name": "Raynes Park High School" -

+

The name of the Place


Example

"name": "Raynes Park High School"
### **Required options** + + + +### ** Required options ** While these properties are marked as recommended in the specification, a data publisher must provide as much detail in both `address` and `geo` for an event as possible. @@ -56,42 +55,29 @@ While these properties are marked as recommended in the specification, a data pu - address - - PostalAddress -
- or - -
Text + address + + PostalAddress
- or -
Text -

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

- geo - - GeoCoordinates + geo + + GeoCoordinates -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

-### **Recommended fields** + + +### **Recommended fields** + @@ -102,100 +88,74 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - + - - - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/place/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"
amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.

-

-
Example -

-

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] -

+

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]
description - Text + description + Text -

The description of the Place

-

-
Example -

-

"description": "Raynes Park High School in London" -

+

The description of the Place


Example

"description": "Raynes Park High School in London"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
openingHoursSpecification + openingHoursSpecification + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the Place is open

The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place

-

-
Example -

-

"telephone": "01253 473934" -

+

The telephone number for the Place


Example

"telephone": "01253 473934"
url - url + url + url -

The website for the Place

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

The website for the Place


Example

"url": "http://www.rphs.org.uk/"
### **Optional fields** + + +### **Optional fields** + @@ -206,88 +166,51 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - - - + + -
address - PostalAddress -
- or - -
Text + 		address + PostalAddress
- or -
Text 		-

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}
containedInPlace - Place + containedInPlace + Place -

The place within which this Place exists

-

-
Example -

-

"containedInPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
"name": "Middlesbrough Sports Village"
} -

+

The place within which this Place exists


Example

"containedInPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
  "name": "Middlesbrough Sports Village"
}
containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place

-

-
Example -

-

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} -

+

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}
geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/postaladdress.md b/docs/data-model/types/postaladdress.md index 29028dc7..5b57322a 100644 --- a/docs/data-model/types/postaladdress.md +++ b/docs/data-model/types/postaladdress.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,82 +20,60 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "PostalAddress" + + Must always be present and set to "type": "PostalAddress"
addressCountry - Text + addressCountry + Text -

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.

-

-
Example -

-

"addressCountry": "GB" -

+

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.


Example

"addressCountry": "GB"
addressLocality - Text + addressLocality + Text -

The locality, a suburb within a city or a town within a county or district.

-

-
Example -

-

"addressLocality": "Shoreditch" -

+

The locality, a suburb within a city or a town within a county or district.


Example

"addressLocality": "Shoreditch"
addressRegion - Text + addressRegion + Text -

The region, either a city or a county or district.

-

-
Example -

-

"addressRegion": "London" -

+

The region, either a city or a county or district.


Example

"addressRegion": "London"
postalCode - Text + postalCode + Text -

The postal code.

-

-
Example -

-

"postalCode": "EC2A 4JE" -

+

The postal code.


Example

"postalCode": "EC2A 4JE"
streetAddress - Text + streetAddress + Text -

The street address.

-

-
Example -

-

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St" -

+

The street address.


Example

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St"
\ No newline at end of file + + + diff --git a/docs/data-model/types/propertyvalue.md b/docs/data-model/types/propertyvalue.md index 24b8f082..6719f4bb 100644 --- a/docs/data-model/types/propertyvalue.md +++ b/docs/data-model/types/propertyvalue.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,46 +20,38 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "PropertyValue" + + Must always be present and set to "type": "PropertyValue"
name - Text + name + Text -

The name of this PropertyValue

-

-
Example -

-

"name": "Vendor ID" -

+

The name of this PropertyValue


Example

"name": "Vendor ID"
value - Text -
- or - -
Integer + 		value + Text
- or -
Integer 		-

The actual value of this identifier

-

-
Example -

-

"value": "SB1234" -

+

The actual value of this identifier


Example

"value": "SB1234"
### **Optional fields** + + +### **Optional fields** + @@ -70,20 +62,15 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + -
propertyID - url -
- or - -
Text + 		propertyID + url
- or -
Text 		-

A commonly used identifier for the characteristic represented by the property

-

-
Example -

-

"propertyID": "ActivePlaces" -

+

A commonly used identifier for the characteristic represented by the property


Example

"propertyID": "ActivePlaces"
\ No newline at end of file + + + diff --git a/docs/data-model/types/quantitativevalue.md b/docs/data-model/types/quantitativevalue.md index 86fd4b4b..28f57819 100644 --- a/docs/data-model/types/quantitativevalue.md +++ b/docs/data-model/types/quantitativevalue.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "QuantitativeValue" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "QuantitativeValue"` | ### **Optional fields** - + @@ -26,32 +44,24 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. - - + - - + -
maxValue - Integer + maxValue + Integer -

The maximum value.

-

-
Example -

-

"maxValue": 60 -

+

The maximum value.


Example

"maxValue": 60
minValue - Integer + minValue + Integer -

The minimum value.

-

-
Example -

-

"minValue": 16 -

+

The minimum value.


Example

"minValue": 16
\ No newline at end of file + + + diff --git a/docs/data-model/types/reserveaction.md b/docs/data-model/types/reserveaction.md index 24dbfc4d..ad053fdd 100644 --- a/docs/data-model/types/reserveaction.md +++ b/docs/data-model/types/reserveaction.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ReserveAction" + + Must always be present and set to "type": "ReserveAction"
name - Text + name + Text -

The name of the action

-

-
Example -

-

"name": "Book" -

+

The name of the action


Example

"name": "Book"
target - EntryPoint + target + EntryPoint -

A definition of the target of the action.

-

-
Example -

-

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} -

+

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/schedule.md b/docs/data-model/types/schedule.md index beb09f7c..77c89bd8 100644 --- a/docs/data-model/types/schedule.md +++ b/docs/data-model/types/schedule.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - + @@ -20,57 +20,46 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Schedule" + + Must always be present and set to "type": "Schedule"
endTime - Time + endTime + Time -

The end time of the event.

-

-
Example -

-

"endTime": "12:00:00" -

+

The end time of the event.


Example

"endTime": "12:00:00"
scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.

-

-
Example -

-

"scheduledEventType": "Event" -

+

The type of event this schedule related to.


Example

"scheduledEventType": "Event"
startTime - Time + startTime + Time -

The start time of the event.

-

-
Example -

-

"startTime": "12:00:00" -

+

The start time of the event.


Example

"startTime": "12:00:00"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional, a data publisher must provide either a `byDay`, `byMonth`, `byMonthDay` or `repeatFrequency` for a schedule. @@ -84,71 +73,47 @@ While these properties are marked as optional, a data publisher must provide eit - byDay - - Array of DayOfWeek -
- or - -
Array of Text + byDay + + Array of DayOfWeek
- or -
Array of Text -

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

- byMonth - - Array of Integer + byMonth + + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

- byMonthDay - - Array of Integer + byMonthDay + + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

- repeatFrequency - - Duration + repeatFrequency + + Duration -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

-### **Recommended fields** + + +### **Recommended fields** + @@ -159,84 +124,56 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - Date + endDate + Date -

The end date of the schedule.

-

-
Example -

-

"endDate": "2018-01-27" -

+

The end date of the schedule.


Example

"endDate": "2018-01-27"
idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - identifier (@id) for every event described by the schedule (see below for - more information). This property is required if the data provider is supporting - third-party booking via the Open Booking API.

-

-
Example -

-

"idTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"
startDate - Date + startDate + Date -

The start date of the event.

-

-
Example -

-

"startDate": "2018-01-27" -

+

The start date of the event.


Example

"startDate": "2018-01-27"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - URL (schema:url) for every event described by the schedule (see below for - more information). This property is required if the data provider wants - to provide participants with a unique URL to book to attend an event.

-

-
Example -

-

"urlTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"
### **Optional fields** + + +### **Optional fields** + @@ -247,97 +184,60 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek -
- or - -
Array of Text + 		byDay + Array of DayOfWeek
- or -
Array of Text 		-

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]
byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]
byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]
exceptDate - Array of Date -
- or - -
Array of DateTime + 		exceptDate + Array of Date
- or -
Array of DateTime 		-

Exception dates where the schedule should not generate an event.

-

-
Example -

-

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] -

+

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]
repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.

-

-
Example -

-

"repeatCount": 3 -

+

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3
repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"
\ No newline at end of file + + + diff --git a/docs/data-model/types/scheduledsession.md b/docs/data-model/types/scheduledsession.md index fe1b4ec1..6c219234 100644 --- a/docs/data-model/types/scheduledsession.md +++ b/docs/data-model/types/scheduledsession.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,84 +20,56 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ScheduledSession" + + Must always be present and set to "type": "ScheduledSession"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Recommended fields** + + +### **Recommended fields** + @@ -108,129 +80,83 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Optional fields** + + +### **Optional fields** + @@ -241,332 +167,195 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/sessionseries.md b/docs/data-model/types/sessionseries.md index c074952f..d75d43b4 100644 --- a/docs/data-model/types/sessionseries.md +++ b/docs/data-model/types/sessionseries.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,113 +20,74 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "SessionSeries" + + Must always be present and set to "type": "SessionSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -137,118 +98,74 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
### **Optional fields** + + +### **Optional fields** + @@ -259,324 +176,195 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
subEvent + subEvent + Array of ScheduledSession Array of ScheduledSession + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/showers.md b/docs/data-model/types/showers.md index 2f7579e1..33f60e9c 100644 --- a/docs/data-model/types/showers.md +++ b/docs/data-model/types/showers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Showers" + + Must always be present and set to "type": "Showers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Poolside Showers" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Poolside Showers"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/slot.md b/docs/data-model/types/slot.md index ab9af02c..1e0e4c96 100644 --- a/docs/data-model/types/slot.md +++ b/docs/data-model/types/slot.md @@ -4,10 +4,12 @@ description: This page describes the Slot type. # Slot + + ## **Fields** ### **Required fields** - + @@ -18,89 +20,64 @@ description: This page describes the Slot type. - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Slot" + + Must always be present and set to "type": "Slot"
duration - Duration + duration + Duration -

The duration of the slot given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the slot given in [ISO8601] format.


Example

"duration": "PT1H"
facilityUse - url + facilityUse + url -

URI to the FacilityUse that has this offer

-

-
Example -

-

"facilityUse": "https://example.com/facility-use/1" -

+

URI to the FacilityUse that has this offer


Example

"facilityUse": "https://example.com/facility-use/1"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
remainingUses - Integer + remainingUses + Integer -

The remaining available courts or pitches at this time. Must be 0 or 1 - for an IndividualFacilityUse.

-

-
Example -

-

"remainingUses": 5 -

+

The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"remainingUses": 5
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the slot. Can be specified as a schema:Date - or schema:DateTime

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the slot. Can be specified as a schema:Date or schema:DateTime


Example

"startDate": "2018-01-27T12:00:00Z"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional/recommended in the Modelling Specification, one of these must be provided when surfacing a slot through an RPDE feed to ensure that the slots can be processed correctly by data consumers. @@ -114,44 +91,29 @@ While these properties are marked as optional/recommended in the Modelling Speci - id - - url + id + + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/slot/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

- identifier - - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + identifier + + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer -

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

-### **Recommended fields** + + +### **Recommended fields** + @@ -162,37 +124,29 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/slot/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"
maximumUses - Integer + maximumUses + Integer -

The maximum available courts or pitches at this time. Must be 0 or 1 for - an IndividualFacilityUse.

-

-
Example -

-

"maximumUses": 16 -

+

The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"maximumUses": 16
### **Optional fields** + + +### **Optional fields** + @@ -203,45 +157,24 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the slot. Can be specified as a schema:Date or - schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an slot.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the slot. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an slot.


Example

"endDate": "2018-01-27T12:00:00Z"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/sportsactivitylocation.md b/docs/data-model/types/sportsactivitylocation.md index 9ba98a91..8aeb6e17 100644 --- a/docs/data-model/types/sportsactivitylocation.md +++ b/docs/data-model/types/sportsactivitylocation.md @@ -9,12 +9,30 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "SportsActivityLocation" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "SportsActivityLocation"` | -### **Required options** +### ** Required options ** While these properties are marked as recommended in the specification, a data publisher must provide as much detail in both `address` and `geo` for an event as possible. @@ -28,42 +46,29 @@ While these properties are marked as recommended in the specification, a data pu - address - - PostalAddress -
- or - -
Text + address + + PostalAddress
- or -
Text -

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

- geo - - GeoCoordinates + geo + + GeoCoordinates -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

-### **Recommended fields** + + +### **Recommended fields** + @@ -74,22 +79,20 @@ While these properties are marked as recommended in the specification, a data pu - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/place/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"
### **Optional fields** + + +### **Optional fields** + @@ -100,184 +103,114 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - - + - - + - - - + + - - + - - + - + - - - - + - - + -
address - PostalAddress -
- or - -
Text + 		address + PostalAddress
- or -
Text 		-

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}
amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.

-

-
Example -

-

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] -

+

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]
containedInPlace - Place -
- or - -
url + 		containedInPlace + Place
- or -
url 		-

While a url is not specified as an option in the Modelling - Specification, it is necessary to link entities in RPDE.

-

-
Example -

-

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d" -

+

While a url is not specified as an option in the Modelling Specification, it is necessary to link entities in RPDE.


Example

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d"
containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place

-

-
Example -

-

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} -

+

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}
description - Text + description + Text -

The description of the Place

-

-
Example -

-

"description": "Raynes Park High School in London" -

+

The description of the Place


Example

"description": "Raynes Park High School in London"
geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
name - Text + name + Text -

The name of the Place

-

-
Example -

-

"name": "Raynes Park High School" -

+

The name of the Place


Example

"name": "Raynes Park High School"
openingHoursSpecification + openingHoursSpecification + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the Place is open

The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place

-

-
Example -

-

"telephone": "01253 473934" -

+

The telephone number for the Place


Example

"telephone": "01253 473934"
url - url + url + url -

The website for the Place

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

The website for the Place


Example

"url": "http://www.rphs.org.uk/"
\ No newline at end of file + + + diff --git a/docs/data-model/types/toilets.md b/docs/data-model/types/toilets.md index f8e164c9..f5248106 100644 --- a/docs/data-model/types/toilets.md +++ b/docs/data-model/types/toilets.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Toilets" + + Must always be present and set to "type": "Toilets"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Public Toilets" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Public Toilets"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/towels.md b/docs/data-model/types/towels.md index 14fb351e..063eb9c0 100644 --- a/docs/data-model/types/towels.md +++ b/docs/data-model/types/towels.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Towels" + + Must always be present and set to "type": "Towels"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Complementary Towels" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Complementary Towels"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + From 5bb4094d9bc0e4de1979f3eda851e815188edc53 Mon Sep 17 00:00:00 2001 From: Melanie Abraham Date: Tue, 13 Nov 2018 17:23:03 +0000 Subject: [PATCH 09/10] GitBook: [draft] 38 pages modified --- ...enactive-data-model-part-one-the-basics.md | 4 + docs/data-model/types/action.md | 41 +- docs/data-model/types/babychanging.md | 36 +- docs/data-model/types/brand.md | 98 +-- docs/data-model/types/changingfacilities.md | 36 +- docs/data-model/types/concept.md | 118 ++-- docs/data-model/types/conceptscheme.md | 101 ++-- docs/data-model/types/courseinstance.md | 570 ++++++++++++------ docs/data-model/types/creche.md | 36 +- docs/data-model/types/entrypoint.md | 51 +- docs/data-model/types/event.md | 570 ++++++++++++------ docs/data-model/types/eventseries.md | 535 +++++++++++----- docs/data-model/types/facilityuse.md | 295 ++++++--- docs/data-model/types/geocoordinates.md | 41 +- docs/data-model/types/headlineevent.md | 521 +++++++++++----- docs/data-model/types/imageobject.md | 51 +- .../data-model/types/individualfacilityuse.md | 290 ++++++--- .../types/locationfeaturespecification.md | 36 +- docs/data-model/types/lockers.md | 36 +- docs/data-model/types/offer.md | 163 +++-- .../types/openinghoursspecification.md | 54 +- docs/data-model/types/organization.md | 142 +++-- docs/data-model/types/parking.md | 36 +- docs/data-model/types/partialschedule.md | 232 ++++--- docs/data-model/types/person.md | 154 +++-- docs/data-model/types/place.md | 245 +++++--- docs/data-model/types/postaladdress.md | 80 ++- docs/data-model/types/propertyvalue.md | 63 +- docs/data-model/types/quantitativevalue.md | 56 +- docs/data-model/types/reserveaction.md | 41 +- docs/data-model/types/schedule.md | 286 ++++++--- docs/data-model/types/scheduledsession.md | 511 +++++++++++----- docs/data-model/types/sessionseries.md | 522 +++++++++++----- docs/data-model/types/showers.md | 36 +- docs/data-model/types/slot.md | 201 ++++-- .../types/sportsactivitylocation.md | 259 +++++--- docs/data-model/types/toilets.md | 36 +- docs/data-model/types/towels.md | 36 +- 38 files changed, 4369 insertions(+), 2250 deletions(-) diff --git a/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md index 119b6153..a4f44e07 100644 --- a/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md +++ b/docs/data-model/tutorial-describing-events-using-the-openactive-data-model-part-one-the-basics.md @@ -301,6 +301,10 @@ https://openactive.io/activity-list And that’s it! Here we have a valid event described according to the OpenActive opportunity data model. You’re able to double-check that you’ve got everything entered correctly by pasting your code into the [OpenActive data validator tool](https://validator.openactive.io/), or jump to [this pre-populated example](https://validator.openactive.io/?url=https%3A%2F%2Fwww.openactive.io%2Fdata-models%2Fversions%2F2.x%2Fexamples%2Ftutorials%2Fdescribing-events%2Fpart-one-finished.json&version=2.0). +### **3.2 Changes for v2.1** + +v2.1 of the modelling spec will include offers as a required field, as it is critical for data users and end user experience. If you are building your data now we strongly recommend you include this field. Details of how to do this are included in part 2 of this tutorial. + ## **4. Where to go next** This is all you need to get up and running, but it may be that you’d like a bit more detail. If you’ve taken the time to validate the above, you’ll also see that the validator returns a number of additional recommendations for making the data even better. If you’d like to build the example up even further you can follow along with [part two: adding additional timing detail](tutorial-describing-events-using-the-openactive-data-model-part-two-adding-additional-detail.md). diff --git a/docs/data-model/types/action.md b/docs/data-model/types/action.md index 6a2d7d3c..69ab11b0 100644 --- a/docs/data-model/types/action.md +++ b/docs/data-model/types/action.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Action" + Text + Must always be present and set to "type": "Action"
name - Text + name + Text -

The name of the action


Example

"name": "Book"

+

The name of the action

+

+
Example +

+

"name": "Book" +

target - EntryPoint + target + EntryPoint -

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}

+

A definition of the target of the action.

+

+
Example +

+

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/babychanging.md b/docs/data-model/types/babychanging.md index afddc50c..96aacca1 100644 --- a/docs/data-model/types/babychanging.md +++ b/docs/data-model/types/babychanging.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "BabyChanging" + Text + Must always be present and set to "type": "BabyChanging"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Baby Changing Facilities"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Baby Changing Facilities" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/brand.md b/docs/data-model/types/brand.md index 80615e68..c4584376 100644 --- a/docs/data-model/types/brand.md +++ b/docs/data-model/types/brand.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), ## **Fields** ### **Required fields** - + @@ -20,38 +20,44 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Brand" + Text + Must always be present and set to "type": "Brand"
name - Text + name + Text -

The name of the brand.


Example

"name": "Play Ball!"

+

The name of the brand.

+

+
Example +

+

"name": "Play Ball!" +

url - url + url + url -

A url where further information can be found for the brand.


Example

"url": "http://example.com/play_ball"

+

A url where further information can be found for the brand.

+

+
Example +

+

"url": "http://example.com/play_ball" +

- +### **Recommended fields** -### **Recommended fields** - @@ -62,29 +68,36 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - + -
description - Text + description + Text -

A text description for the brand.


Example

"description": "Play Ball! is a series of games for people of all abilities."

+

A text description for the brand.

+

+
Example +

+

"description": "Play Ball! is a series of games for people of all abilities." +

logo - ImageObject + logo + ImageObject -

The logo associated with the brand.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

The logo associated with the brand.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

- +### **Optional fields** -### **Optional fields** - @@ -95,15 +108,26 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + -
identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "BR1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "BR1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/changingfacilities.md b/docs/data-model/types/changingfacilities.md index 2b65ac39..c6a201ef 100644 --- a/docs/data-model/types/changingfacilities.md +++ b/docs/data-model/types/changingfacilities.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "ChangingFacilities" + Text + Must always be present and set to "type": "ChangingFacilities"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Changing Rooms"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Changing Rooms" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/concept.md b/docs/data-model/types/concept.md index 367ffb27..8fe8e544 100644 --- a/docs/data-model/types/concept.md +++ b/docs/data-model/types/concept.md @@ -4,12 +4,12 @@ description: This page describes the Concept type. # Concept -This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://www.w3.org/2004/02/skos/core#Concept). +This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http://www.w3.org/2004/02/skos/core#Concept). ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - - + - - + -
type - Text + type - Must always be present and set to "type": "Concept" + Text + Must always be present and set to "type": "Concept"
prefLabel - Text + prefLabel + Text -

A human readable string for use in user interfaces.


Example

"prefLabel": "Speedball"

+

A human readable string for use in user interfaces.

+

+
Example +

+

"prefLabel": "Speedball" +

+### **Recommended fields** - -### **Recommended fields** - @@ -53,29 +54,36 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/concept/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/concept/12345" +

inScheme - url + inScheme + url -

A stable URL reference for the taxonomy.


Example

"inScheme": "https://example.com/reference/activities"

+

A stable URL reference for the taxonomy.

+

+
Example +

+

"inScheme": "https://example.com/reference/activities" +

+### **Optional fields** - -### **Optional fields** - @@ -86,42 +94,60 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://w - - + - - + - - + - - + -
altLabel - Array of Text + altLabel + Array of Text -

An alternative human readable string for use in user interfaces.


Example

"altLabel": "Speedball"

+

An alternative human readable string for use in user interfaces.

+

+
Example +

+

"altLabel": "Speedball" +

broader - Array of url + broader + Array of url -

A broader Concept URI


Example

"broader": "https://example.com/football"

+

A broader Concept URI

+

+
Example +

+

"broader": "https://example.com/football" +

narrower - Array of url + narrower + Array of url -

A more specific concept URI


Example

"narrower": "https://example.com/walking-football"

+

A more specific concept URI

+

+
Example +

+

"narrower": "https://example.com/walking-football" +

notation - Text + notation + Text -

A concept label that is not normally recognisable as natural language.


Example

"notation": "Speedball"

+

A concept label that is not normally recognisable as natural language.

+

+
Example +

+

"notation": "Speedball" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/conceptscheme.md b/docs/data-model/types/conceptscheme.md index d3acfe5e..aa531e69 100644 --- a/docs/data-model/types/conceptscheme.md +++ b/docs/data-model/types/conceptscheme.md @@ -4,12 +4,12 @@ description: This page describes the ConceptScheme type. # ConceptScheme -This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). +This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). ## **Fields** ### **Required fields** - + @@ -20,56 +20,73 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](ht - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ConceptScheme" + Text + Must always be present and set to "type": "ConceptScheme"
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/scheme/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/scheme/12345" +

concept - Array of Concept + concept + Array of Concept -

A collection of concepts that are part of this scheme


Example

"concept": [
  {
    "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"
  }
]

+

A collection of concepts that are part of this scheme

+

+
Example +

+

"concept": [
{
"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"
}
] +

title - Text + title + Text -

The title of the scheme


Example

"title": "Activity List"

+

The title of the scheme

+

+
Example +

+

"title": "Activity List" +

url - url + url + url -

A URL to a web page (or section of a page) that describes the concept scheme.


Example

"url": "https://example.com/scheme/1234"

+

A URL to a web page (or section of a page) that describes the concept + scheme.

+

+
Example +

+

"url": "https://example.com/scheme/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,24 +97,32 @@ This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](ht - - + - - + -
description - Text + description + Text -

A free text description of the taxonomy


Example

"description": "An example activity list."

+

A free text description of the taxonomy

+

+
Example +

+

"description": "An example activity list." +

license - url + license + url -

Reference to the license under which the activity list has been published.


Example

"license": "https://example.com/license/MIT"

+

Reference to the license under which the activity list has been published.

+

+
Example +

+

"license": "https://example.com/license/MIT" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/courseinstance.md b/docs/data-model/types/courseinstance.md index 47459544..b7ffb054 100644 --- a/docs/data-model/types/courseinstance.md +++ b/docs/data-model/types/courseinstance.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe ## **Fields** ### **Required fields** - + @@ -20,73 +20,112 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe - - - + - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "CourseInstance" + Text + Must always be present and set to "type": "CourseInstance"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional in the specification, a data publisher must provide either a `startDate` or specify an `eventSchedule` for an event. @@ -100,29 +139,40 @@ While these properties are marked as optional in the specification, a data publi - startDate - - DateTime
- or -
Date + startDate + + DateTime +
- or - +
Date -

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

- - +### **Recommended fields** -### **Recommended fields** - @@ -133,119 +183,197 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Optional fields** -### **Optional fields** - @@ -256,159 +384,259 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/creche.md b/docs/data-model/types/creche.md index 2ee2db11..1023ec78 100644 --- a/docs/data-model/types/creche.md +++ b/docs/data-model/types/creche.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Creche" + Text + Must always be present and set to "type": "Creche"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Childcare"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Childcare" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/entrypoint.md b/docs/data-model/types/entrypoint.md index 960e3c97..e487be2c 100644 --- a/docs/data-model/types/entrypoint.md +++ b/docs/data-model/types/entrypoint.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent ## **Fields** ### **Required fields** - + @@ -20,42 +20,49 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent - - - + - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "EntryPoint" + Text + Must always be present and set to "type": "EntryPoint"
encodingType - Text + encodingType - Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json" + Text + Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json"
httpMethod - Text + httpMethod + Text -

An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.


Example

"httpMethod": "POST"

+

An HTTP method that specifies the appropriate HTTP method for a request + to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.

+

+
Example +

+

"httpMethod": "POST" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

URL of the item


Example

"urlTemplate": "https://example.com/orders{/var}"

+

URL of the item

+

+
Example +

+

"urlTemplate": "https://example.com/orders{/var}" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/event.md b/docs/data-model/types/event.md index 4c4108c7..88e47bbd 100644 --- a/docs/data-model/types/event.md +++ b/docs/data-model/types/event.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,73 +20,112 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Event" + Text + Must always be present and set to "type": "Event"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional in the specification, a data publisher must provide either a `startDate` or specify an `eventSchedule` for an event. @@ -100,29 +139,40 @@ While these properties are marked as optional in the specification, a data publi - startDate - - DateTime
- or -
Date + startDate + + DateTime +
- or - +
Date -

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

- - +### **Recommended fields** -### **Recommended fields** - @@ -133,119 +183,197 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Optional fields** -### **Optional fields** - @@ -256,159 +384,259 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/eventseries.md b/docs/data-model/types/eventseries.md index 8ec56a3e..8134253a 100644 --- a/docs/data-model/types/eventseries.md +++ b/docs/data-model/types/eventseries.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi ## **Fields** ### **Required fields** - + @@ -20,56 +20,77 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "EventSeries" + Text + Must always be present and set to "type": "EventSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,110 +101,175 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

+### **Optional fields** - -### **Optional fields** - @@ -194,186 +280,317 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/facilityuse.md b/docs/data-model/types/facilityuse.md index a0d843b4..f7887176 100644 --- a/docs/data-model/types/facilityuse.md +++ b/docs/data-model/types/facilityuse.md @@ -4,12 +4,10 @@ description: This page describes the FacilityUse type. # FacilityUse - - ## **Fields** ### **Required fields** - + @@ -20,65 +18,87 @@ description: This page describes the FacilityUse type. - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "FacilityUse" + Text + Must always be present and set to "type": "FacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + a facility use.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the facility use will take place.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the facility use


Example

"name": "Speedball"

+

The name of the facility use

+

+
Example +

+

"name": "Speedball" +

provider - + provider -

The organisation responsible for providing the facility


Example

"provider": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The organisation responsible for providing the facility

+

+
Example +

+

"provider": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"

+

A URL to a web page (or section of a page) that describes the facility + use.

+

+
Example +

+

"url": "https://example.com/facility-use/1234" +

+### **Recommended fields** - -### **Recommended fields** - @@ -89,65 +109,86 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/facility-use/112345" +

description - Text + description + Text -

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the facility use

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

event - Array of Slot + event + Array of Slot -

An array of slots of availability of this FacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 3,
    "maximumUses": 6
  }
]

+

An array of slots of availability of this FacilityUse.

+

+
Example +

+

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 3,
"maximumUses": 6
}
] +

hoursAvailable - Array of OpeningHoursSpecification + hoursAvailable -

The times the facility use is available

+ 		Array of OpeningHoursSpecification The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the facility use, e.g. a photo taken at + a previous event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

- +### **Optional fields** -### **Optional fields** - @@ -158,78 +199,136 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."

+

Provides additional notes and instructions for users of a facility. E.g. + more information on how to find it, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]

+

Provides a set of tags that help categorise and describe a facility.

+

+
Example +

+

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

individualFacilityUse - Array of IndividualFacilityUse + individualFacilityUse + Array of IndividualFacilityUse -

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court).


Example

"individualFacilityUse": [
  {
    "type": "IndividualFacilityUse",
    "id": "http://www.example.org/facility-uses/1",
    "name": "Tennis Court 1"
  }
]

+

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse + (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse + (e.g. an opportunity to play tennis on a specific court).

+

+
Example +

+

"individualFacilityUse": [
{
"type": "IndividualFacilityUse",
"id": "http://www.example.org/facility-uses/1",
"name": "Tennis Court 1"
}
] +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

- - + \ No newline at end of file diff --git a/docs/data-model/types/geocoordinates.md b/docs/data-model/types/geocoordinates.md index 8d98bd79..279b2904 100644 --- a/docs/data-model/types/geocoordinates.md +++ b/docs/data-model/types/geocoordinates.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "GeoCoordinates" + Text + Must always be present and set to "type": "GeoCoordinates"
latitude - Float + latitude + Float -

The latitude of a location. For example 51.522338 (WGS 84).


Example

"latitude": 51.522338

+

The latitude of a location. For example 51.522338 (WGS 84).

+

+
Example +

+

"latitude": 51.522338 +

longitude - Float + longitude + Float -

The longitude of a location. For example -0.083437 (WGS 84).


Example

"longitude": -0.083437

+

The longitude of a location. For example -0.083437 (WGS 84).

+

+
Example +

+

"longitude": -0.083437 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/headlineevent.md b/docs/data-model/types/headlineevent.md index 2a62b521..df8242dd 100644 --- a/docs/data-model/types/headlineevent.md +++ b/docs/data-model/types/headlineevent.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,74 +20,116 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "HeadlineEvent" + Text + Must always be present and set to "type": "HeadlineEvent"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -98,119 +140,194 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

+### **Optional fields** - -### **Optional fields** - @@ -221,150 +338,244 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

subEvent - Array of Event + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of Event Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/imageobject.md b/docs/data-model/types/imageobject.md index cdbb0626..3d0cafa7 100644 --- a/docs/data-model/types/imageobject.md +++ b/docs/data-model/types/imageobject.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im ## **Fields** ### **Required fields** - + @@ -20,48 +20,31 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im - - - - - - - - - - -
type - Text + type - Must always be present and set to "type": "ImageObject" + Text
url - url + Must always be present and set to "type": "ImageObject" -

The URL for the display resolution image.


Example

"url": "http://example.com/static/image/speedball_large.jpg"

-
- - -### **Optional fields** - - - - - - - - - - - + -
PropertyExpected TypeDescription
thumbnail - Array of ImageObject + url + url -

The URL for a thumbnail image for an image.

+

The URL for the display resolution image.

+

+
Example +

+

"url": "http://example.com/static/image/speedball_large.jpg" +

+### **Optional fields** +| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **thumbnail** | Array of [`ImageObject`](https://docs.openactive.io/data-model/types/imageobject) | The URL for a thumbnail image for an image. | diff --git a/docs/data-model/types/individualfacilityuse.md b/docs/data-model/types/individualfacilityuse.md index bbab228a..28c8a1ef 100644 --- a/docs/data-model/types/individualfacilityuse.md +++ b/docs/data-model/types/individualfacilityuse.md @@ -4,12 +4,10 @@ description: This page describes the IndividualFacilityUse type. # IndividualFacilityUse - - ## **Fields** ### **Required fields** - + @@ -20,65 +18,87 @@ description: This page describes the IndividualFacilityUse type. - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "IndividualFacilityUse" + Text + Must always be present and set to "type": "IndividualFacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + a facility use.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the facility use will take place.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the facility use


Example

"name": "Speedball"

+

The name of the facility use

+

+
Example +

+

"name": "Speedball" +

provider - + provider -

The organisation responsible for providing the facility


Example

"provider": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The organisation responsible for providing the facility

+

+
Example +

+

"provider": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"

+

A URL to a web page (or section of a page) that describes the facility + use.

+

+
Example +

+

"url": "https://example.com/facility-use/1234" +

+### **Recommended fields** - -### **Recommended fields** - @@ -89,65 +109,81 @@ description: This page describes the IndividualFacilityUse type. - - + - - - + - - + - - + - - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/facility-use/112345" +

aggregateFacilityUse - FacilityUse + aggregateFacilityUse -

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location).

+ 		FacilityUse Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse + (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse + (e.g. an opportunity to play tennis at a specific location).
description - Text + description + Text -

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the facility use

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

event - Array of Slot + event + Array of Slot -

An array of slots of availability of this IndividualFacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 0,
    "maximumUses": 1
  }
]

+

An array of slots of availability of this IndividualFacilityUse.

+

+
Example +

+

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 0,
"maximumUses": 1
}
] +

hoursAvailable - Array of OpeningHoursSpecification + hoursAvailable -

The times the facility use is available

+ 		Array of OpeningHoursSpecification The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the facility use, e.g. a photo taken at + a previous event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

- +### **Optional fields** -### **Optional fields** - @@ -158,78 +194,134 @@ description: This page describes the IndividualFacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."

+

Provides additional notes and instructions for users of a facility. E.g. + more information on how to find it, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]

+

Provides a set of tags that help categorise and describe a facility.

+

+
Example +

+

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

- - + \ No newline at end of file diff --git a/docs/data-model/types/locationfeaturespecification.md b/docs/data-model/types/locationfeaturespecification.md index 6962df6d..1b719113 100644 --- a/docs/data-model/types/locationfeaturespecification.md +++ b/docs/data-model/types/locationfeaturespecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "LocationFeatureSpecification" + Text + Must always be present and set to "type": "LocationFeatureSpecification"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Bike Shed"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Bike Shed" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/lockers.md b/docs/data-model/types/lockers.md index ad1972ce..6db45ee7 100644 --- a/docs/data-model/types/lockers.md +++ b/docs/data-model/types/lockers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Lockers" + Text + Must always be present and set to "type": "Lockers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Indoor Lockers"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Indoor Lockers" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/offer.md b/docs/data-model/types/offer.md index 3c608cdc..54853835 100644 --- a/docs/data-model/types/offer.md +++ b/docs/data-model/types/offer.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), ## **Fields** ### **Required fields** - + @@ -20,29 +20,33 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - - + - - + -
type - Text + type - Must always be present and set to "type": "Offer" + Text + Must always be present and set to "type": "Offer"
price - Float + price + Float -

The offer price of the activity.

This price should be specified without currency symbols and as a floating point number with two decimal places.

The currency of the price should be expressed in the priceCurrency field.


Example

"price": 33

+

The offer price of the activity.

+

This price should be specified without currency symbols and as a floating + point number with two decimal places.

+

The currency of the price should be expressed in the priceCurrency field.

+

+
Example +

+

"price": 33 +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,56 +57,82 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/offer/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/offer/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

name - Text + name + Text -

A human readable name for the offer.


Example

"name": "Speedball winger position"

+

A human readable name for the offer.

+

+
Example +

+

"name": "Speedball winger position" +

priceCurrency - Text + priceCurrency + Text -

The currency (in 3-letter ISO 4217 format) of the price.

If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified.


Example

"priceCurrency": "GBP"

+

The currency (in 3-letter ISO 4217 format) of the price.

+

If an Offer has a zero price, then this property is not required. Otherwise + the currency must be specified.

+

+
Example +

+

"priceCurrency": "GBP" +

url - url + url + url -

URL describing the offer


Example

"url": "http://www.rphs.org.uk/"

+

URL describing the offer

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- +### **Optional fields** -### **Optional fields** - @@ -113,33 +143,56 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + + - - + -
advanceBooking - RequiredStatusType + advanceBooking + RequiredStatusType -

Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either.


Example

"advanceBooking": "https://openactive.io/Required"

+

Indicates whether to accept this offer, a participant must book in advance, + whether they must pay on attending, or have option to do either.

+

+
Example +

+

"advanceBooking": "https://openactive.io/Required" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

prepayment - RequiredStatusType + prepayment + RequiredStatusType -

Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either.


Example

"prepayment": "https://openactive.io/Required"

+

Indicates whether to accept this offer, a participant must pay in advance, + pay when attending, or have the option to do either.

+

+
Example +

+

"prepayment": "https://openactive.io/Required" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/openinghoursspecification.md b/docs/data-model/types/openinghoursspecification.md index 1340d446..bf25b3da 100644 --- a/docs/data-model/types/openinghoursspecification.md +++ b/docs/data-model/types/openinghoursspecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ ## **Fields** ### **Required fields** - + @@ -20,42 +20,54 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ - - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "OpeningHoursSpecification" + Text + Must always be present and set to "type": "OpeningHoursSpecification"
closes - Time + closes + Time -

The closing time.


Example

"closes": "17:00"

+

The closing time.

+

+
Example +

+

"closes": "17:00" +

dayOfWeek - DayOfWeek + dayOfWeek + DayOfWeek -

Defines the day of the week upon which the Place is open


Example

"dayOfWeek": "https://schema.org/Monday"

+

Defines the day of the week upon which the Place is open

+

+
Example +

+

"dayOfWeek": "https://schema.org/Monday" +

opens - Time + opens + Time -

The opening time.


Example

"opens": "09:00"

+

The opening time.

+

+
Example +

+

"opens": "09:00" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/organization.md b/docs/data-model/types/organization.md index 2c7ef789..52c565df 100644 --- a/docs/data-model/types/organization.md +++ b/docs/data-model/types/organization.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O ## **Fields** ### **Required fields** - + @@ -20,29 +20,30 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - - + - - + -
type - Text + type - Must always be present and set to "type": "Organization" + Text + Must always be present and set to "type": "Organization"
name - Text + name + Text -

The name of the Organization


Example

"name": "Central Speedball Association"

+

The name of the Organization

+

+
Example +

+

"name": "Central Speedball Association" +

- +### **Recommended fields** -### **Recommended fields** - @@ -53,47 +54,65 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/organization/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/organization/12345" +

sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated with the organization.


Example

"sameAs": [
  "https://www.facebook.com/everyoneactive/",
  "https://twitter.com/everyoneactive"
]

+

Lists the URL(s) of the official social media profile pages associated + with the organization.

+

+
Example +

+

"sameAs": [
"https://www.facebook.com/everyoneactive/",
"https://twitter.com/everyoneactive"
] +

telephone - Text + telephone + Text -

The telephone number of the Organization


Example

"telephone": "01234 567890"

+

The telephone number of the Organization

+

+
Example +

+

"telephone": "01234 567890" +

url - url + url + url -

A definitive canonical URL for the Organization.


Example

"url": "http://www.speedball-world.com"

+

A definitive canonical URL for the Organization.

+

+
Example +

+

"url": "http://www.speedball-world.com" +

- +### **Optional fields** -### **Optional fields** - @@ -104,33 +123,54 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + + - - + -
description - Text + description + Text -

The description of the Organization


Example

"description": "The national governing body of cycling"

+

The description of the Organization

+

+
Example +

+

"description": "The national governing body of cycling" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

logo - ImageObject + logo + ImageObject -

A logo for the Organization.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

A logo for the Organization.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/parking.md b/docs/data-model/types/parking.md index 1d5b05bd..d18ce763 100644 --- a/docs/data-model/types/parking.md +++ b/docs/data-model/types/parking.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Parking" + Text + Must always be present and set to "type": "Parking"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Roadside Parking"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Roadside Parking" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/partialschedule.md b/docs/data-model/types/partialschedule.md index 852a2ca8..b8cc1d8c 100644 --- a/docs/data-model/types/partialschedule.md +++ b/docs/data-model/types/partialschedule.md @@ -9,31 +9,13 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "PartialSchedule" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "PartialSchedule"` | ### **Recommended fields** - + @@ -44,38 +26,51 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + -
endTime - Time + endTime + Time -

The end time of the event.


Example

"endTime": "12:00:00"

+

The end time of the event.

+

+
Example +

+

"endTime": "12:00:00" +

repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

startTime - Time + startTime + Time -

The start time of the event.


Example

"startTime": "12:00:00"

+

The start time of the event.

+

+
Example +

+

"startTime": "12:00:00" +

- +### **Optional fields** -### **Optional fields** - @@ -86,105 +81,172 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek
- or -
Array of Text + 		byDay + Array of DayOfWeek +
- or - +
Array of Text 		-

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - Date + endDate + Date -

The end date of the schedule.


Example

"endDate": "2018-01-27"

+

The end date of the schedule.

+

+
Example +

+

"endDate": "2018-01-27" +

exceptDate - Array of Date
- or -
Array of DateTime + 		exceptDate + Array of Date +
- or - +
Array of DateTime 		-

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]

+

Exception dates where the schedule should not generate an event.

+

+
Example +

+

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] +

idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + identifier (@id) for every event described by the schedule (see below for + more information). This property is required if the data provider is supporting + third-party booking via the Open Booking API.

+

+
Example +

+

"idTemplate": "https://example.com/event{/id}" +

repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3

+

Defines the number of times a recurring Event will take place.

+

+
Example +

+

"repeatCount": 3 +

scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.


Example

"scheduledEventType": "Event"

+

The type of event this schedule related to.

+

+
Example +

+

"scheduledEventType": "Event" +

startDate - Date + startDate + Date -

The start date of the event.


Example

"startDate": "2018-01-27"

+

The start date of the event.

+

+
Example +

+

"startDate": "2018-01-27" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + URL (schema:url) for every event described by the schedule (see below for + more information). This property is required if the data provider wants + to provide participants with a unique URL to book to attend an event.

+

+
Example +

+

"urlTemplate": "https://example.com/event{/id}" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/person.md b/docs/data-model/types/person.md index 9c59018e..032f9e42 100644 --- a/docs/data-model/types/person.md +++ b/docs/data-model/types/person.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "Person" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "Person"` | ### **Recommended fields** - + @@ -44,20 +26,22 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/person/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/person/12345" +

+### **Optional fields** - -### **Optional fields** - @@ -68,69 +52,113 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + - - - + + - - + - - + - - + - - + - - + -
description - Text + description + Text -

The description of the Person


Example

"description": "The leader of the coaching team"

+

The description of the Person

+

+
Example +

+

"description": "The leader of the coaching team" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

logo - ImageObject + logo + ImageObject -

A logo for the person.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}

+

A logo for the person.

+

+
Example +

+

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} +

name - Text + name + Text -

A full name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"name": "Daley Thompson"

+

A full name for the person.

+

This person must give direct permission for their personal information + to be shared as part of the Open Data.

+

+
Example +

+

"name": "Daley Thompson" +

sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated with the person.


Example

"sameAs": "https://example.org/example-org"

+

Lists the URL(s) of the official social media profile pages associated + with the person.

+

+
Example +

+

"sameAs": "https://example.org/example-org" +

telephone - Text + telephone + Text -

The telephone number of the person


Example

"telephone": "01234 567890"

+

The telephone number of the person

+

+
Example +

+

"telephone": "01234 567890" +

url - url + url + url -

A URL where more information about the person may be found


Example

"url": "http://www.example.com/"

+

A URL where more information about the person may be found

+

+
Example +

+

"url": "http://www.example.com/" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/place.md b/docs/data-model/types/place.md index 17beda2e..ebb91aca 100644 --- a/docs/data-model/types/place.md +++ b/docs/data-model/types/place.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), ## **Fields** ### **Required fields** - + @@ -20,28 +20,29 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - - + - - + -
type - Text + type - Must always be present and set to "type": "Place" + Text + Must always be present and set to "type": "Place"
name - Text + name + Text -

The name of the Place


Example

"name": "Raynes Park High School"

+

The name of the Place

+

+
Example +

+

"name": "Raynes Park High School" +

- - -### ** Required options ** +### **Required options** While these properties are marked as recommended in the specification, a data publisher must provide as much detail in both `address` and `geo` for an event as possible. @@ -55,29 +56,42 @@ While these properties are marked as recommended in the specification, a data pu - address - - PostalAddress
- or -
Text + address + + PostalAddress +
- or - +
Text -

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

- geo - - GeoCoordinates + geo + + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

- - +### **Recommended fields** -### **Recommended fields** - @@ -88,74 +102,100 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/place/12345" +

amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]

+

An array listing the Ammenities of the Place.

+

+
Example +

+

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] +

description - Text + description + Text -

The description of the Place


Example

"description": "Raynes Park High School in London"

+

The description of the Place

+

+
Example +

+

"description": "Raynes Park High School in London" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the place, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

openingHoursSpecification - Array of OpeningHoursSpecification + openingHoursSpecification -

The times the Place is open

+ 		Array of OpeningHoursSpecification The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place


Example

"telephone": "01253 473934"

+

The telephone number for the Place

+

+
Example +

+

"telephone": "01253 473934" +

url - url + url + url -

The website for the Place


Example

"url": "http://www.rphs.org.uk/"

+

The website for the Place

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- +### **Optional fields** -### **Optional fields** - @@ -166,51 +206,88 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - - - + + -
address - PostalAddress
- or -
Text + 		address + PostalAddress +
- or - +
Text 		-

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

containedInPlace - Place + containedInPlace + Place -

The place within which this Place exists


Example

"containedInPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
  "name": "Middlesbrough Sports Village"
}

+

The place within which this Place exists

+

+
Example +

+

"containedInPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
"name": "Middlesbrough Sports Village"
} +

containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}

+

Places that exist within this place

+

+
Example +

+

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} +

geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/postaladdress.md b/docs/data-model/types/postaladdress.md index 5b57322a..29028dc7 100644 --- a/docs/data-model/types/postaladdress.md +++ b/docs/data-model/types/postaladdress.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,60 +20,82 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "PostalAddress" + Text + Must always be present and set to "type": "PostalAddress"
addressCountry - Text + addressCountry + Text -

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.


Example

"addressCountry": "GB"

+

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.

+

+
Example +

+

"addressCountry": "GB" +

addressLocality - Text + addressLocality + Text -

The locality, a suburb within a city or a town within a county or district.


Example

"addressLocality": "Shoreditch"

+

The locality, a suburb within a city or a town within a county or district.

+

+
Example +

+

"addressLocality": "Shoreditch" +

addressRegion - Text + addressRegion + Text -

The region, either a city or a county or district.


Example

"addressRegion": "London"

+

The region, either a city or a county or district.

+

+
Example +

+

"addressRegion": "London" +

postalCode - Text + postalCode + Text -

The postal code.


Example

"postalCode": "EC2A 4JE"

+

The postal code.

+

+
Example +

+

"postalCode": "EC2A 4JE" +

streetAddress - Text + streetAddress + Text -

The street address.


Example

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St"

+

The street address.

+

+
Example +

+

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/propertyvalue.md b/docs/data-model/types/propertyvalue.md index 6719f4bb..24b8f082 100644 --- a/docs/data-model/types/propertyvalue.md +++ b/docs/data-model/types/propertyvalue.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,38 +20,46 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "PropertyValue" + Text + Must always be present and set to "type": "PropertyValue"
name - Text + name + Text -

The name of this PropertyValue


Example

"name": "Vendor ID"

+

The name of this PropertyValue

+

+
Example +

+

"name": "Vendor ID" +

value - Text
- or -
Integer + 		value + Text +
- or - +
Integer 		-

The actual value of this identifier


Example

"value": "SB1234"

+

The actual value of this identifier

+

+
Example +

+

"value": "SB1234" +

- +### **Optional fields** -### **Optional fields** - @@ -62,15 +70,20 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + -
propertyID - url
- or -
Text + 		propertyID + url +
- or - +
Text 		-

A commonly used identifier for the characteristic represented by the property


Example

"propertyID": "ActivePlaces"

+

A commonly used identifier for the characteristic represented by the property

+

+
Example +

+

"propertyID": "ActivePlaces" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/quantitativevalue.md b/docs/data-model/types/quantitativevalue.md index 28f57819..86fd4b4b 100644 --- a/docs/data-model/types/quantitativevalue.md +++ b/docs/data-model/types/quantitativevalue.md @@ -9,31 +9,13 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "QuantitativeValue" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "QuantitativeValue"` | ### **Optional fields** - + @@ -44,24 +26,32 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. - - + - - + -
maxValue - Integer + maxValue + Integer -

The maximum value.


Example

"maxValue": 60

+

The maximum value.

+

+
Example +

+

"maxValue": 60 +

minValue - Integer + minValue + Integer -

The minimum value.


Example

"minValue": 16

+

The minimum value.

+

+
Example +

+

"minValue": 16 +

- - + \ No newline at end of file diff --git a/docs/data-model/types/reserveaction.md b/docs/data-model/types/reserveaction.md index ad053fdd..24dbfc4d 100644 --- a/docs/data-model/types/reserveaction.md +++ b/docs/data-model/types/reserveaction.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,33 +20,40 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ - - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ReserveAction" + Text + Must always be present and set to "type": "ReserveAction"
name - Text + name + Text -

The name of the action


Example

"name": "Book"

+

The name of the action

+

+
Example +

+

"name": "Book" +

target - EntryPoint + target + EntryPoint -

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}

+

A definition of the target of the action.

+

+
Example +

+

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} +

- - + \ No newline at end of file diff --git a/docs/data-model/types/schedule.md b/docs/data-model/types/schedule.md index 77c89bd8..beb09f7c 100644 --- a/docs/data-model/types/schedule.md +++ b/docs/data-model/types/schedule.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - + @@ -20,46 +20,57 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Schedule" + Text + Must always be present and set to "type": "Schedule"
endTime - Time + endTime + Time -

The end time of the event.


Example

"endTime": "12:00:00"

+

The end time of the event.

+

+
Example +

+

"endTime": "12:00:00" +

scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.


Example

"scheduledEventType": "Event"

+

The type of event this schedule related to.

+

+
Example +

+

"scheduledEventType": "Event" +

startTime - Time + startTime + Time -

The start time of the event.


Example

"startTime": "12:00:00"

+

The start time of the event.

+

+
Example +

+

"startTime": "12:00:00" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional, a data publisher must provide either a `byDay`, `byMonth`, `byMonthDay` or `repeatFrequency` for a schedule. @@ -73,47 +84,71 @@ While these properties are marked as optional, a data publisher must provide eit - byDay - - Array of DayOfWeek
- or -
Array of Text + byDay + + Array of DayOfWeek +
- or - +
Array of Text -

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

- byMonth - - Array of Integer + byMonth + + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

- byMonthDay - - Array of Integer + byMonthDay + + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

- repeatFrequency - - Duration + repeatFrequency + + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

- - +### **Recommended fields** -### **Recommended fields** - @@ -124,56 +159,84 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - Date + endDate + Date -

The end date of the schedule.


Example

"endDate": "2018-01-27"

+

The end date of the schedule.

+

+
Example +

+

"endDate": "2018-01-27" +

idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + identifier (@id) for every event described by the schedule (see below for + more information). This property is required if the data provider is supporting + third-party booking via the Open Booking API.

+

+
Example +

+

"idTemplate": "https://example.com/event{/id}" +

startDate - Date + startDate + Date -

The start date of the event.


Example

"startDate": "2018-01-27"

+

The start date of the event.

+

+
Example +

+

"startDate": "2018-01-27" +

urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"

+

An RFC6570 compliant URI template that can be used to generate a unique + URL (schema:url) for every event described by the schedule (see below for + more information). This property is required if the data provider wants + to provide participants with a unique URL to book to attend an event.

+

+
Example +

+

"urlTemplate": "https://example.com/event{/id}" +

- +### **Optional fields** -### **Optional fields** - @@ -184,60 +247,97 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek
- or -
Array of Text + 		byDay + Array of DayOfWeek +
- or - +
Array of Text 		-

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

+

Defines the day of the week upon which the Event takes place.

+

When using string values, this MUST conform to iCal BYDAY rule.

+

+
Example +

+

"byDay": [
"https://schema.org/Monday"
] +

byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

+

Defines the months of the year on which the Event takes place. Specified + as an integer between 1 and 12, with 1 representing January.

+

+
Example +

+

"byMonth": [
2
] +

byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

+

Defines the days of the month on which the Event takes place. Specified + as an integer between 1 and 31

+

+
Example +

+

"byMonthDay": [
28
] +

exceptDate - Array of Date
- or -
Array of DateTime + 		exceptDate + Array of Date +
- or - +
Array of DateTime 		-

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]

+

Exception dates where the schedule should not generate an event.

+

+
Example +

+

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] +

repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3

+

Defines the number of times a recurring Event will take place.

+

+
Example +

+

"repeatCount": 3 +

repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

+

Defines the frequency at which Events will occur according to a Schedule. + The intervals between events should be defined as a Duration of time.

+

+
Example +

+

"repeatFrequency": "P1D" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/scheduledsession.md b/docs/data-model/types/scheduledsession.md index 6c219234..50d8a17d 100644 --- a/docs/data-model/types/scheduledsession.md +++ b/docs/data-model/types/scheduledsession.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,56 +20,84 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "ScheduledSession" + Text + Must always be present and set to "type": "ScheduledSession"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- +### **Recommended fields** -### **Recommended fields** - @@ -80,83 +108,129 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

+

The number of places that are still available for the Event.

+

+
Example +

+

"remainingAttendeeCapacity": 20 +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Optional fields** -### **Optional fields** - @@ -167,195 +241,332 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/sessionseries.md b/docs/data-model/types/sessionseries.md index d75d43b4..957cd171 100644 --- a/docs/data-model/types/sessionseries.md +++ b/docs/data-model/types/sessionseries.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,74 +20,113 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - + - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "SessionSeries" + Text + Must always be present and set to "type": "SessionSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]

+

Specifies the physical activity or activities that will take place during + an event.

+

+
Example +

+

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] +

location - Place + location + Place -

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}

+

The location at which the event will take place. Or, in the case of events + that may span multiple locations, the initial meeting or starting point.

+

It is recommended that locations should be specified as a Place complete + with a fully described geographic location and/or address.If only an address + is available then this should be described as a PostalAddress.

+

Applications may use schema:Text to + provide a more general description of a location ("In Victoria Park, near + the lake"), but this is not recommended: consuming applications will be + unable to help users discover opportunities based on their location.

+

+
Example +

+

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} +

name - Text + name + Text -

The name of the event


Example

"name": "Speedball"

+

The name of the event

+

+
Example +

+

"name": "Speedball" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+

An array of schema:Offer that include the price of attending.

+

+
Example +

+

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] +

organizer - Organization
- or -
Person + 		organizer + Organization +
- or - +
Person 		-

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

+

The person or organization ultimately responsible for an event. An organizer + might be an schema:Organization or a schema:Person.

+

+
Example +

+

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} +

url - url + url + url -

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

+

A URL to a web page (or section of a page) that describes the event.

+

+
Example +

+

"url": "https://example.com/event/1234" +

- +### **Recommended fields** -### **Recommended fields** - @@ -98,74 +137,118 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/event/12345" +

ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}

+

Indicates that an event is suitable for a specific age range. If only + a single age is specified then this is assumed to be a minimum age. Age + ranges can be specified as follows: 18-30

+

+
Example +

+

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} +

description - Text + description + Text -

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."

+

A free text description of the event

+

+
Example +

+

"description": "An fast paced game that incorporates netball, handball and football." +

genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"

+

Indicates that an event is restricted to male, female or a mixed audience. + If a gender restriction isn't specified then applications should assume + that an event is suitable for a mixed audience

+

+
Example +

+

"genderRestriction": "https://openactive.io/FemaleOnly" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]

+

An image or photo that depicts the event, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] +

leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

Refers to a person (schema:Person) who will be leading an event. E.g. + a coach. This is a more specific role than an organiser or a contributor. + The person will need to have given their consent for their personal information + to be present in the Open Data.

+

+
Example +

+

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

level - Array of Text
- or -
Array of Concept + 		level + Array of Text +
- or - +
Array of Concept 		-

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

"level": [
  "beginner"
]

+

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 +

+

"level": [
"beginner"
] +

- +### **Optional fields** -### **Optional fields** - @@ -176,195 +259,324 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - + - - - + -
@context - url
- or -
Array of url + 		@context + url +
- or - +
Array of url 		-

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"

+

This must be included in the top-most entity in the JSON model.

+

+
Example +

+

"@context": "https://openactive.io/" +

accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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."

+

Provide additional, specific documentation for participants about how + disabilities are, or can be supported at the Event.

+

+
Example +

+

"accessibilityInformation": "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 - Array of Text
- or -
Array of Concept + 		accessibilitySupport + Array of Text +
- or - +
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]

+

Used to specify the types of disabilities or impairments that are supported + at an event.

+

+
Example +

+

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] +

attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

+

Provides additional notes and instructions for event attendees. E.g. more + information on how to find the event, what to bring, etc.

+

+
Example +

+

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." +

category - Array of Concept
- or -
Array of Text + 		category + Array of Concept +
- or - +
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]

+

Provides a set of tags that help categorise and describe an event, e.g. + its intensity, purpose, etc.

+

+
Example +

+

"category": [
"High Intensity"
] +

contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]

+

A Person who contributes to the facilitation of the Event.

+

+
Example +

+

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] +

duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the event given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the event. Can be specified as a schema:Date + or schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an event.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence + pattern.

+

+
Example +

+

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] +

eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"

+

The status of an event. Can be used to indicate rescheduled or cancelled + events

+

+
Example +

+

"eventStatus": "https://schema.org/EventScheduled" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"

+

Whether the Event is accessible without charge.

+

+
Example +

+

"isAccessibleForFree": "true" +

isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"

+

A boolean property that indicates whether an Event will be coached. This + flag allows an Event to be marked as being coached without having to specify + a named individual as a coach. This addresses both privacy concerns and + also scenarios where the actual coach may only be decided on the day.

+

+
Example +

+

"isCoached": "true" +

maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+

The maximum capacity of the Event.

+

+
Example +

+

"maximumAttendeeCapacity": 30 +

meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

+

Instructions for the attendees of an Event about where they should meet + the organizer or leader at the start of the event. Some larger locations + may have several possible meeting points, so this property provides additional + more specific directions.

+

+
Example +

+

"meetingPoint": "At the entrance to the park" +

potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]

+

The possible actions that a user may make. e.g. Book.

+

+
Example +

+

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] +

programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

+

Indicates that an event will be organised according to a specific Programme.

+

+
Example +

+

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} +

schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"

+

Provides a note from an organizer relating to how this Event is scheduled.

+

+
Example +

+

"schedulingNote": "This event doesn't run during school holidays" +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the event. Can be specified as a schema:Date + or schema:DateTime.

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

subEvent - Array of ScheduledSession + subEvent -

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

+ 		Array of ScheduledSession Relates a parent event to a child event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A child event might be a specific instance of an Event within a schedule
superEvent - Event + superEvent -

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

+ 		Event Relates a child event to a parent event. Properties describing the parent + event can be assumed to apply to the child, unless otherwise specified. + A parent event might specify a recurring schedule, of which the child event + is one specific instance
- - + \ No newline at end of file diff --git a/docs/data-model/types/showers.md b/docs/data-model/types/showers.md index 33f60e9c..2f7579e1 100644 --- a/docs/data-model/types/showers.md +++ b/docs/data-model/types/showers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Showers" + Text + Must always be present and set to "type": "Showers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Poolside Showers"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Poolside Showers" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/slot.md b/docs/data-model/types/slot.md index 1e0e4c96..ab9af02c 100644 --- a/docs/data-model/types/slot.md +++ b/docs/data-model/types/slot.md @@ -4,12 +4,10 @@ description: This page describes the Slot type. # Slot - - ## **Fields** ### **Required fields** - + @@ -20,64 +18,89 @@ description: This page describes the Slot type. - - - + - - + - - + - - + - - + - - + -
type - Text + type - Must always be present and set to "type": "Slot" + Text + Must always be present and set to "type": "Slot"
duration - Duration + duration + Duration -

The duration of the slot given in [ISO8601] format.


Example

"duration": "PT1H"

+

The duration of the slot given in [ISO8601] format.

+

+
Example +

+

"duration": "PT1H" +

facilityUse - url + facilityUse + url -

URI to the FacilityUse that has this offer


Example

"facilityUse": "https://example.com/facility-use/1"

+

URI to the FacilityUse that has this offer

+

+
Example +

+

"facilityUse": "https://example.com/facility-use/1" +

offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}

+

An array of schema:Offer that include the price of booking.

+

+
Example +

+

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} +

remainingUses - Integer + remainingUses + Integer -

The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"remainingUses": 5

+

The remaining available courts or pitches at this time. Must be 0 or 1 + for an IndividualFacilityUse.

+

+
Example +

+

"remainingUses": 5 +

startDate - DateTime
- or -
Date + 		startDate + DateTime +
- or - +
Date 		-

The start date and time of the slot. Can be specified as a schema:Date or schema:DateTime


Example

"startDate": "2018-01-27T12:00:00Z"

+

The start date and time of the slot. Can be specified as a schema:Date + or schema:DateTime

+

+
Example +

+

"startDate": "2018-01-27T12:00:00Z" +

- - -### ** Required options ** +### **Required options** While these properties are marked as optional/recommended in the Modelling Specification, one of these must be provided when surfacing a slot through an RPDE feed to ensure that the slots can be processed correctly by data consumers. @@ -91,29 +114,44 @@ While these properties are marked as optional/recommended in the Modelling Speci - id - - url + id + + url -

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/slot/12345" +

- identifier - - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + identifier + + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer -

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- +### **Recommended fields** - -### **Recommended fields** - @@ -124,29 +162,37 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/slot/12345" +

maximumUses - Integer + maximumUses + Integer -

The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"maximumUses": 16

+

The maximum available courts or pitches at this time. Must be 0 or 1 for + an IndividualFacilityUse.

+

+
Example +

+

"maximumUses": 16 +

- +### **Optional fields** -### **Optional fields** - @@ -157,24 +203,45 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
endDate - DateTime
- or -
Date + 		endDate + DateTime +
- or - +
Date 		-

The end date and time of the slot. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an slot.


Example

"endDate": "2018-01-27T12:00:00Z"

+

The end date and time of the slot. Can be specified as a schema:Date or + schema:DateTime

+

It is recommended that publishers provide either an schema:endDate or + a schema:duration for an slot.

+

+
Example +

+

"endDate": "2018-01-27T12:00:00Z" +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/sportsactivitylocation.md b/docs/data-model/types/sportsactivitylocation.md index 8aeb6e17..9ba98a91 100644 --- a/docs/data-model/types/sportsactivitylocation.md +++ b/docs/data-model/types/sportsactivitylocation.md @@ -9,30 +9,12 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc ## **Fields** ### **Required fields** - - - - - - - - - - - - - - - - -
PropertyExpected TypeDescription
type - Text - - Must always be present and set to "type": "SportsActivityLocation" -
+| Property | Expected Type | Description | +| :--- | :--- | :--- | +| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "SportsActivityLocation"` | -### ** Required options ** +### **Required options** While these properties are marked as recommended in the specification, a data publisher must provide as much detail in both `address` and `geo` for an event as possible. @@ -46,29 +28,42 @@ While these properties are marked as recommended in the specification, a data pu - address - - PostalAddress
- or -
Text + address + + PostalAddress +
- or - +
Text -

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

- geo - - GeoCoordinates + geo + + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

- +### **Recommended fields** - -### **Recommended fields** - @@ -79,20 +74,22 @@ While these properties are marked as recommended in the specification, a data pu - - + -
id - url + id + url -

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"

+

A unique url based identifier for the record

+

+
Example +

+

"id": "https://example.com/place/12345" +

+### **Optional fields** - -### **Optional fields** - @@ -103,114 +100,184 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - - + - - + - - - + + - - + - - + - - - + - - + - - + -
address - PostalAddress
- or -
Text + 		address + PostalAddress +
- or - +
Text 		-

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

+

A structured PostalAddress object for the Place.

+

Ideally the address should be provided using the PostalAddress structured + format. Google Reserve requires https://schema.org/PostalAddress and + will not accept plain text addresses.

+

+
Example +

+

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} +

amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]

+

An array listing the Ammenities of the Place.

+

+
Example +

+

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] +

containedInPlace - Place
- or -
url + 		containedInPlace + Place +
- or - +
url 		-

While a url is not specified as an option in the Modelling Specification, it is necessary to link entities in RPDE.


Example

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d"

+

While a url is not specified as an option in the Modelling + Specification, it is necessary to link entities in RPDE.

+

+
Example +

+

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d" +

containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}

+

Places that exist within this place

+

+
Example +

+

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} +

description - Text + description + Text -

The description of the Place


Example

"description": "Raynes Park High School in London"

+

The description of the Place

+

+
Example +

+

"description": "Raynes Park High School in London" +

geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

+

The geo coordinates of the Place.

+

+
Example +

+

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} +

identifier - Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer - 		-

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

+ 		identifier + Text +
- or - +
PropertyValue +
- or - +
Array of PropertyValue +
- or - +
Integer + 		+

A local non-URI identifier for the resource

+

+
Example +

+

"identifier": "SB1234" +

image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]

+

An image or photo that depicts the place, e.g. a photo taken at a previous + event.

+

+
Example +

+

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] +

name - Text + name + Text -

The name of the Place


Example

"name": "Raynes Park High School"

+

The name of the Place

+

+
Example +

+

"name": "Raynes Park High School" +

openingHoursSpecification - Array of OpeningHoursSpecification + openingHoursSpecification -

The times the Place is open

+ 		Array of OpeningHoursSpecification The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place


Example

"telephone": "01253 473934"

+

The telephone number for the Place

+

+
Example +

+

"telephone": "01253 473934" +

url - url + url + url -

The website for the Place


Example

"url": "http://www.rphs.org.uk/"

+

The website for the Place

+

+
Example +

+

"url": "http://www.rphs.org.uk/" +

- - + \ No newline at end of file diff --git a/docs/data-model/types/toilets.md b/docs/data-model/types/toilets.md index f5248106..f8e164c9 100644 --- a/docs/data-model/types/toilets.md +++ b/docs/data-model/types/toilets.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Toilets" + Text + Must always be present and set to "type": "Toilets"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Public Toilets"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Public Toilets" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file diff --git a/docs/data-model/types/towels.md b/docs/data-model/types/towels.md index 063eb9c0..14fb351e 100644 --- a/docs/data-model/types/towels.md +++ b/docs/data-model/types/towels.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - - + - - + - - - + -
type - Text + type - Must always be present and set to "type": "Towels" + Text + Must always be present and set to "type": "Towels"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.


Example

"name": "Complementary Towels"

+

A string, suitable for presentation in user interfaces.

+

+
Example +

+

"name": "Complementary Towels" +

value - Boolean + value -

A boolean value indicating whether this ammenity is available.

+ 		Boolean A boolean value indicating whether this ammenity is available.
- - + \ No newline at end of file From e75ab652b3e7eea185e355d55e984420f6c3168e Mon Sep 17 00:00:00 2001 From: Travis CI Date: Tue, 13 Nov 2018 17:24:07 +0000 Subject: [PATCH 10/10] Updating auto-generated model documentation: 80 [ci skip] --- docs/data-model/types/action.md | 41 +- docs/data-model/types/babychanging.md | 36 +- docs/data-model/types/brand.md | 98 ++- docs/data-model/types/changingfacilities.md | 36 +- docs/data-model/types/concept.md | 118 ++-- docs/data-model/types/conceptscheme.md | 101 ++- docs/data-model/types/courseinstance.md | 570 ++++++----------- docs/data-model/types/creche.md | 36 +- docs/data-model/types/entrypoint.md | 51 +- docs/data-model/types/event.md | 570 ++++++----------- docs/data-model/types/eventseries.md | 576 ++++++------------ docs/data-model/types/facilityuse.md | 295 +++------ docs/data-model/types/geocoordinates.md | 41 +- docs/data-model/types/headlineevent.md | 521 +++++----------- docs/data-model/types/imageobject.md | 51 +- .../data-model/types/individualfacilityuse.md | 290 +++------ .../types/locationfeaturespecification.md | 36 +- docs/data-model/types/lockers.md | 36 +- docs/data-model/types/offer.md | 163 ++--- .../types/openinghoursspecification.md | 54 +- docs/data-model/types/organization.md | 149 ++--- docs/data-model/types/parking.md | 36 +- docs/data-model/types/partialschedule.md | 232 +++---- docs/data-model/types/person.md | 168 +++-- docs/data-model/types/place.md | 245 +++----- docs/data-model/types/postaladdress.md | 80 +-- docs/data-model/types/propertyvalue.md | 63 +- docs/data-model/types/quantitativevalue.md | 56 +- docs/data-model/types/reserveaction.md | 41 +- docs/data-model/types/schedule.md | 286 +++------ docs/data-model/types/scheduledsession.md | 529 +++++----------- docs/data-model/types/sessionseries.md | 522 +++++----------- docs/data-model/types/showers.md | 36 +- docs/data-model/types/slot.md | 201 ++---- .../types/sportsactivitylocation.md | 238 +++----- docs/data-model/types/toilets.md | 36 +- docs/data-model/types/towels.md | 36 +- 37 files changed, 2293 insertions(+), 4381 deletions(-) diff --git a/docs/data-model/types/action.md b/docs/data-model/types/action.md index 69ab11b0..6a2d7d3c 100644 --- a/docs/data-model/types/action.md +++ b/docs/data-model/types/action.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/Action](https://schema.org/Action) - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Action" + + Must always be present and set to "type": "Action"
name - Text + name + Text -

The name of the action

-

-
Example -

-

"name": "Book" -

+

The name of the action


Example

"name": "Book"
target - EntryPoint + target + EntryPoint -

A definition of the target of the action.

-

-
Example -

-

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} -

+

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/babychanging.md b/docs/data-model/types/babychanging.md index 96aacca1..afddc50c 100644 --- a/docs/data-model/types/babychanging.md +++ b/docs/data-model/types/babychanging.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "BabyChanging" + + Must always be present and set to "type": "BabyChanging"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Baby Changing Facilities" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Baby Changing Facilities"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/brand.md b/docs/data-model/types/brand.md index c4584376..80615e68 100644 --- a/docs/data-model/types/brand.md +++ b/docs/data-model/types/brand.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), ## **Fields** ### **Required fields** - + @@ -20,44 +20,38 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Brand" + + Must always be present and set to "type": "Brand"
name - Text + name + Text -

The name of the brand.

-

-
Example -

-

"name": "Play Ball!" -

+

The name of the brand.


Example

"name": "Play Ball!"
url - url + url + url -

A url where further information can be found for the brand.

-

-
Example -

-

"url": "http://example.com/play_ball" -

+

A url where further information can be found for the brand.


Example

"url": "http://example.com/play_ball"
### **Recommended fields** + + +### **Recommended fields** + @@ -68,36 +62,29 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + - - + -
description - Text + description + Text -

A text description for the brand.

-

-
Example -

-

"description": "Play Ball! is a series of games for people of all abilities." -

+

A text description for the brand.


Example

"description": "Play Ball! is a series of games for people of all abilities."
logo - ImageObject + logo + ImageObject -

The logo associated with the brand.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

The logo associated with the brand.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
### **Optional fields** + + +### **Optional fields** + @@ -108,26 +95,15 @@ This type is derived from [https://schema.org/Brand](https://schema.org/Brand), - - + -
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "BR1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "BR1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/changingfacilities.md b/docs/data-model/types/changingfacilities.md index c6a201ef..2b65ac39 100644 --- a/docs/data-model/types/changingfacilities.md +++ b/docs/data-model/types/changingfacilities.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "ChangingFacilities" + + Must always be present and set to "type": "ChangingFacilities"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Changing Rooms" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Changing Rooms"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/concept.md b/docs/data-model/types/concept.md index 8fe8e544..367ffb27 100644 --- a/docs/data-model/types/concept.md +++ b/docs/data-model/types/concept.md @@ -4,12 +4,12 @@ description: This page describes the Concept type. # Concept -This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http://www.w3.org/2004/02/skos/core#Concept). +This type is derived from [http://www.w3.org/2004/02/skos/core#Concept](http://www.w3.org/2004/02/skos/core#Concept). ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Concept" + + Must always be present and set to "type": "Concept"
prefLabel - Text + prefLabel + Text -

A human readable string for use in user interfaces.

-

-
Example -

-

"prefLabel": "Speedball" -

+

A human readable string for use in user interfaces.


Example

"prefLabel": "Speedball"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,36 +53,29 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/concept/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/concept/12345"
inScheme - url + inScheme + url -

A stable URL reference for the taxonomy.

-

-
Example -

-

"inScheme": "https://example.com/reference/activities" -

+

A stable URL reference for the taxonomy.


Example

"inScheme": "https://example.com/reference/activities"
### **Optional fields** + + +### **Optional fields** + @@ -94,60 +86,42 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#Concept](http:// - - + - - + - - + - - + -
altLabel - Array of Text + altLabel + Array of Text -

An alternative human readable string for use in user interfaces.

-

-
Example -

-

"altLabel": "Speedball" -

+

An alternative human readable string for use in user interfaces.


Example

"altLabel": "Speedball"
broader - Array of url + broader + Array of url -

A broader Concept URI

-

-
Example -

-

"broader": "https://example.com/football" -

+

A broader Concept URI


Example

"broader": "https://example.com/football"
narrower - Array of url + narrower + Array of url -

A more specific concept URI

-

-
Example -

-

"narrower": "https://example.com/walking-football" -

+

A more specific concept URI


Example

"narrower": "https://example.com/walking-football"
notation - Text + notation + Text -

A concept label that is not normally recognisable as natural language.

-

-
Example -

-

"notation": "Speedball" -

+

A concept label that is not normally recognisable as natural language.


Example

"notation": "Speedball"
\ No newline at end of file + + + diff --git a/docs/data-model/types/conceptscheme.md b/docs/data-model/types/conceptscheme.md index aa531e69..d3acfe5e 100644 --- a/docs/data-model/types/conceptscheme.md +++ b/docs/data-model/types/conceptscheme.md @@ -4,12 +4,12 @@ description: This page describes the ConceptScheme type. # ConceptScheme -This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). +This type is derived from [http://www.w3.org/2004/02/skos/core#ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme). ## **Fields** ### **Required fields** - + @@ -20,73 +20,56 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](h - - + - - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ConceptScheme" + + Must always be present and set to "type": "ConceptScheme"
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/scheme/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/scheme/12345"
concept - Array of Concept + concept + Array of Concept -

A collection of concepts that are part of this scheme

-

-
Example -

-

"concept": [
{
"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"
}
] -

+

A collection of concepts that are part of this scheme


Example

"concept": [
  {
    "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"
  }
]
title - Text + title + Text -

The title of the scheme

-

-
Example -

-

"title": "Activity List" -

+

The title of the scheme


Example

"title": "Activity List"
url - url + url + url -

A URL to a web page (or section of a page) that describes the concept - scheme.

-

-
Example -

-

"url": "https://example.com/scheme/1234" -

+

A URL to a web page (or section of a page) that describes the concept scheme.


Example

"url": "https://example.com/scheme/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -97,32 +80,24 @@ This type is derived from [http://www.w3.org/2004/02/skos/core\#ConceptScheme](h - - + - - + -
description - Text + description + Text -

A free text description of the taxonomy

-

-
Example -

-

"description": "An example activity list." -

+

A free text description of the taxonomy


Example

"description": "An example activity list."
license - url + license + url -

Reference to the license under which the activity list has been published.

-

-
Example -

-

"license": "https://example.com/license/MIT" -

+

Reference to the license under which the activity list has been published.


Example

"license": "https://example.com/license/MIT"
\ No newline at end of file + + + diff --git a/docs/data-model/types/courseinstance.md b/docs/data-model/types/courseinstance.md index b7ffb054..027eaabf 100644 --- a/docs/data-model/types/courseinstance.md +++ b/docs/data-model/types/courseinstance.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe ## **Fields** ### **Required fields** - + @@ -20,112 +20,73 @@ This type is derived from [https://pending.schema.org/CourseInstance](https://pe - - + - - - + - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "CourseInstance" + + Must always be present and set to "type": "CourseInstance"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional in the specification, a data publisher must provide either a `startDate` or specify an `eventSchedule` for an event. @@ -139,40 +100,29 @@ While these properties are marked as optional in the specification, a data publi - startDate - - DateTime -
- or - -
Date + startDate + + DateTime
- or -
Date -

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

-### **Recommended fields** + + +### **Recommended fields** + @@ -183,197 +133,119 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "gender": "https://schema.org/Male",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Optional fields** + + +### **Optional fields** + @@ -384,259 +256,159 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/creche.md b/docs/data-model/types/creche.md index 1023ec78..2ee2db11 100644 --- a/docs/data-model/types/creche.md +++ b/docs/data-model/types/creche.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Creche" + + Must always be present and set to "type": "Creche"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Childcare" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Childcare"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/entrypoint.md b/docs/data-model/types/entrypoint.md index e487be2c..960e3c97 100644 --- a/docs/data-model/types/entrypoint.md +++ b/docs/data-model/types/entrypoint.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent ## **Fields** ### **Required fields** - + @@ -20,49 +20,42 @@ This type is derived from [https://schema.org/EntryPoint](https://schema.org/Ent - - + - - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "EntryPoint" + + Must always be present and set to "type": "EntryPoint"
encodingType - Text + encodingType + Text Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json" + + Must always be present and set to "encodingType": "application/vnd.openactive.v1.0+json"
httpMethod - Text + httpMethod + Text -

An HTTP method that specifies the appropriate HTTP method for a request - to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.

-

-
Example -

-

"httpMethod": "POST" -

+

An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP.


Example

"httpMethod": "POST"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

URL of the item

-

-
Example -

-

"urlTemplate": "https://example.com/orders{/var}" -

+

URL of the item


Example

"urlTemplate": "https://example.com/orders{/var}"
\ No newline at end of file + + + diff --git a/docs/data-model/types/event.md b/docs/data-model/types/event.md index 88e47bbd..29d47fd3 100644 --- a/docs/data-model/types/event.md +++ b/docs/data-model/types/event.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,112 +20,73 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Event" + + Must always be present and set to "type": "Event"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional in the specification, a data publisher must provide either a `startDate` or specify an `eventSchedule` for an event. @@ -139,40 +100,29 @@ While these properties are marked as optional in the specification, a data publi - startDate - - DateTime -
- or - -
Date + startDate + + DateTime
- or -
Date -

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

- eventSchedule - - Array of Schedule + eventSchedule + + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]

-### **Recommended fields** + + +### **Recommended fields** + @@ -183,197 +133,119 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "gender": "https://schema.org/Male",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Optional fields** + + +### **Optional fields** + @@ -384,259 +256,159 @@ While these properties are marked as optional in the specification, a data publi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/eventseries.md b/docs/data-model/types/eventseries.md index 8134253a..8ae0da99 100644 --- a/docs/data-model/types/eventseries.md +++ b/docs/data-model/types/eventseries.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi ## **Fields** ### **Required fields** - + @@ -20,76 +20,48 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - - - - - - + - - + - - + - - + -
type - Text - Must always be present and set to "type": "EventSeries" -
activity - Array of Concept + type + Text -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+ Must always be present and set to "type": "EventSeries"
name - Text + activity + Array of Concept -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
organizer - Organization -
- or - -
Person + 		name + Text -

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The name of the event


Example

"name": "Speedball"
url - url + organizer + Organization
- or -
Person 		-

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
### **Recommended fields** + + + +### ** Required options ** + +An `id` and/or `identifier` must be provided in order to allow data users to group `EventSeries` together consistently. @@ -101,175 +73,116 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + + +
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
+ + +### **Recommended fields** + + + - - - + + + + + - - + - - + - - + - - + - - + - - + - - + - - + -
description - Text - -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

- 		PropertyExpected TypeDescription
eventStatus - EventStatusType + id + url -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
genderRestriction - GenderRestrictionType + ageRange + QuantitativeValue -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
image - Array of ImageObject + description + Text -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
leader - Array of Person + genderRestriction + GenderRestrictionType -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
level - Array of Text -
- or - -
Array of Concept + 		image + Array of ImageObject -

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 -

-

"level": [
"beginner"
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
maximumAttendeeCapacity - Integer + isCoached + Boolean -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
offers - Array of Offer + level + Array of Text
- or -
Array of Concept 		-

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

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

"level": [
  "beginner"
]
remainingAttendeeCapacity - Integer + programme + Brand -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
### **Optional fields** + + +### **Optional fields** + @@ -280,317 +193,222 @@ This type is derived from [https://pending.schema.org/EventSeries](https://pendi - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - + + + + - + - + + + + - + - + + + + - + + - + + + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		eventStatus + EventStatusType -

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
isAccessibleForFree - Boolean + identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isCoached - Boolean + isAccessibleForFree + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
location - Place + leader + Array of Person -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "gender": "https://schema.org/Male",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
meetingPoint - Text + location + Place -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
potentialAction + maximumAttendeeCapacity + Integer Array of Action + +

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30

+
meetingPoint + Text -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
programme + offers + Array of Offer Brand + +

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]

+
potentialAction + Array of Action -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
schedulingNote + remainingAttendeeCapacity + Integer Text + +

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20

schedulingNote -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+ Text + 		+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
startDate + startDate + DateTime
- or -
Date + 		+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"

 DateTime -
- or - -
Date +
subEvent + Array of Event -

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule
subEvent + superEvent + Event Array of Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + url + url Event + +

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/facilityuse.md b/docs/data-model/types/facilityuse.md index f7887176..a0d843b4 100644 --- a/docs/data-model/types/facilityuse.md +++ b/docs/data-model/types/facilityuse.md @@ -4,10 +4,12 @@ description: This page describes the FacilityUse type. # FacilityUse + + ## **Fields** ### **Required fields** - + @@ -18,87 +20,65 @@ description: This page describes the FacilityUse type. - - + - - - + - - + - - + - + - - - + -
type - Text + type + Text Must always be present and set to "type": "FacilityUse" + + Must always be present and set to "type": "FacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - a facility use.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the facility use will take place.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the facility use

-

-
Example -

-

"name": "Speedball" -

+

The name of the facility use


Example

"name": "Speedball"
provider + provider + -

The organisation responsible for providing the facility

-

-
Example -

-

"provider": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The organisation responsible for providing the facility


Example

"provider": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility - use.

-

-
Example -

-

"url": "https://example.com/facility-use/1234" -

+

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -109,86 +89,65 @@ description: This page describes the FacilityUse type. - - + - - + - - + - + - - - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/facility-use/112345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"
description - Text + description + Text -

A free text description of the facility use

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."
event - Array of Slot + event + Array of Slot -

An array of slots of availability of this FacilityUse.

-

-
Example -

-

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 3,
"maximumUses": 6
}
] -

+

An array of slots of availability of this FacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 3,
    "maximumUses": 6
  }
]
hoursAvailable + hoursAvailable + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the facility use is available

The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at - a previous event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
### **Optional fields** + + +### **Optional fields** + @@ -199,136 +158,78 @@ description: This page describes the FacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. - more information on how to find it, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." -

+

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.

-

-
Example -

-

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] -

+

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
individualFacilityUse - Array of IndividualFacilityUse + individualFacilityUse + Array of IndividualFacilityUse -

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse - (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse - (e.g. an opportunity to play tennis on a specific court).

-

-
Example -

-

"individualFacilityUse": [
{
"type": "IndividualFacilityUse",
"id": "http://www.example.org/facility-uses/1",
"name": "Tennis Court 1"
}
] -

+

Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court).


Example

"individualFacilityUse": [
  {
    "type": "IndividualFacilityUse",
    "id": "http://www.example.org/facility-uses/1",
    "name": "Tennis Court 1"
  }
]
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
\ No newline at end of file + + + diff --git a/docs/data-model/types/geocoordinates.md b/docs/data-model/types/geocoordinates.md index 279b2904..8d98bd79 100644 --- a/docs/data-model/types/geocoordinates.md +++ b/docs/data-model/types/geocoordinates.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/GeoCoordinates](https://schema.org - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "GeoCoordinates" + + Must always be present and set to "type": "GeoCoordinates"
latitude - Float + latitude + Float -

The latitude of a location. For example 51.522338 (WGS 84).

-

-
Example -

-

"latitude": 51.522338 -

+

The latitude of a location. For example 51.522338 (WGS 84).


Example

"latitude": 51.522338
longitude - Float + longitude + Float -

The longitude of a location. For example -0.083437 (WGS 84).

-

-
Example -

-

"longitude": -0.083437 -

+

The longitude of a location. For example -0.083437 (WGS 84).


Example

"longitude": -0.083437
\ No newline at end of file + + + diff --git a/docs/data-model/types/headlineevent.md b/docs/data-model/types/headlineevent.md index df8242dd..b1b4e3a1 100644 --- a/docs/data-model/types/headlineevent.md +++ b/docs/data-model/types/headlineevent.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,116 +20,74 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "HeadlineEvent" + + Must always be present and set to "type": "HeadlineEvent"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -140,194 +98,119 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "gender": "https://schema.org/Male",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
### **Optional fields** + + +### **Optional fields** + @@ -338,244 +221,150 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
subEvent + subEvent + Array of Event Array of Event + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/imageobject.md b/docs/data-model/types/imageobject.md index 3d0cafa7..cdbb0626 100644 --- a/docs/data-model/types/imageobject.md +++ b/docs/data-model/types/imageobject.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im ## **Fields** ### **Required fields** - + @@ -20,31 +20,48 @@ This type is derived from [https://schema.org/ImageObject](https://schema.org/Im - - + - - + - + + +
type - Text + type + Text Must always be present and set to "type": "ImageObject" + + Must always be present and set to "type": "ImageObject"
url + url + url url + +

The URL for the display resolution image.


Example

"url": "http://example.com/static/image/speedball_large.jpg"

+
+ + +### **Optional fields** + + + + + + + + + + + + + -
PropertyExpected TypeDescription
thumbnail + Array of ImageObject -

The URL for the display resolution image.

-

-
Example -

-

"url": "http://example.com/static/image/speedball_large.jpg" -

+

The URL for a thumbnail image for an image.
### **Optional fields** + -| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **thumbnail** | Array of [`ImageObject`](https://docs.openactive.io/data-model/types/imageobject) | The URL for a thumbnail image for an image. | diff --git a/docs/data-model/types/individualfacilityuse.md b/docs/data-model/types/individualfacilityuse.md index 28c8a1ef..bbab228a 100644 --- a/docs/data-model/types/individualfacilityuse.md +++ b/docs/data-model/types/individualfacilityuse.md @@ -4,10 +4,12 @@ description: This page describes the IndividualFacilityUse type. # IndividualFacilityUse + + ## **Fields** ### **Required fields** - + @@ -18,87 +20,65 @@ description: This page describes the IndividualFacilityUse type. - - + - - - + - - + - - + - + - - - + -
type - Text + type + Text Must always be present and set to "type": "IndividualFacilityUse" + + Must always be present and set to "type": "IndividualFacilityUse"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - a facility use.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during a facility use.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
    "prefLabel": "Badminton",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the facility use will take place.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the facility use will take place.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the facility use

-

-
Example -

-

"name": "Speedball" -

+

The name of the facility use


Example

"name": "Speedball"
provider + provider + -

The organisation responsible for providing the facility

-

-
Example -

-

"provider": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The organisation responsible for providing the facility


Example

"provider": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the facility - use.

-

-
Example -

-

"url": "https://example.com/facility-use/1234" -

+

A URL to a web page (or section of a page) that describes the facility use.


Example

"url": "https://example.com/facility-use/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -109,81 +89,65 @@ description: This page describes the IndividualFacilityUse type. - - + - + - - - - + - - + - + - - - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/facility-use/112345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/facility-use/112345"
aggregateFacilityUse + aggregateFacilityUse + FacilityUse FacilityUse + +

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location).

Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse - (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse - (e.g. an opportunity to play tennis at a specific location).
description - Text + description + Text -

A free text description of the facility use

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the facility use


Example

"description": "An fast paced game that incorporates netball, handball and football."
event - Array of Slot + event + Array of Slot -

An array of slots of availability of this IndividualFacilityUse.

-

-
Example -

-

"event": [
{
"type": "Slot",
"id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 0,
"maximumUses": 1
}
] -

+

An array of slots of availability of this IndividualFacilityUse.


Example

"event": [
  {
    "type": "Slot",
    "id": "http://www.example.org/api/individual-facility-uses/432#/event/2018-03-01T10:00:00Z",
    "startDate": "2018-03-01T11:00:00Z",
    "endDate": "2018-03-01T11:30:00Z",
    "duration": "PT30M",
    "remainingUses": 0,
    "maximumUses": 1
  }
]
hoursAvailable + hoursAvailable + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the facility use is available

The times the facility use is available
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the facility use, e.g. a photo taken at - a previous event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the facility use, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
### **Optional fields** + + +### **Optional fields** + @@ -194,134 +158,78 @@ description: This page describes the IndividualFacilityUse type. - - + - - + - - + - - + - - + - - - + + - - + - - + -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for users of a facility. E.g. - more information on how to find it, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access." -

+

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.


Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe a facility.

-

-
Example -

-

"category": [
{
"id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level",
"type": "Concept"
}
] -

+

Provides a set of tags that help categorise and describe a facility.


Example

"category": [
  {
    "id": "https://example.com/reference/categories#Top%20Club%20Level",
    "inScheme": "https://example.com/reference/categories",
    "prefLabel": "Top Club Level",
    "type": "Concept"
  }
]
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
\ No newline at end of file + + + diff --git a/docs/data-model/types/locationfeaturespecification.md b/docs/data-model/types/locationfeaturespecification.md index 1b719113..6962df6d 100644 --- a/docs/data-model/types/locationfeaturespecification.md +++ b/docs/data-model/types/locationfeaturespecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "LocationFeatureSpecification" + + Must always be present and set to "type": "LocationFeatureSpecification"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Bike Shed" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Bike Shed"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/lockers.md b/docs/data-model/types/lockers.md index 6db45ee7..ad1972ce 100644 --- a/docs/data-model/types/lockers.md +++ b/docs/data-model/types/lockers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Lockers" + + Must always be present and set to "type": "Lockers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Indoor Lockers" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Indoor Lockers"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/offer.md b/docs/data-model/types/offer.md index 54853835..3c608cdc 100644 --- a/docs/data-model/types/offer.md +++ b/docs/data-model/types/offer.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), ## **Fields** ### **Required fields** - + @@ -20,33 +20,29 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Offer" + + Must always be present and set to "type": "Offer"
price - Float + price + Float -

The offer price of the activity.

-

This price should be specified without currency symbols and as a floating - point number with two decimal places.

-

The currency of the price should be expressed in the priceCurrency field.

-

-
Example -

-

"price": 33 -

+

The offer price of the activity.

This price should be specified without currency symbols and as a floating point number with two decimal places.

The currency of the price should be expressed in the priceCurrency field.


Example

"price": 33
### **Recommended fields** + + +### **Recommended fields** + @@ -57,82 +53,56 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/offer/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/offer/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
name - Text + name + Text -

A human readable name for the offer.

-

-
Example -

-

"name": "Speedball winger position" -

+

A human readable name for the offer.


Example

"name": "Speedball winger position"
priceCurrency - Text + priceCurrency + Text -

The currency (in 3-letter ISO 4217 format) of the price.

-

If an Offer has a zero price, then this property is not required. Otherwise - the currency must be specified.

-

-
Example -

-

"priceCurrency": "GBP" -

+

The currency (in 3-letter ISO 4217 format) of the price.

If an Offer has a zero price, then this property is not required. Otherwise the currency must be specified.


Example

"priceCurrency": "GBP"
url - url + url + url -

URL describing the offer

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

URL describing the offer


Example

"url": "http://www.rphs.org.uk/"
### **Optional fields** + + +### **Optional fields** + @@ -143,56 +113,33 @@ This type is derived from [https://schema.org/Offer](https://schema.org/Offer), - - + - - - + + - - + -
advanceBooking - RequiredStatusType + advanceBooking + RequiredStatusType -

Indicates whether to accept this offer, a participant must book in advance, - whether they must pay on attending, or have option to do either.

-

-
Example -

-

"advanceBooking": "https://openactive.io/Required" -

+

Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either.


Example

"advanceBooking": "https://openactive.io/Required"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
prepayment - RequiredStatusType + prepayment + RequiredStatusType -

Indicates whether to accept this offer, a participant must pay in advance, - pay when attending, or have the option to do either.

-

-
Example -

-

"prepayment": "https://openactive.io/Required" -

+

Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either.


Example

"prepayment": "https://openactive.io/Required"
\ No newline at end of file + + + diff --git a/docs/data-model/types/openinghoursspecification.md b/docs/data-model/types/openinghoursspecification.md index bf25b3da..1340d446 100644 --- a/docs/data-model/types/openinghoursspecification.md +++ b/docs/data-model/types/openinghoursspecification.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ ## **Fields** ### **Required fields** - + @@ -20,54 +20,42 @@ This type is derived from [https://schema.org/OpeningHoursSpecification](https:/ - - + - - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "OpeningHoursSpecification" + + Must always be present and set to "type": "OpeningHoursSpecification"
closes - Time + closes + Time -

The closing time.

-

-
Example -

-

"closes": "17:00" -

+

The closing time.


Example

"closes": "17:00"
dayOfWeek - DayOfWeek + dayOfWeek + DayOfWeek -

Defines the day of the week upon which the Place is open

-

-
Example -

-

"dayOfWeek": "https://schema.org/Monday" -

+

Defines the day of the week upon which the Place is open


Example

"dayOfWeek": "https://schema.org/Monday"
opens - Time + opens + Time -

The opening time.

-

-
Example -

-

"opens": "09:00" -

+

The opening time.


Example

"opens": "09:00"
\ No newline at end of file + + + diff --git a/docs/data-model/types/organization.md b/docs/data-model/types/organization.md index 52c565df..1293d355 100644 --- a/docs/data-model/types/organization.md +++ b/docs/data-model/types/organization.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O ## **Fields** ### **Required fields** - + @@ -20,30 +20,29 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Organization" + + Must always be present and set to "type": "Organization"
name - Text + name + Text -

The name of the Organization

-

-
Example -

-

"name": "Central Speedball Association" -

+

The name of the Organization


Example

"name": "Central Speedball Association"
### **Recommended fields** + + +### **Recommended fields** + @@ -54,65 +53,47 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/organization/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/organization/12345"
sameAs - Array of url + sameAs + Array of url -

Lists the URL(s) of the official social media profile pages associated - with the organization.

-

-
Example -

-

"sameAs": [
"https://www.facebook.com/everyoneactive/",
"https://twitter.com/everyoneactive"
] -

+

Lists the URL(s) of the official social media profile pages associated with the organization.


Example

"sameAs": [
  "https://www.facebook.com/everyoneactive/",
  "https://twitter.com/everyoneactive"
]
telephone - Text + telephone + Text -

The telephone number of the Organization

-

-
Example -

-

"telephone": "01234 567890" -

+

The telephone number of the Organization


Example

"telephone": "01234 567890"
url - url + url + url -

A definitive canonical URL for the Organization.

-

-
Example -

-

"url": "http://www.speedball-world.com" -

+

A definitive canonical URL for the Organization.


Example

"url": "http://www.speedball-world.com"
### **Optional fields** + + +### **Optional fields** + @@ -123,54 +104,42 @@ This type is derived from [https://schema.org/Organization](https://schema.org/O - - + - - - + + - + - + + + + -
description - Text + description + Text -

The description of the Organization

-

-
Example -

-

"description": "The national governing body of cycling" -

+

The description of the Organization


Example

"description": "The national governing body of cycling"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		email + Text + +

General enquiries e-mail address for the organization.


Example

"email": "info@example.com"
logo + identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		ImageObject + +

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

logo -

A logo for the Organization.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+ ImageObject + 		+

A logo for the Organization.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/parking.md b/docs/data-model/types/parking.md index d18ce763..1d5b05bd 100644 --- a/docs/data-model/types/parking.md +++ b/docs/data-model/types/parking.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Parking" + + Must always be present and set to "type": "Parking"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Roadside Parking" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Roadside Parking"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/partialschedule.md b/docs/data-model/types/partialschedule.md index b8cc1d8c..852a2ca8 100644 --- a/docs/data-model/types/partialschedule.md +++ b/docs/data-model/types/partialschedule.md @@ -9,13 +9,31 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "PartialSchedule" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "PartialSchedule"` | ### **Recommended fields** - + @@ -26,51 +44,38 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + -
endTime - Time + endTime + Time -

The end time of the event.

-

-
Example -

-

"endTime": "12:00:00" -

+

The end time of the event.


Example

"endTime": "12:00:00"
repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"
startTime - Time + startTime + Time -

The start time of the event.

-

-
Example -

-

"startTime": "12:00:00" -

+

The start time of the event.


Example

"startTime": "12:00:00"
### **Optional fields** + + +### **Optional fields** + @@ -81,172 +86,105 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek -
- or - -
Array of Text + 		byDay + Array of DayOfWeek
- or -
Array of Text 		-

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]
byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]
byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - Date + endDate + Date -

The end date of the schedule.

-

-
Example -

-

"endDate": "2018-01-27" -

+

The end date of the schedule.


Example

"endDate": "2018-01-27"
exceptDate - Array of Date -
- or - -
Array of DateTime + 		exceptDate + Array of Date
- or -
Array of DateTime 		-

Exception dates where the schedule should not generate an event.

-

-
Example -

-

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] -

+

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]
idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - identifier (@id) for every event described by the schedule (see below for - more information). This property is required if the data provider is supporting - third-party booking via the Open Booking API.

-

-
Example -

-

"idTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"
repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.

-

-
Example -

-

"repeatCount": 3 -

+

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3
scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.

-

-
Example -

-

"scheduledEventType": "Event" -

+

The type of event this schedule related to.


Example

"scheduledEventType": "Event"
startDate - Date + startDate + Date -

The start date of the event.

-

-
Example -

-

"startDate": "2018-01-27" -

+

The start date of the event.


Example

"startDate": "2018-01-27"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - URL (schema:url) for every event described by the schedule (see below for - more information). This property is required if the data provider wants - to provide participants with a unique URL to book to attend an event.

-

-
Example -

-

"urlTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"
\ No newline at end of file + + + diff --git a/docs/data-model/types/person.md b/docs/data-model/types/person.md index 032f9e42..6dc5d6c2 100644 --- a/docs/data-model/types/person.md +++ b/docs/data-model/types/person.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "Person" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "Person"` | ### **Recommended fields** - + @@ -26,22 +44,20 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/person/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/person/12345"
### **Optional fields** + + +### **Optional fields** + @@ -52,113 +68,87 @@ This type is derived from [https://schema.org/Person](https://schema.org/Person) - - + - - - + + - - + - - + - - + - + + - + + + - + - + + + + -
description - Text + description + Text -

The description of the Person

-

-
Example -

-

"description": "The leader of the coaching team" -

+

The description of the Person


Example

"description": "The leader of the coaching team"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		familyName + Text + +

A last name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"familyName": "Thompson"
logo - ImageObject + givenName + Text -

A logo for the person.

-

-
Example -

-

"logo": {
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
} -

+

A first name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"givenName": "Daley"
name - Text + identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A full name for the person.

-

This person must give direct permission for their personal information - to be shared as part of the Open Data.

-

-
Example -

-

"name": "Daley Thompson" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
sameAs - Array of url + logo + ImageObject -

Lists the URL(s) of the official social media profile pages associated - with the person.

-

-
Example -

-

"sameAs": "https://example.org/example-org" -

+

A logo for the person.


Example

"logo": {
  "type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
telephone + name + Text + +

A full name for the person.

This person must give direct permission for their personal information to be shared as part of the Open Data.


Example

"name": "Daley Thompson"

 Text +
sameAs + Array of url -

The telephone number of the person

-

-
Example -

-

"telephone": "01234 567890" -

+

Lists the URL(s) of the official social media profile pages associated with the person.


Example

"sameAs": "https://example.org/example-org"
url + telephone + Text url + +

The telephone number of the person


Example

"telephone": "01234 567890"

+
url + url -

A URL where more information about the person may be found

-

-
Example -

-

"url": "http://www.example.com/" -

+

A URL where more information about the person may be found


Example

"url": "http://www.example.com/"
\ No newline at end of file + + + diff --git a/docs/data-model/types/place.md b/docs/data-model/types/place.md index ebb91aca..17beda2e 100644 --- a/docs/data-model/types/place.md +++ b/docs/data-model/types/place.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), ## **Fields** ### **Required fields** - + @@ -20,29 +20,28 @@ This type is derived from [https://schema.org/Place](https://schema.org/Place), - - + - - - + -
type - Text + type + Text Must always be present and set to "type": "Place" + + Must always be present and set to "type": "Place"
name - Text + name + Text -

The name of the Place

-

-
Example -

-

"name": "Raynes Park High School" -

+

The name of the Place


Example

"name": "Raynes Park High School"
### **Required options** + + + +### ** Required options ** While these properties are marked as recommended in the specification, a data publisher must provide as much detail in both `address` and `geo` for an event as possible. @@ -56,42 +55,29 @@ While these properties are marked as recommended in the specification, a data pu - address - - PostalAddress -
- or - -
Text + address + + PostalAddress
- or -
Text -

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}

- geo - - GeoCoordinates + geo + + GeoCoordinates -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}

-### **Recommended fields** + + +### **Recommended fields** + @@ -102,100 +88,74 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - + - - - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/place/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"
amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.

-

-
Example -

-

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] -

+

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]
description - Text + description + Text -

The description of the Place

-

-
Example -

-

"description": "Raynes Park High School in London" -

+

The description of the Place


Example

"description": "Raynes Park High School in London"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
openingHoursSpecification + openingHoursSpecification + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the Place is open

The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place

-

-
Example -

-

"telephone": "01253 473934" -

+

The telephone number for the Place


Example

"telephone": "01253 473934"
url - url + url + url -

The website for the Place

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

The website for the Place


Example

"url": "http://www.rphs.org.uk/"
### **Optional fields** + + +### **Optional fields** + @@ -206,88 +166,51 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - - - + + -
address - PostalAddress -
- or - -
Text + 		address + PostalAddress
- or -
Text 		-

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}
containedInPlace - Place + containedInPlace + Place -

The place within which this Place exists

-

-
Example -

-

"containedInPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
"name": "Middlesbrough Sports Village"
} -

+

The place within which this Place exists


Example

"containedInPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
  "name": "Middlesbrough Sports Village"
}
containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place

-

-
Example -

-

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} -

+

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}
geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer - 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+ 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer + 		+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/postaladdress.md b/docs/data-model/types/postaladdress.md index 29028dc7..5b57322a 100644 --- a/docs/data-model/types/postaladdress.md +++ b/docs/data-model/types/postaladdress.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,82 +20,60 @@ This type is derived from [https://schema.org/PostalAddress](https://schema.org/ - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "PostalAddress" + + Must always be present and set to "type": "PostalAddress"
addressCountry - Text + addressCountry + Text -

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.

-

-
Example -

-

"addressCountry": "GB" -

+

The country, expressed as a two-letter ISO 3166-1 alpha-2 country code.


Example

"addressCountry": "GB"
addressLocality - Text + addressLocality + Text -

The locality, a suburb within a city or a town within a county or district.

-

-
Example -

-

"addressLocality": "Shoreditch" -

+

The locality, a suburb within a city or a town within a county or district.


Example

"addressLocality": "Shoreditch"
addressRegion - Text + addressRegion + Text -

The region, either a city or a county or district.

-

-
Example -

-

"addressRegion": "London" -

+

The region, either a city or a county or district.


Example

"addressRegion": "London"
postalCode - Text + postalCode + Text -

The postal code.

-

-
Example -

-

"postalCode": "EC2A 4JE" -

+

The postal code.


Example

"postalCode": "EC2A 4JE"
streetAddress - Text + streetAddress + Text -

The street address.

-

-
Example -

-

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St" -

+

The street address.


Example

"streetAddress": "Open Data Institute, Floor 3, 65 Clifton St"
\ No newline at end of file + + + diff --git a/docs/data-model/types/propertyvalue.md b/docs/data-model/types/propertyvalue.md index 24b8f082..6719f4bb 100644 --- a/docs/data-model/types/propertyvalue.md +++ b/docs/data-model/types/propertyvalue.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,46 +20,38 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "PropertyValue" + + Must always be present and set to "type": "PropertyValue"
name - Text + name + Text -

The name of this PropertyValue

-

-
Example -

-

"name": "Vendor ID" -

+

The name of this PropertyValue


Example

"name": "Vendor ID"
value - Text -
- or - -
Integer + 		value + Text
- or -
Integer 		-

The actual value of this identifier

-

-
Example -

-

"value": "SB1234" -

+

The actual value of this identifier


Example

"value": "SB1234"
### **Optional fields** + + +### **Optional fields** + @@ -70,20 +62,15 @@ This type is derived from [https://schema.org/PropertyValue](https://schema.org/ - - + -
propertyID - url -
- or - -
Text + 		propertyID + url
- or -
Text 		-

A commonly used identifier for the characteristic represented by the property

-

-
Example -

-

"propertyID": "ActivePlaces" -

+

A commonly used identifier for the characteristic represented by the property


Example

"propertyID": "ActivePlaces"
\ No newline at end of file + + + diff --git a/docs/data-model/types/quantitativevalue.md b/docs/data-model/types/quantitativevalue.md index 86fd4b4b..28f57819 100644 --- a/docs/data-model/types/quantitativevalue.md +++ b/docs/data-model/types/quantitativevalue.md @@ -9,13 +9,31 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. ## **Fields** ### **Required fields** + + + + + + + + + + + + + + + + +
PropertyExpected TypeDescription
type + Text + + Must always be present and set to "type": "QuantitativeValue" +
-| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "QuantitativeValue"` | ### **Optional fields** - + @@ -26,32 +44,24 @@ This type is derived from [https://schema.org/QuantitativeValue](https://schema. - - + - - + -
maxValue - Integer + maxValue + Integer -

The maximum value.

-

-
Example -

-

"maxValue": 60 -

+

The maximum value.


Example

"maxValue": 60
minValue - Integer + minValue + Integer -

The minimum value.

-

-
Example -

-

"minValue": 16 -

+

The minimum value.


Example

"minValue": 16
\ No newline at end of file + + + diff --git a/docs/data-model/types/reserveaction.md b/docs/data-model/types/reserveaction.md index 24dbfc4d..ad053fdd 100644 --- a/docs/data-model/types/reserveaction.md +++ b/docs/data-model/types/reserveaction.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ ## **Fields** ### **Required fields** - + @@ -20,40 +20,33 @@ This type is derived from [https://schema.org/ReserveAction](https://schema.org/ - - + - - - + - - + -
type - Text + type + Text Must always be present and set to "type": "ReserveAction" + + Must always be present and set to "type": "ReserveAction"
name - Text + name + Text -

The name of the action

-

-
Example -

-

"name": "Book" -

+

The name of the action


Example

"name": "Book"
target - EntryPoint + target + EntryPoint -

A definition of the target of the action.

-

-
Example -

-

"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
} -

+

A definition of the target of the action.


Example

"target": {
  "encodingType": "application/vnd.openactive.v1.0+json",
  "httpMethod": "POST",
  "type": "EntryPoint",
  "url": "https://example.com/orders"
}
\ No newline at end of file + + + diff --git a/docs/data-model/types/schedule.md b/docs/data-model/types/schedule.md index beb09f7c..77c89bd8 100644 --- a/docs/data-model/types/schedule.md +++ b/docs/data-model/types/schedule.md @@ -9,7 +9,7 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. ## **Fields** ### **Required fields** - + @@ -20,57 +20,46 @@ This type is derived from [https://pending.schema.org/Schedule](https://pending. - - + - - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Schedule" + + Must always be present and set to "type": "Schedule"
endTime - Time + endTime + Time -

The end time of the event.

-

-
Example -

-

"endTime": "12:00:00" -

+

The end time of the event.


Example

"endTime": "12:00:00"
scheduledEventType - Text + scheduledEventType + Text -

The type of event this schedule related to.

-

-
Example -

-

"scheduledEventType": "Event" -

+

The type of event this schedule related to.


Example

"scheduledEventType": "Event"
startTime - Time + startTime + Time -

The start time of the event.

-

-
Example -

-

"startTime": "12:00:00" -

+

The start time of the event.


Example

"startTime": "12:00:00"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional, a data publisher must provide either a `byDay`, `byMonth`, `byMonthDay` or `repeatFrequency` for a schedule. @@ -84,71 +73,47 @@ While these properties are marked as optional, a data publisher must provide eit - byDay - - Array of DayOfWeek -
- or - -
Array of Text + byDay + + Array of DayOfWeek
- or -
Array of Text -

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]

- byMonth - - Array of Integer + byMonth + + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]

- byMonthDay - - Array of Integer + byMonthDay + + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]

- repeatFrequency - - Duration + repeatFrequency + + Duration -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"

-### **Recommended fields** + + +### **Recommended fields** + @@ -159,84 +124,56 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + -
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - Date + endDate + Date -

The end date of the schedule.

-

-
Example -

-

"endDate": "2018-01-27" -

+

The end date of the schedule.


Example

"endDate": "2018-01-27"
idTemplate - urlTemplate + idTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - identifier (@id) for every event described by the schedule (see below for - more information). This property is required if the data provider is supporting - third-party booking via the Open Booking API.

-

-
Example -

-

"idTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique identifier (@id) for every event described by the schedule (see below for more information). This property is required if the data provider is supporting third-party booking via the Open Booking API.


Example

"idTemplate": "https://example.com/event{/id}"
startDate - Date + startDate + Date -

The start date of the event.

-

-
Example -

-

"startDate": "2018-01-27" -

+

The start date of the event.


Example

"startDate": "2018-01-27"
urlTemplate - urlTemplate + urlTemplate + urlTemplate -

An RFC6570 compliant URI template that can be used to generate a unique - URL (schema:url) for every event described by the schedule (see below for - more information). This property is required if the data provider wants - to provide participants with a unique URL to book to attend an event.

-

-
Example -

-

"urlTemplate": "https://example.com/event{/id}" -

+

An RFC6570 compliant URI template that can be used to generate a unique URL (schema:url) for every event described by the schedule (see below for more information). This property is required if the data provider wants to provide participants with a unique URL to book to attend an event.


Example

"urlTemplate": "https://example.com/event{/id}"
### **Optional fields** + + +### **Optional fields** + @@ -247,97 +184,60 @@ While these properties are marked as optional, a data publisher must provide eit - - + - - + - - + - - + - - + - - + -
byDay - Array of DayOfWeek -
- or - -
Array of Text + 		byDay + Array of DayOfWeek
- or -
Array of Text 		-

Defines the day of the week upon which the Event takes place.

-

When using string values, this MUST conform to iCal BYDAY rule.

-

-
Example -

-

"byDay": [
"https://schema.org/Monday"
] -

+

Defines the day of the week upon which the Event takes place.

When using string values, this MUST conform to iCal BYDAY rule.


Example

"byDay": [
  "https://schema.org/Monday"
]
byMonth - Array of Integer + byMonth + Array of Integer -

Defines the months of the year on which the Event takes place. Specified - as an integer between 1 and 12, with 1 representing January.

-

-
Example -

-

"byMonth": [
2
] -

+

Defines the months of the year on which the Event takes place. Specified as an integer between 1 and 12, with 1 representing January.


Example

"byMonth": [
  2
]
byMonthDay - Array of Integer + byMonthDay + Array of Integer -

Defines the days of the month on which the Event takes place. Specified - as an integer between 1 and 31

-

-
Example -

-

"byMonthDay": [
28
] -

+

Defines the days of the month on which the Event takes place. Specified as an integer between 1 and 31


Example

"byMonthDay": [
  28
]
exceptDate - Array of Date -
- or - -
Array of DateTime + 		exceptDate + Array of Date
- or -
Array of DateTime 		-

Exception dates where the schedule should not generate an event.

-

-
Example -

-

"exceptDate": [
"2016-04-13T17:10:00Z",
"2016-09-14T17:10:00Z",
"2016-12-14T18:10:00Z",
"2016-12-21T18:10:00Z",
"2016-12-28T18:10:00Z",
"2017-01-04T18:10:00Z"
] -

+

Exception dates where the schedule should not generate an event.


Example

"exceptDate": [
  "2016-04-13T17:10:00Z",
  "2016-09-14T17:10:00Z",
  "2016-12-14T18:10:00Z",
  "2016-12-21T18:10:00Z",
  "2016-12-28T18:10:00Z",
  "2017-01-04T18:10:00Z"
]
repeatCount - Integer + repeatCount + Integer -

Defines the number of times a recurring Event will take place.

-

-
Example -

-

"repeatCount": 3 -

+

Defines the number of times a recurring Event will take place.


Example

"repeatCount": 3
repeatFrequency - Duration + repeatFrequency + Duration -

Defines the frequency at which Events will occur according to a Schedule. - The intervals between events should be defined as a Duration of time.

-

-
Example -

-

"repeatFrequency": "P1D" -

+

Defines the frequency at which Events will occur according to a Schedule. The intervals between events should be defined as a Duration of time.


Example

"repeatFrequency": "P1D"
\ No newline at end of file + + + diff --git a/docs/data-model/types/scheduledsession.md b/docs/data-model/types/scheduledsession.md index 50d8a17d..8b65af70 100644 --- a/docs/data-model/types/scheduledsession.md +++ b/docs/data-model/types/scheduledsession.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,84 +20,29 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - - - - - - + - - - - - - + - - - - -
type - Text - Must always be present and set to "type": "ScheduledSession" -
activity - Array of Concept - type -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

-
location - Place + Text -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+ Must always be present and set to "type": "ScheduledSession"
name - Text - startDate -

The name of the event

-

-
Example -

-

"name": "Speedball" -

-
startDate - DateTime -
- or - -
Date + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
### **Recommended fields** + + +### **Recommended fields** + @@ -108,129 +53,83 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "gender": "https://schema.org/Male",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
remainingAttendeeCapacity - Integer + remainingAttendeeCapacity + Integer -

The number of places that are still available for the Event.

-

-
Example -

-

"remainingAttendeeCapacity": 20 -

+

The number of places that are still available for the Event.


Example

"remainingAttendeeCapacity": 20
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Optional fields** + + +### **Optional fields** + @@ -241,332 +140,222 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + + - + + + - + - + + + + - + - + + + + - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
ageRange - QuantitativeValue + activity + Array of Concept -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
attendeeInstructions - Text + ageRange + QuantitativeValue -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
category - Array of Concept -
- or - -
Array of Text + 		attendeeInstructions + Text -

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
contributor - Array of Person + category + Array of Concept
- or -
Array of Text 		-

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
description - Text + contributor + Array of Person -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + description + Text -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
genderRestriction - GenderRestrictionType + duration + Duration -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		genderRestriction + GenderRestrictionType -

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + image + Array of ImageObject -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
isCoached - Boolean + isAccessibleForFree + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
level - Array of Text -
- or - -
Array of Concept + 		isCoached + Boolean -

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 -

-

"level": [
"beginner"
] -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
meetingPoint - Text + level + Array of Text
- or -
Array of Concept 		-

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

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

"level": [
  "beginner"
]
organizer - Organization -
- or - -
Person + 		location + Place -

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
potentialAction + meetingPoint + Text + +

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"

Array of Action +
name + Text -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The name of the event


Example

"name": "Speedball"
programme + organizer + Organization
- or -
Person 		Brand + +

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}

potentialAction -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+ Array of Action + 		+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
schedulingNote + programme + Brand Text + +

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}

schedulingNote -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+ Text + 		+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
superEvent + superEvent + Event
- or -
url 		Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/sessionseries.md b/docs/data-model/types/sessionseries.md index 957cd171..ea90b5d3 100644 --- a/docs/data-model/types/sessionseries.md +++ b/docs/data-model/types/sessionseries.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), ## **Fields** ### **Required fields** - + @@ -20,113 +20,74 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - - + - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "SessionSeries" + + Must always be present and set to "type": "SessionSeries"
activity - Array of Concept + activity + Array of Concept -

Specifies the physical activity or activities that will take place during - an event.

-

-
Example -

-

"activity": [
{
"type": "Concept",
"id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
"prefLabel": "Bodypump™",
"inScheme": "https://openactive.io/activity-list"
}
] -

+

Specifies the physical activity or activities that will take place during an event.


Example

"activity": [
  {
    "type": "Concept",
    "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
    "prefLabel": "Bodypump™",
    "inScheme": "https://openactive.io/activity-list"
  }
]
location - Place + location + Place -

The location at which the event will take place. Or, in the case of events - that may span multiple locations, the initial meeting or starting point.

-

It is recommended that locations should be specified as a Place complete - with a fully described geographic location and/or address.If only an address - is available then this should be described as a PostalAddress.

-

Applications may use schema:Text to - provide a more general description of a location ("In Victoria Park, near - the lake"), but this is not recommended: consuming applications will be - unable to help users discover opportunities based on their location.

-

-
Example -

-

"location": {
"address": {
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"type": "PostalAddress"
},
"description": "Raynes Park High School in London",
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
},
"id": "https://example.com/locations/1234ABCD",
"identifier": "1234ABCD",
"name": "Raynes Park High School",
"telephone": "01253 473934",
"type": "Place"
} -

+

The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point.

It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address.If only an address is available then this should be described as a PostalAddress.

Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location.


Example

"location": {
  "address": {
    "addressLocality": "New Malden",
    "addressRegion": "London",
    "postalCode": "NW5 3DU",
    "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
    "type": "PostalAddress"
  },
  "description": "Raynes Park High School in London",
  "geo": {
    "latitude": 51.4034423828125,
    "longitude": -0.2369088977575302,
    "type": "GeoCoordinates"
  },
  "id": "https://example.com/locations/1234ABCD",
  "identifier": "1234ABCD",
  "name": "Raynes Park High School",
  "telephone": "01253 473934",
  "type": "Place"
}
name - Text + name + Text -

The name of the event

-

-
Example -

-

"name": "Speedball" -

+

The name of the event


Example

"name": "Speedball"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of attending.

-

-
Example -

-

"offers": [
{
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 3.3,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
] -

+

An array of schema:Offer that include the price of attending.


Example

"offers": [
  {
    "type": "Offer",
    "identifier": "OX-AD",
    "name": "Adult",
    "price": 3.3,
    "priceCurrency": "GBP",
    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
  }
]
organizer - Organization -
- or - -
Person + 		organizer + Organization
- or -
Person 		-

The person or organization ultimately responsible for an event. An organizer - might be an schema:Organization or a schema:Person.

-

-
Example -

-

"organizer": {
"name": "Central Speedball Association",
"type": "Organization",
"url": "http://www.speedball-world.com"
} -

+

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.


Example

"organizer": {
  "name": "Central Speedball Association",
  "type": "Organization",
  "url": "http://www.speedball-world.com"
}
url - url + url + url -

A URL to a web page (or section of a page) that describes the event.

-

-
Example -

-

"url": "https://example.com/event/1234" -

+

A URL to a web page (or section of a page) that describes the event.


Example

"url": "https://example.com/event/1234"
### **Recommended fields** + + +### **Recommended fields** + @@ -137,118 +98,74 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/event/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/event/12345"
ageRange - QuantitativeValue + ageRange + QuantitativeValue -

Indicates that an event is suitable for a specific age range. If only - a single age is specified then this is assumed to be a minimum age. Age - ranges can be specified as follows: 18-30

-

-
Example -

-

"ageRange": {
"type": "QuantitativeValue",
"minValue": 15,
"maxValue": 60
} -

+

Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30


Example

"ageRange": {
  "type": "QuantitativeValue",
  "minValue": 15,
  "maxValue": 60
}
description - Text + description + Text -

A free text description of the event

-

-
Example -

-

"description": "An fast paced game that incorporates netball, handball and football." -

+

A free text description of the event


Example

"description": "An fast paced game that incorporates netball, handball and football."
genderRestriction - GenderRestrictionType + genderRestriction + GenderRestrictionType -

Indicates that an event is restricted to male, female or a mixed audience. - If a gender restriction isn't specified then applications should assume - that an event is suitable for a mixed audience

-

-
Example -

-

"genderRestriction": "https://openactive.io/FemaleOnly" -

+

Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience


Example

"genderRestriction": "https://openactive.io/FemaleOnly"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the event, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
] -

+

An image or photo that depicts the event, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg",
    "thumbnail": [
      {
        "type": "ImageObject",
        "url": "http://example.com/static/image/speedball_thumbnail.jpg"
      }
    ]
  }
]
leader - Array of Person + leader + Array of Person -

Refers to a person (schema:Person) who will be leading an event. E.g. - a coach. This is a more specific role than an organiser or a contributor. - The person will need to have given their consent for their personal information - to be present in the Open Data.

-

-
Example -

-

"leader": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.


Example

"leader": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "gender": "https://schema.org/Male",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
level - Array of Text -
- or - -
Array of Concept + 		level + Array of Text
- or -
Array of Concept 		-

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 -

-

"level": [
"beginner"
] -

+

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

"level": [
  "beginner"
]
### **Optional fields** + + +### **Optional fields** + @@ -259,324 +176,195 @@ This type is derived from [https://schema.org/Event](https://schema.org/Event), - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - + - - -
@context - url -
- or - -
Array of url + 		@context + url
- or -
Array of url 		-

This must be included in the top-most entity in the JSON model.

-

-
Example -

-

"@context": "https://openactive.io/" -

+

This must be included in the top-most entity in the JSON model.


Example

"@context": "https://openactive.io/"
accessibilityInformation - Text + accessibilityInformation + Text -

Provide additional, specific documentation for participants about how - disabilities are, or can be supported at the Event.

-

-
Example -

-

"accessibilityInformation": "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." -

+

Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.


Example

"accessibilityInformation": "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 - Array of Text -
- or - -
Array of Concept + 		accessibilitySupport + Array of Text
- or -
Array of Concept 		-

Used to specify the types of disabilities or impairments that are supported - at an event.

-

-
Example -

-

"accessibilitySupport": [
{
"type": "Concept",
"id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
] -

+

Used to specify the types of disabilities or impairments that are supported at an event.


Example

"accessibilitySupport": [
  {
    "type": "Concept",
    "id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
    "prefLabel": "Visual impairment",
    "inScheme": "https://openactive.io/accessibility-support"
  }
]
attendeeInstructions - Text + attendeeInstructions + Text -

Provides additional notes and instructions for event attendees. E.g. more - information on how to find the event, what to bring, etc.

-

-
Example -

-

"attendeeInstructions": "Ensure you bring trainers and a bottle of water." -

+

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.


Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."
category - Array of Concept -
- or - -
Array of Text + 		category + Array of Concept
- or -
Array of Text 		-

Provides a set of tags that help categorise and describe an event, e.g. - its intensity, purpose, etc.

-

-
Example -

-

"category": [
"High Intensity"
] -

+

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.


Example

"category": [
  "High Intensity"
]
contributor - Array of Person + contributor + Array of Person -

A Person who contributes to the facilitation of the Event.

-

-
Example -

-

"contributor": [
{
"type": "Person",
"familyName": "Smith",
"givenName": "Nicole",
"id": "https://example.com/locations/1234ABCD/leaders/89",
"identifier": 89
}
] -

+

A Person who contributes to the facilitation of the Event.


Example

"contributor": [
  {
    "type": "Person",
    "familyName": "Smith",
    "givenName": "Nicole",
    "id": "https://example.com/locations/1234ABCD/leaders/89",
    "identifier": 89
  }
]
duration - Duration + duration + Duration -

The duration of the event given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the event given in [ISO8601] format.


Example

"duration": "PT1H"
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the event. Can be specified as a schema:Date - or schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an event.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the event. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an event.


Example

"endDate": "2018-01-27T12:00:00Z"
eventSchedule - Array of Schedule + eventSchedule + Array of Schedule -

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence - pattern.

-

-
Example -

-

"eventSchedule": [
{
"type": "PartialSchedule",
"repeatFrequency": "P1W",
"startTime": "20:15",
"endTime": "20:45",
"byDay": [
"http://schema.org/Tuesday"
]
}
] -

+

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.


Example

"eventSchedule": [
  {
    "type": "PartialSchedule",
    "repeatFrequency": "P1W",
    "startTime": "20:15",
    "endTime": "20:45",
    "byDay": [
      "http://schema.org/Tuesday"
    ]
  }
]
eventStatus - EventStatusType + eventStatus + EventStatusType -

The status of an event. Can be used to indicate rescheduled or cancelled - events

-

-
Example -

-

"eventStatus": "https://schema.org/EventScheduled" -

+

The status of an event. Can be used to indicate rescheduled or cancelled events


Example

"eventStatus": "https://schema.org/EventScheduled"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
isAccessibleForFree - Boolean + isAccessibleForFree + Boolean -

Whether the Event is accessible without charge.

-

-
Example -

-

"isAccessibleForFree": "true" -

+

Whether the Event is accessible without charge.


Example

"isAccessibleForFree": "true"
isCoached - Boolean + isCoached + Boolean -

A boolean property that indicates whether an Event will be coached. This - flag allows an Event to be marked as being coached without having to specify - a named individual as a coach. This addresses both privacy concerns and - also scenarios where the actual coach may only be decided on the day.

-

-
Example -

-

"isCoached": "true" -

+

A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.


Example

"isCoached": "true"
maximumAttendeeCapacity - Integer + maximumAttendeeCapacity + Integer -

The maximum capacity of the Event.

-

-
Example -

-

"maximumAttendeeCapacity": 30 -

+

The maximum capacity of the Event.


Example

"maximumAttendeeCapacity": 30
meetingPoint - Text + meetingPoint + Text -

Instructions for the attendees of an Event about where they should meet - the organizer or leader at the start of the event. Some larger locations - may have several possible meeting points, so this property provides additional - more specific directions.

-

-
Example -

-

"meetingPoint": "At the entrance to the park" -

+

Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.


Example

"meetingPoint": "At the entrance to the park"
potentialAction - Array of Action + potentialAction + Array of Action -

The possible actions that a user may make. e.g. Book.

-

-
Example -

-

"potentialAction": [
{
"name": "Book",
"target": {
"encodingType": "application/vnd.openactive.v1.0+json",
"httpMethod": "POST",
"type": "EntryPoint",
"url": "https://example.com/orders"
},
"type": "Action"
}
] -

+

The possible actions that a user may make. e.g. Book.


Example

"potentialAction": [
  {
    "name": "Book",
    "target": {
      "encodingType": "application/vnd.openactive.v1.0+json",
      "httpMethod": "POST",
      "type": "EntryPoint",
      "url": "https://example.com/orders"
    },
    "type": "Action"
  }
]
programme - Brand + programme + Brand -

Indicates that an event will be organised according to a specific Programme.

-

-
Example -

-

"programme": {
"type": "Brand",
"name": "Play Ball!",
"url": "http://example.org/brand/play-ball"
} -

+

Indicates that an event will be organised according to a specific Programme.


Example

"programme": {
  "type": "Brand",
  "name": "Play Ball!",
  "url": "http://example.org/brand/play-ball"
}
schedulingNote - Text + schedulingNote + Text -

Provides a note from an organizer relating to how this Event is scheduled.

-

-
Example -

-

"schedulingNote": "This event doesn't run during school holidays" -

+

Provides a note from an organizer relating to how this Event is scheduled.


Example

"schedulingNote": "This event doesn't run during school holidays"
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the event. Can be specified as a schema:Date - or schema:DateTime.

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.


Example

"startDate": "2018-01-27T12:00:00Z"
subEvent + subEvent + Array of ScheduledSession Array of ScheduledSession + +

Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule

Relates a parent event to a child event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A child event might be a specific instance of an Event within a schedule
superEvent + superEvent + Event Event + +

Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance

Relates a child event to a parent event. Properties describing the parent - event can be assumed to apply to the child, unless otherwise specified. - A parent event might specify a recurring schedule, of which the child event - is one specific instance
\ No newline at end of file + + + diff --git a/docs/data-model/types/showers.md b/docs/data-model/types/showers.md index 2f7579e1..33f60e9c 100644 --- a/docs/data-model/types/showers.md +++ b/docs/data-model/types/showers.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Showers" + + Must always be present and set to "type": "Showers"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Poolside Showers" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Poolside Showers"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/slot.md b/docs/data-model/types/slot.md index ab9af02c..1e0e4c96 100644 --- a/docs/data-model/types/slot.md +++ b/docs/data-model/types/slot.md @@ -4,10 +4,12 @@ description: This page describes the Slot type. # Slot + + ## **Fields** ### **Required fields** - + @@ -18,89 +20,64 @@ description: This page describes the Slot type. - - + - - - + - - + - - + - - + - - + -
type - Text + type + Text Must always be present and set to "type": "Slot" + + Must always be present and set to "type": "Slot"
duration - Duration + duration + Duration -

The duration of the slot given in [ISO8601] format.

-

-
Example -

-

"duration": "PT1H" -

+

The duration of the slot given in [ISO8601] format.


Example

"duration": "PT1H"
facilityUse - url + facilityUse + url -

URI to the FacilityUse that has this offer

-

-
Example -

-

"facilityUse": "https://example.com/facility-use/1" -

+

URI to the FacilityUse that has this offer


Example

"facilityUse": "https://example.com/facility-use/1"
offers - Array of Offer + offers + Array of Offer -

An array of schema:Offer that include the price of booking.

-

-
Example -

-

"offers": {
"type": "Offer",
"identifier": "OX-AD",
"name": "Adult",
"price": 7.5,
"priceCurrency": "GBP",
"url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
} -

+

An array of schema:Offer that include the price of booking.


Example

"offers": {
  "type": "Offer",
  "identifier": "OX-AD",
  "name": "Adult",
  "price": 7.5,
  "priceCurrency": "GBP",
  "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
}
remainingUses - Integer + remainingUses + Integer -

The remaining available courts or pitches at this time. Must be 0 or 1 - for an IndividualFacilityUse.

-

-
Example -

-

"remainingUses": 5 -

+

The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"remainingUses": 5
startDate - DateTime -
- or - -
Date + 		startDate + DateTime
- or -
Date 		-

The start date and time of the slot. Can be specified as a schema:Date - or schema:DateTime

-

-
Example -

-

"startDate": "2018-01-27T12:00:00Z" -

+

The start date and time of the slot. Can be specified as a schema:Date or schema:DateTime


Example

"startDate": "2018-01-27T12:00:00Z"
### **Required options** + + + +### ** Required options ** While these properties are marked as optional/recommended in the Modelling Specification, one of these must be provided when surfacing a slot through an RPDE feed to ensure that the slots can be processed correctly by data consumers. @@ -114,44 +91,29 @@ While these properties are marked as optional/recommended in the Modelling Speci - id - - url + id + + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/slot/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"

- identifier - - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + identifier + + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer -

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"

-### **Recommended fields** + + +### **Recommended fields** + @@ -162,37 +124,29 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/slot/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/slot/12345"
maximumUses - Integer + maximumUses + Integer -

The maximum available courts or pitches at this time. Must be 0 or 1 for - an IndividualFacilityUse.

-

-
Example -

-

"maximumUses": 16 -

+

The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.


Example

"maximumUses": 16
### **Optional fields** + + +### **Optional fields** + @@ -203,45 +157,24 @@ While these properties are marked as optional/recommended in the Modelling Speci - - + - - + -
endDate - DateTime -
- or - -
Date + 		endDate + DateTime
- or -
Date 		-

The end date and time of the slot. Can be specified as a schema:Date or - schema:DateTime

-

It is recommended that publishers provide either an schema:endDate or - a schema:duration for an slot.

-

-
Example -

-

"endDate": "2018-01-27T12:00:00Z" -

+

The end date and time of the slot. Can be specified as a schema:Date or schema:DateTime

It is recommended that publishers provide either an schema:endDate or a schema:duration for an slot.


Example

"endDate": "2018-01-27T12:00:00Z"
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
\ No newline at end of file + + + diff --git a/docs/data-model/types/sportsactivitylocation.md b/docs/data-model/types/sportsactivitylocation.md index 9ba98a91..d969ce78 100644 --- a/docs/data-model/types/sportsactivitylocation.md +++ b/docs/data-model/types/sportsactivitylocation.md @@ -9,15 +9,7 @@ This type is derived from [https://schema.org/SportsActivityLocation](https://sc ## **Fields** ### **Required fields** - -| Property | Expected Type | Description | -| :--- | :--- | :--- | -| **type** | [`Text`](https://schema.org/Text) | Must always be present and set to `"type": "SportsActivityLocation"` | - -### **Required options** - -While these properties are marked as recommended in the specification, a data publisher must provide as much detail in both `address` and `geo` for an event as possible. - + @@ -28,42 +20,20 @@ While these properties are marked as recommended in the specification, a data pu - - + - - - - -
address - PostalAddress -
- or - -
Text - 		type -

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

-
geo - GeoCoordinates + Text -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+ Must always be present and set to "type": "SportsActivityLocation"
### **Recommended fields** + + +### **Recommended fields** + @@ -74,22 +44,20 @@ While these properties are marked as recommended in the specification, a data pu - - + -
id - url + id + url -

A unique url based identifier for the record

-

-
Example -

-

"id": "https://example.com/place/12345" -

+

A unique url based identifier for the record


Example

"id": "https://example.com/place/12345"
### **Optional fields** + + +### **Optional fields** + @@ -100,184 +68,114 @@ While these properties are marked as recommended in the specification, a data pu - - + - - + - - + - - + - - + - - + - - + - - + - - + - + - - - - + - - + -
address - PostalAddress -
- or - -
Text + 		address + PostalAddress
- or -
Text 		-

A structured PostalAddress object for the Place.

-

Ideally the address should be provided using the PostalAddress structured - format. Google Reserve requires https://schema.org/PostalAddress and - will not accept plain text addresses.

-

-
Example -

-

"address": {
"type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
} -

+

A structured PostalAddress object for the Place.

Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.


Example

"address": {
  "type": "PostalAddress",
  "streetAddress": "Raynes Park High School, 46A West Barnes Lane",
  "addressLocality": "New Malden",
  "addressRegion": "London",
  "postalCode": "NW5 3DU",
  "addressCountry": "GB"
}
amenityFeature - Array of LocationFeatureSpecification + amenityFeature + Array of LocationFeatureSpecification -

An array listing the Ammenities of the Place.

-

-
Example -

-

"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"type": "Showers"
},
{
"name": "Lockers",
"value": true,
"type": "Lockers"
},
{
"name": "Towels",
"value": false,
"type": "Towels"
},
{
"name": "Creche",
"value": false,
"type": "Creche"
},
{
"name": "Parking",
"value": true,
"type": "Parking"
}
] -

+

An array listing the Ammenities of the Place.


Example

"amenityFeature": [
  {
    "name": "Changing Facilities",
    "value": true,
    "type": "ChangingFacilities"
  },
  {
    "name": "Showers",
    "value": false,
    "type": "Showers"
  },
  {
    "name": "Lockers",
    "value": true,
    "type": "Lockers"
  },
  {
    "name": "Towels",
    "value": false,
    "type": "Towels"
  },
  {
    "name": "Creche",
    "value": false,
    "type": "Creche"
  },
  {
    "name": "Parking",
    "value": true,
    "type": "Parking"
  }
]
containedInPlace - Place -
- or - -
url + 		containedInPlace + Place
- or -
url 		-

While a url is not specified as an option in the Modelling - Specification, it is necessary to link entities in RPDE.

-

-
Example -

-

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d" -

+

While a url is not specified as an option in the Modelling Specification, it is necessary to link entities in RPDE.


Example

"containedInPlace": "http://www.example.org/api/locations/8958f9b8-2004-4e90-80ff-50c98a9b121d"
containsPlace - Array of Place + containsPlace + Array of Place -

Places that exist within this place

-

-
Example -

-

"containsPlace": {
"type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
} -

+

Places that exist within this place


Example

"containsPlace": {
  "type": "Place",
  "url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
  "name": "Center Parcs Sports Plaza"
}
description - Text + description + Text -

The description of the Place

-

-
Example -

-

"description": "Raynes Park High School in London" -

+

The description of the Place


Example

"description": "Raynes Park High School in London"
geo - GeoCoordinates + geo + GeoCoordinates -

The geo coordinates of the Place.

-

-
Example -

-

"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"type": "GeoCoordinates"
} -

+

The geo coordinates of the Place.


Example

"geo": {
  "latitude": 51.4034423828125,
  "longitude": -0.2369088977575302,
  "type": "GeoCoordinates"
}
identifier - Text -
- or - -
PropertyValue -
- or - -
Array of PropertyValue -
- or - -
Integer + 		identifier + Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer 		-

A local non-URI identifier for the resource

-

-
Example -

-

"identifier": "SB1234" -

+

A local non-URI identifier for the resource


Example

"identifier": "SB1234"
image - Array of ImageObject + image + Array of ImageObject -

An image or photo that depicts the place, e.g. a photo taken at a previous - event.

-

-
Example -

-

"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
] -

+

An image or photo that depicts the place, e.g. a photo taken at a previous event.


Example

"image": [
  {
    "thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
    "type": "ImageObject",
    "url": "http://example.com/static/image/speedball_large.jpg"
  }
]
name - Text + name + Text -

The name of the Place

-

-
Example -

-

"name": "Raynes Park High School" -

+

The name of the Place


Example

"name": "Raynes Park High School"
openingHoursSpecification + openingHoursSpecification + Array of OpeningHoursSpecification Array of OpeningHoursSpecification + +

The times the Place is open

The times the Place is open
telephone - Text + telephone + Text -

The telephone number for the Place

-

-
Example -

-

"telephone": "01253 473934" -

+

The telephone number for the Place


Example

"telephone": "01253 473934"
url - url + url + url -

The website for the Place

-

-
Example -

-

"url": "http://www.rphs.org.uk/" -

+

The website for the Place


Example

"url": "http://www.rphs.org.uk/"
\ No newline at end of file + + + diff --git a/docs/data-model/types/toilets.md b/docs/data-model/types/toilets.md index f8e164c9..f5248106 100644 --- a/docs/data-model/types/toilets.md +++ b/docs/data-model/types/toilets.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Toilets" + + Must always be present and set to "type": "Toilets"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Public Toilets" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Public Toilets"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + + diff --git a/docs/data-model/types/towels.md b/docs/data-model/types/towels.md index 14fb351e..063eb9c0 100644 --- a/docs/data-model/types/towels.md +++ b/docs/data-model/types/towels.md @@ -9,7 +9,7 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http ## **Fields** ### **Required fields** - + @@ -20,33 +20,33 @@ This type is derived from [https://schema.org/LocationFeatureSpecification](http - - + - - - + - + - - -
type - Text + type + Text Must always be present and set to "type": "Towels" + + Must always be present and set to "type": "Towels"
name - Text + name + Text -

A string, suitable for presentation in user interfaces.

-

-
Example -

-

"name": "Complementary Towels" -

+

A string, suitable for presentation in user interfaces.


Example

"name": "Complementary Towels"
value + value + Boolean Boolean + +

A boolean value indicating whether this ammenity is available.

A boolean value indicating whether this ammenity is available.
\ No newline at end of file + + +