Lifts

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

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

  • type: the constant "lifts" that identifies the resource as being a lift.

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

  • attributes: an object containing the attributes of the lift.

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

  • links: an object containing the links related to the lift.

A lift resource is structured as follows:

{
  "type": "lifts",
  "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 a lift resource MUST contain the following fields:

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

  • address: an datatypes.adoc#anchor-address object representing the address of the lift. The address should only be set if the lift is directly accessible from a public road. In such cases, the address should be that of the base station. Nullable.

  • capacity: a number representing how many persons the lift can transport hourly on average. Nullable. Positive value.

  • categories: an array of datatypes.adoc#anchor-type strings identifying the types instantiated by the lift. Nullable. The standard recommends the following lift types:, "alpinebits/chairlift", "alpinebits/gondola", "alpinebits/skilift", "alpinebits/cablecar, "alpinebits/funicular", "alpinebits/magic-carpet", "alpinebits/skibus", "alpinebits/train"

  • description: a datatypes.adoc#anchor-text object containing a description of the lift. Nullable. Conditional Assignment. See 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 lift in terms of GPS coordinates. There should be at most one geometry object of each type (e.g. Point, LineString). Nullable.

  • howToArrive: a datatypes.adoc#anchor-text object containing instructions on how to arrive at the lift. Nullable.

  • length: a number representing the length of the lift in meters. Nullable.

  • maxAltitude: a number representing the highest elevation point of the lift in meters above sea level. Nullable.

  • minAltitude: a number representing the lowest elevation point of the lift in meters above sea level. Nullable.

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

  • openingHours: an array of datatypes.adoc#anchor-hoursspecification objects representing the hours in which the lift is open to the public. Nullable.

  • personsPerChair: an integer representing the number of persons that fit in a single chair/cabin of a lift. Nullable. Positive value.

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

  • url: a datatypes.adoc#anchor-url describing the lift, 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

address

datatypes.adoc#anchor-address

Nullable

capacity

number

Nullable, Greater than Zero

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

datatypes.adoc#anchor-text

Nullable

length

number

Nullable, Unit of Measure, Greater than Zero

maxAltitude

number

Nullable, Unit of Measure

minAltitude

number

Nullable, Unit of Measure

name

datatypes.adoc#anchor-url

Non-nullable, Conditional Assignment

openingHours

Array of datatypes.adoc#anchor-hoursspecification

Nullable, Non-empty

personsPerChair

integer

Nullable, Greater than Zero

shortName

datatypes.adoc#anchor-text

Nullable

url

datatypes.adoc#anchor-url

Nullable

3. Relationships

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

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

Field Type Constraints

connections

basic-resource-schema.adoc#anchor-referencetomany object to Mountain Areas, Trails, Lifts and Snowparks

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 lifts resources:

  • https://example.com /1.0/lifts: returns a collection of lifts.

  • https://example.com /1.0/lifts/:id: returns the lift identified by the :id parameter.

  • https://example.com /1.0/lifts/:id/connections: returns a collection of resources which may include lifts.

  • https://example.com /1.0/mountainAreas/:id/lifts: returns a collection of lifts.

  • https://example.com /1.0/mountainAreas/:id/connections: returns a collection of resources which may include lifts.

  • https://example.com /1.0/snowparks/:id/connections: returns a collection of resources which may include lifts.

  • https://example.com /1.0/trails/:id/connections: returns a collection of resources which may include lifts.

6. Examples

The following example contains the minimal information required for a lift resource:

{
  "type": "lifts",
  "id": "merano2000-l1",
  "meta": {
    "dataProvider": null,
    "lastUpdate": null
  },
  "attributes": {
    "name": {
      "eng": "Ropeway Merano 2000"
    },
    "shortName": null,
    "description": null,
    "abstract": null,
    "url": null,
    "categories": null,
    "length": null,
    "minAltitude": null,
    "maxAltitude": null,
    "capacity": null,
    "personsPerChair": null,
    "openingHours": null,
    "address": {
      "street": null,
      "city": {
        "eng": "Merano"
      },
      "region": null,
      "country": "IT",
      "zipcode": null,
      "categories": null,
      "complement": null
    },
    "geometries": null,
    "howToArrive": null
  },
  "relationships": {
    "connections": null,
    "multimediaDescriptions": null
  },
  "links": {
    "self": "http://example.com/1.0/lifts/1"
  }
}

asciidoc/examples/lift.min.json

The following example illustrates the fields defined for lift resources:

{
  "type": "lifts",
  "id": "1",
  "meta": {
    "dataProvider": "http://example.com",
    "lastUpdate": "2020-04-01T08:00:00+02:00"
  },
  "attributes": {
    "name": {
      "deu": "Bergbahn Meran 2000",
      "eng": "Ropeway Merano 2000",
      "ita": "Funivia Merano 2000"
    },
    "shortName": {
      "deu": "Meran 2000",
      "eng": "Merano 2000",
      "ita": "Merano 2000"
    },
    "description": {
      "ita": "Situata a pochi minuti dalla città di Merano, la Funivia conduce all’area sciistica ed escursionistica Merano 2000, un luogo ideale in cui passare una vacanza all’insegna del movimento e della buona cucina con tutta la famiglia. Grazie al suo clima mite, l’area offre infinite possibilità per il tempo libero in ogni stagione: impianti di risalita, sentieri escursionistici facili e numerosi rifugi in cui sostare per assaporare l’ottima cucina locale in un paesaggio ricco e dominato dalla tranquillità."
    },
    "abstract": {
      "ita": "Situata a pochi minuti dalla città di Merano, la Funivia conduce all’area sciistica ed escursionistica Merano 2000, un luogo ideale in cui passare una vacanza all’insegna del movimento e della buona cucina con tutta la famiglia..."
    },
    "url": "http://example.com",
    "categories": [
      "alpinebits/cablecar"
    ],
    "length": 3650,
    "minAltitude": 1000,
    "maxAltitude": 2350,
    "capacity": 200,
    "personsPerChair": 10,
    "openingHours": {
      "dailySchedules": {
        "2020-12-25": null
      },
      "weeklySchedules": [
        {
          "validFrom": "2020-01-01",
          "validTo": "2020-12-31",
          "monday": [
            {
              "opens": "08:00:00+01:00",
              "closes": "18:00:00+01:00"
            }
          ],
          "tuesday": [
            {
              "opens": "08:00:00+01:00",
              "closes": "18:00:00+01:00"
            }
          ],
          "wednesday": [
            {
              "opens": "08:00:00+01:00",
              "closes": "18:00:00+01:00"
            }
          ],
          "thursday": [
            {
              "opens": "08:00:00+01:00",
              "closes": "18:00:00+01:00"
            }
          ],
          "friday": [
            {
              "opens": "08:00:00+01:00",
              "closes": "18:00:00+01:00"
            }
          ],
          "saturday": [
            {
              "opens": "08:00:00+01:00",
              "closes": "18:00:00+01:00"
            }
          ],
          "sunday": [
            {
              "opens": "08:00:00+01:00",
              "closes": "18:00:00+01:00"
            }
          ]
        }
      ]
    },
    "address": {
      "street": {
        "deu": "Naifweg 37",
        "eng": "37 Val di Nova Street",
        "ita": "Via Val di Nova, 37"
      },
      "city": {
        "deu": "Meran",
        "eng": "Merano",
        "ita": "Merano"
      },
      "region": {
        "deu": "Trentino-Südtirol",
        "eng": "Trentino-Alto Adige",
        "ita": "Trentino-Alto Adige"
      },
      "country": "IT",
      "zipcode": "39012",
      "categories": null,
      "complement": null
    },
    "geometries": [
      {
        "type": "LineString",
        "coordinates": [
          [
            11.305682659149168,
            46.66705018437341
          ],
          [
            11.30692720413208,
            46.667182709603225
          ],
          [
            11.308064460754393,
            46.667491933875965
          ]
        ]
      }
    ],
    "howToArrive": {
      "ita": "Fino alla stazione a valle della Funivia Merano 2000: dalla stazione ferroviaria di Merano si raggiunge in pochi minuti la stazione a valle Val di Nova con la linea urbana 1A. Da Scena c'è il bus vacanze che porta fino alla Val di Nova.",
      "deu": "Zur Talstation der Bergbahn Meran 2000: vom Zugbahnhof Meran erreicht man in wenigen Minuten die Talstation Naif mit der Buslinie 1A. Von Schenna aus fährt der Gästebus bis zur Talstation Naif."
    }
  },
  "relationships": {
    "connections": {
      "data": [
        {
          "type": "trails",
          "id": "1"
        },
        {
          "type": "trails",
          "id": "2"
        }
      ],
      "links": {
        "related": "http://example.com/1.0/lifts/1/connections/"
      }
    },
    "multimediaDescriptions": {
      "data": [
        {
          "type": "mediaObjects",
          "id": "1"
        }
      ],
      "links": {
        "related": "http://example.com/1.0/mountainAreas/1/multimediaDescriptions/"
      }
    }
  },
  "links": {
    "self": "http://example.com/1.0/lifts/1"
  }
}

asciidoc/examples/lift.full.json