Venues
A resource that implements the concept of Venue defined in the AlpineBits® DestinationData Ontology.
A JSON object representing such a resource MUST contain the following fields:
-
type: the constant"venues"that identifies the resource as being of the type venue. -
id: a string that uniquely and persistently identifies the venue within a SERVER. See the definition in Basic Fields. -
attributes: an object containing the attributes of the venue. -
relationships: an object containing the relationships of the venue to other resources. -
links: an object containing the links related to the venue.
Venue resources are structured in the following way:
{
"type": "venues",
"id": "1",
"meta": { ... },
"attributes": { ... },
"relationships": { ... },
"links": { ... }
}1. Meta
See the definition of the meta object in basic-resource-schema.adoc#anchor-metadata.
2. Attributes
The attributes object of the venue resource MUST contain the following fields:
-
abstract: a datatypes.adoc#anchor-text object containing a brief description of the venue. Nullable. See the definition in basic-resource-schema.adoc#anchor-attributes. -
address: an datatypes.adoc#anchor-address object containing the address of the venue. Nullable. -
description: a datatypes.adoc#anchor-text object containing a description of the venue. Nullable. Conditional Assignment. See the definition in basic-resource-schema.adoc#anchor-attributes. -
geometries: an array of datatypes.adoc#anchor-geometry objects each of which represents the location of the venue in terms of GPS coordinates. There should be at most one geometry object of each type (e.g. Point, LineString). Nullable. Non-empty. -
howToArrive: a datatypes.adoc#anchor-text object containing instructions on how to arrive at the venue. Nullable. -
name: a datatypes.adoc#anchor-text object containing the complete name of the venue. Non-nullable. Conditional Assignment. See the definition in basic-resource-schema.adoc#anchor-attributes. -
shortName: a datatypes.adoc#anchor-text object containing a short name of the venue. Nullable. See the definition in basic-resource-schema.adoc#anchor-attributes. -
url: a datatypes.adoc#anchor-url object or string describing the venue, such as a website or a Wikipedia page. Nullable. See the definition in basic-resource-schema.adoc#anchor-attributes.
A summary of the attributes object is presented in the table below:
| Field | Type | Constraints |
|---|---|---|
abstract |
Nullable |
|
address |
Nullable |
|
description |
Nullable, Conditional Assignment |
|
geometries |
Array of datatypes.adoc#anchor-geometry |
Nullable, Non-empty |
howToArrive |
string |
Nullable |
name |
Non-nullable, Conditional Assignment |
|
shortName |
Nullable |
|
url |
Nullable |
3. Relationships
The relationships object of a mountain area resource MUST contain the following fields:
-
categories: a basic-resource-schema.adoc#anchor-referencetomany category resources that are instantiated by the venue. See Section Categories. Nullable. Non-empty.No category is pre-defined by the standard.
-
multimediaDescriptions: a basic-resource-schema.adoc#anchor-referencetomany media object resources (see Media Objects) that are related to the venue. See Section basic-resource-schema.adoc#anchor-multimediadescriptions. Nullable. Non-empty.
A summary of the relationships is presented in the table below:
| Field | Type | Constraints |
|---|---|---|
categories |
basic-resource-schema.adoc#anchor-referencetomany object to Categories |
Nullable, Non-empty |
multimediaDescriptions |
basic-resource-schema.adoc#anchor-referencetomany object to Media Objects |
Nullable, Non-empty |
4. Links
See the definition of the links object in basic-resource-schema.adoc#anchor-links.
5. Examples
The following example presents an object containing the minimal information required of a venue resource:
{
"type": "venues",
"id": "1",
"meta": {
"dataProvider": null,
"lastUpdate": null
},
"attributes": {
"abstract": null,
"address": null,
"description": null,
"geometries": null,
"howToArrive": null,
"name": {
"eng": "Auditorium 1"
},
"shortName": null,
"url": null
},
"relationships": {
"categories": null,
"multimediaDescriptions": null
},
"links": {
"self": "https://example.com/2022-04/venues/1"
}
}
|
The following example presents an object representing a venue resource:
{
"type": "venues",
"id": "1",
"meta": {
"dataProvider": "https://example.com",
"lastUpdate": "2020-04-01T08:00:00+02:00"
},
"attributes": {
"abstract": {
"eng": "The Auditorium 1 of the Free University of Bozen-Bolzano provides a great space for keynotes, lectures and presentations."
},
"address": {
"street": {
"ita": "Piazza Università, 1",
"deu": "Universitätsplatz 1"
},
"city": {
"deu": "Bozen"
},
"region": {
"deu": "Trentino-Südtirol"
},
"country": "IT",
"zipcode": "39100",
"complement": {
"deu": "Hauptgebäude"
},
"categories": [
"example:building"
]
},
"description": {
"eng": "The Auditorium 1 of the Free University of Bozen-Bolzano provides a great space for keynotes, lectures and presentations, being available to host events related academic, provincial and cultural topics."
},
"geometries": [
{
"type": "Point",
"coordinates": [
11.35087251663208,
46.49873937419277
]
}
],
"howToArrive": {
"eng": "From the train station, the Free University of Bozen-Bolzano is accessible in a 5 minutes walk into the historical city center."
},
"name": {
"eng": "Auditorium 1 - Free University of Bozen-Bolzano"
},
"shortName": {
"eng": "Auditorium 1"
},
"url": "https://example.com/auditorium-1"
},
"relationships": {
"categories": {
"data": [
{
"type": "categories",
"id": "example:auditorium"
}
],
"links": {
"related": "https://example.com/2022-04/venues/1/categories"
}
},
"multimediaDescriptions": {
"data": [
{
"type": "mediaObjects",
"id": "1"
}
],
"links": {
"related": "https://example.com/2022-04/venues/1/multimediaDescriptions"
}
}
},
"links": {
"self": "https://example.com/2022-04/venues/1"
}
}
|