Event Series

A resource that implements the concept of Event Series defined in the AlpineBits® DestinationData Ontology.

A JSON object representing such a resource MUST contain the following fields:

  • type: the constant "eventSeries" that identifies the resource as being of the type event series.

  • id: a string that uniquely and persistently identifies the event series within a SERVER. See the definition in basic-resource-schema.adoc#anchor-attributes.

  • attributes: an object containing the attributes of the event series.

  • relationships: an object containing the relationships of the event series to other resources.

  • links: an object containing the links related to the event series.

Event series resources are structured in the following way:

{
  "type": "eventSeries",
  "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 event resource MUST contain the following fields:

  • abstract: a datatypes.adoc#anchor-text object containing a brief description for the event series. Nullable. See definition in basic-resource-schema.adoc#anchor-attributes.

  • categories: an array of datatypes.adoc#anchor-type strings identifying the types instantiated by the event series. Nullable. No type is pre-defined by the standard.

  • description: a datatypes.adoc#anchor-text object containing a description of the event series. Nullable. Conditional Assignment. See definition in basic-resource-schema.adoc#anchor-attributes.

  • frequency: a string representing how often editions of the event series are organized according to an enumeration of possible values. Nullable. Enumeration.
    For example, event series with frequency set to "weekly" may include street markets and guided city tours, while event series with frequency set to "yearly" may include Südtirol Jazz Festival or Flower Festival.
    If set, the frequency field MUST be assigned one of the following values:

    • daily: when editions of the event series are organized every day, such as the daily street market of Bolzano.

    • weekly: when editions of the event series are organized every week, such as the weekly farmers' market of Bolzano.

    • monthly: when editions of the event series are organized every month, such as a flea market organized every month.

    • bimonthly: when editions of the event series are organized every two months.

    • quarterly: when editions of the event series are organized every three months.

    • annual: when editions of the event series are organized every year, such as the Südtirol Jazz Festival or Bolzano’s Christmas Market.

    • biennial: when editions of the event series are organized every two years.

    • triennial: when editions of the event series are organized every three years.

  • name: a datatypes.adoc#anchor-text object containing the complete name of the event series. Non-nullable. Conditional Assignment. See definition in basic-resource-schema.adoc#anchor-attributes.

  • shortName: a datatypes.adoc#anchor-text object containing a short name of the event series. Nullable. See definition in basic-resource-schema.adoc#anchor-attributes.

  • url: a datatypes.adoc#anchor-url describing the event series, such as a website or a Wikipedia page. Nullable.

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

Field Type Constraints

abstract

datatypes.adoc#anchor-text

Nullable

categories

Array of datatypes.adoc#anchor-type

Nullable, Non-empty

description

datatypes.adoc#anchor-text

Nullable, Conditional Assignment

frequency

string

Nullable, Enumeration

name

datatypes.adoc#anchor-url

Non-nullable, Conditional Assignment

shortName

datatypes.adoc#anchor-text

Nullable

url

datatypes.adoc#anchor-url

Nullable

3. Relationships

The relationships object of an event series resource MUST contain the following fields:

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

Field Type Constraints

editions

basic-resource-schema.adoc#anchor-referencetomany object to Events

Nullable, Non-empty

multimediaDescriptions

basic-resource-schema.adoc#anchor-referencetomany object 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 event series resources:

  • https://example.com /1.0/eventSeries: returns a collection of events series.

  • https://example.com /1.0/eventSeries/:id: returns the event series identified by the :id parameter.

  • https://example.com /1.0/events/:id/eventSeries: returns the of event series of which the event is an edition.

6. Examples

The following example presents an object containing the minimal information required of an event series resource:

{
  "type": "eventSeries",
  "id": "1",
  "meta": {
    "dataProvider": null,
    "lastUpdate": null
  },
  "attributes": {
    "abstract": null,
    "categories": null,
    "description": null,
    "frequency": null,
    "name": {
      "eng": "Südtirol Jazz Festival"
    },
    "shortName": null,
    "url": null
  },
  "relationships": {
    "multimediaDescriptions": null,
    "editions": null
  },
  "links": {
    "self": "http://example.com/1.0/eventSeries/1"
  }
}

asciidoc/examples/eventseries.min.json

The following example presents an object representing an event series resource:

{
  "type": "eventSeries",
  "id": "1",
  "meta": {
    "dataProvider": "http://example.com",
    "lastUpdate": "2020-04-01T08:00:00+02:00"
  },
  "attributes": {
    "abstract": {
      "eng": "The Südtirol Jazzfestival Alto Adige was held for the first time in 1982 under the name of “Jazz Summer”..."
    },
    "categories": [
      "example/festival"
    ],
    "description": {
      "eng": "The Südtirol Jazzfestival Alto Adige was held for the first time in 1982 under the name of “Jazz Summer”, which went on to become “Jazz & Other”. While in the early years the concerts were played only in Bolzano itself, today the festival stretches throughout the whole of South Tyrol and beyond."
    },
    "frequency": "annual",
    "name": {
      "eng": "Südtirol Jazz Festival",
      "ita": "Südtirol Jazz Festival",
      "deu": "Südtirol Jazz Festival"
    },
    "shortName": {
      "eng": "Südtirol Jazz Festival"
    },
    "url": "https://www.suedtiroljazzfestival.com/"
  },
  "relationships": {
    "multimediaDescriptions": {
      "data": [
        {
          "type": "mediaObjects",
          "id": "1"
        }
      ],
      "links": {
        "related": "http://example.com/1.0/eventSeries/1/multimediaDescriptions"
      }
    },
    "editions": {
      "data": [
        {
          "type": "events",
          "id": "1"
        },
        {
          "type": "events",
          "id": "2"
        }
      ],
      "links": {
        "related": "http://example.com/1.0/eventSeries/1/editions"
      }
    }
  },
  "links": {
    "self": "http://example.com/1.0/eventSeries/1"
  }
}

asciidoc/examples/eventseries.full.json