Organization

This page describes the Organization type.

This type is derived from https://schema.org/Organization, which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
Properties
Required properties
Property
Expected Type
Description
name
 Text​
The name of the Organization

Example
"name": "Central Speedball Association"
Recommended properties
Property
Expected Type
Description
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"
]
telephone
 Text​
The telephone number of the Organization

Example
"telephone": "01234 567890"
url
 URL​
A definitive canonical URL for the Organization.

Example
"url": "http://www.speedball-world.com"
Optional properties
Property
Expected Type
Description
@type
 Text​
 Must always be present and set to "@type": "Organization"
@id
 URL​
A unique URI-based identifier for the record.
@id properties are used as identifiers for compatibility with JSON-LD. The value of such a property must always be an absolute URI that provides a stable globally unique identifier for the resource, as described in RFC3986.
The primary purpose of the URI format in this context is to provide natural namespacing for the identifier. Hence, the URI itself may not resolve to a valid endpoint, but must use a domain name controlled by the resource owner (the organisation responsible for the OpenActive open data feed).

Example
"@id": "https://id.bookingsystem.example.com/organizers/1"
address
 PostalAddress​
Address of the Seller, used on tax receipts.
description
 Text​
A plain text description of the Organization, which must not include HTML or other markup.

Example
"description": "The national governing body of cycling"
email
 Text​
General enquiries e-mail address for the organization.

Example
"email": "[email protected]"
identifier
 Text
 - or -
PropertyValue
 - or -
Array of PropertyValue
 - or -
Integer​
A local non-URI identifier for the resource

Example
"identifier": "SB1234"
isOpenBookingAllowed
 Boolean​
Indicates whether the Seller allows open booking or not

Example
"isOpenBookingAllowed": "true"
legalName
 Text​
The official name of the organization, e.g. the registered company name.

Example
"legalName": "Central Speedball Ltd"
logo
 ImageObject​
A logo for the Organization.

Example
"logo": {
  "@type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
taxMode
 TaxMode​
Either https://openactive.io/TaxNet or https://openactive.io/TaxGross​
termsOfService
 Array of Terms​
The terms of service of the Seller.
vatID
 Text​
The Value-added Tax ID of the of the Seller.
Beta Extension properties
These properties are defined in the OpenActive Beta Extension. The OpenActive Beta Extension is defined as a convenience to help document properties that are in active testing and review by the community. Publishers should not assume that properties in the beta namespace will either be added to the core specification or be included in the namespace over the long term.
Property
Expected Type
Description
beta:formalCriteriaMet
 Array of URL​
​Proposal #236​
An array of URLs, each of which describe the formal criteria that are met by the organizer.
beta:formattedDescription
 Text​
​Proposal #276​
Sometimes a description is stored with formatting (e.g. href, bold, italics, embedded YouTube videos). This formatting can be useful for data consumers. This property must contain HTML.
beta:video
 Array of VideoObject​
​Proposal #88​
A related video object.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution License (CC-BY V4.0), and code samples are licensed under the MIT License, for anyone to access, use and share; using attribution "OpenActive".

Order

ParagraphFormFieldSpecification

Last updated 1 week ago

Property	Expected Type	Description
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" ]`
telephone	`Text`	The telephone number of the Organization Example `"telephone": "01234 567890"`
url	`URL`	A definitive canonical URL for the Organization. Example `"url": "http://www.speedball-world.com"`

Property	Expected Type	Description
@type	`Text`	Must always be present and set to `"@type": "Organization"`
@id	`URL`	A unique URI-based identifier for the record. `@id` properties are used as identifiers for compatibility with JSON-LD. The value of such a property must always be an absolute URI that provides a stable globally unique identifier for the resource, as described in RFC3986. The primary purpose of the URI format in this context is to provide natural namespacing for the identifier. Hence, the URI itself may not resolve to a valid endpoint, but must use a domain name controlled by the resource owner (the organisation responsible for the OpenActive open data feed). Example `"@id": "https://id.bookingsystem.example.com/organizers/1"`
address	`PostalAddress`	Address of the Seller, used on tax receipts.
description	`Text`	A plain text description of the Organization, which must not include HTML or other markup. Example `"description": "The national governing body of cycling"`
email	`Text`	General enquiries e-mail address for the organization. Example `"email": "[email protected]"`
identifier	`Text` - or - `PropertyValue` - or - Array of `PropertyValue` - or - `Integer`	A local non-URI identifier for the resource Example `"identifier": "SB1234"`
isOpenBookingAllowed	`Boolean`	Indicates whether the Seller allows open booking or not Example `"isOpenBookingAllowed": "true"`
legalName	`Text`	The official name of the organization, e.g. the registered company name. Example `"legalName": "Central Speedball Ltd"`
logo	`ImageObject`	A logo for the Organization. Example `"logo": { "@type": "ImageObject", "url": "http://example.com/static/image/speedball_large.jpg" }`
taxMode	`TaxMode`	Either https://openactive.io/TaxNet or https://openactive.io/TaxGross
termsOfService	Array of `Terms`	The terms of service of the Seller.
vatID	`Text`	The Value-added Tax ID of the of the Seller.

Property	Expected Type	Description
beta:formalCriteriaMet	Array of `URL`	Proposal #236 An array of URLs, each of which describe the formal criteria that are met by the organizer.
beta:formattedDescription	`Text`	Proposal #276 Sometimes a description is stored with formatting (e.g. href, bold, italics, embedded YouTube videos). This formatting can be useful for data consumers. This property must contain HTML.
beta:video	Array of `VideoObject`	Proposal #88 A related video object.