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-resource-schema.adoc#anchor-attributes.

  • 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 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:

"howToArrive": {
  "eng": "Arriving in Bolzano by car - Coming from the South (Verona – Trento) and from the North (München – Innsbruck) use the Brennero A22 motorway and take the exits Bolzano-Sud or Bolzano-Nord. Coming from the South (Trento) you can also take the state road SS12."
}

A summary of the attributes object is presented in the table below:

Field Type Constraints

abstract

datatypes.adoc#anchor-text

Nullable

address

datatypes.adoc#anchor-address

Nullable

categories

Array of datatypes.adoc#anchor-type

Nullable, Non-empty

description

datatypes.adoc#anchor-text

Nullable, Conditional Assignment

geometries

Array of datatypes.adoc#anchor-geometry

Nullable, Non-empty

howToArrive

string

Nullable

name

datatypes.adoc#anchor-text

Non-nullable, Conditional Assignment

shortName

datatypes.adoc#anchor-text

Nullable

url

datatypes.adoc#anchor-url

Nullable

3. Relationships

The relationships object of a mountain area resource MUST contain the following fields:

A summary of the relationships is presented in the table below:

Field Type Constraints

multimediaDescriptions

Array of references to Media Objects

Nullable, Non-empty

See definition of the links object in basic-resource-schema.adoc#anchor-links.

5. Endpoints

The following endpoints in this API specification return venue resources:

6. Examples

he 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,
    "area": null,
    "categories": null,
    "description": null,
    "geometries": null,
    "howToArrive": null,
    "name": {
      "eng": "Auditorium 1"
    },
    "shortName": null,
    "url": null
  },
  "relationships": {
    "multimediaDescriptions": null
  },
  "links": {
    "self": "http://example.com/1.0/venues/1"
  }
}

asciidoc/examples/venue.min.json

The following example presents an object representing a venue resource:

{
  "type": "venues",
  "id": "1",
  "meta": {
    "dataProvider": "http://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"
      ]
    },
    "area": 150,
    "categories": [
      "example/auditorium"
    ],
    "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": {
    "multimediaDescriptions": {
      "data": [
        {
          "type": "mediaObjects",
          "id": "1"
        }
      ],
      "links": {
        "related": "http://example.com/1.0/venues/1/multimediaDescriptions"
      }
    }
  },
  "links": {
    "self": "http://example.com/1.0/venues/1"
  }
}

asciidoc/examples/venue.full.json