VirtualLocation

This page describes the VirtualLocation type.

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

Required options

A data publisher must provide either a name, description or url for the VirtualLocation.

Property

Expected Type

Description

name

Text​

The name of the service that is providing remote access to the Opportunity.

Example

"name": "Zoom"

description

Text​

A plain text description of the live stream, including any instructions to join. This description must not include HTML or other markup.

Example

"description": "Please log into Zoom a few minutes before the event, and mute your mic while you wait for the session to start."

url

URL​

The URL that enables remote access to the Opportunity, which should include encoded access credentials where possible.

Example

"url": "https://zoom.us/room/3fbCs0GVjgQ"

Optional properties

Property

Expected Type

Description

accessCode

Text​

The password or pin required to access the VirtualLocation from any device, without requiring the URL, e.g. the meeting password.

Example

"accessCode": "211277"

accessId

Text​

The identifier required to access the VirtualLocation from any device, without requiring the URL, e.g. the meeting ID.

Example

"accessId": "123456789"

description

Text​

A plain text description of the live stream, including any instructions to join. This description must not include HTML or other markup.

Example

"description": "Please log into Zoom a few minutes before the event, and mute your mic while you wait for the session to start."

name

Text​

The name of the service that is providing remote access to the Opportunity.

Example

"name": "Zoom"

url

URL​

The URL that enables remote access to the Opportunity, which should include encoded access credentials where possible.

Example

"url": "https://zoom.us/room/3fbCs0GVjgQ"

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