Brand

This page describes the Brand type.

This type is derived from https://schema.org/Brand, 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

@type

Text

Must always be present and set to "@type": "Brand"

name

Text

The name of the brand.

Example

"name": "Play Ball!"

url

URL

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

Example

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

Property

Expected Type

Description

description

Text

A plain text description for the brand, which must not include HTML or other markup.

Example

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

logo

ImageObject

The logo associated with the brand.

Example

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

Optional properties

Property

Expected Type

Description

@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://example.com/programmes/12345"

identifier

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

A local non-URI identifier for the resource

Example

"identifier": "BR1234"

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