Skip to content

Latest commit

 

History

History
114 lines (97 loc) · 4.06 KB

dropdownformfieldspecification.md

File metadata and controls

114 lines (97 loc) · 4.06 KB
Raw
description
This page describes the DropdownFormFieldSpecification type.

DropdownFormFieldSpecification

This type is derived from https://schema.org/PropertyValueSpecification, 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": "DropdownFormFieldSpecification"
@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/gender"
name Text

Display label for the field.
valueOption Array of Text

Specifies an array of display values for the dropdown.

Recommended properties

Property Expected Type Description
description Text

Descriptive help plain text for the field, which must not include HTML or other markup.

Optional properties

Property Expected Type Description
valueRequired Boolean

Specifies that a value for the field is required to proceed with the booking.

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