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 Fields. -
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 the 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 the 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. -
description: a datatypes.adoc#anchor-text object containing a description of the lift. 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 lift 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 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 the definition in basic-resource-schema.adoc#anchor-attributes. -
openingHours: an datatypes.adoc#anchor-hoursspecification object 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 the definition in basic-resource-schema.adoc#anchor-attributes. -
url: a datatypes.adoc#anchor-url object or string describing the lift, such as a website or a Wikipedia page. Nullable. See the definition in basic-resource-schema.adoc#anchor-attributes.
A summary of the attributes is presented in the table below:
| Field | Type | Constraints |
|---|---|---|
abstract |
Nullable |
|
address |
Nullable |
|
capacity |
number |
Nullable, Greater than Zero |
description |
Nullable, Conditional Assignment |
|
geometries |
Array of datatypes.adoc#anchor-geometry |
Nullable, Non-empty |
howToArrive |
Nullable |
|
length |
number |
Nullable, Unit of Measure, Greater than Zero |
maxAltitude |
number |
Nullable, Unit of Measure |
minAltitude |
number |
Nullable, Unit of Measure |
name |
Non-nullable, Conditional Assignment |
|
openingHours |
Nullable |
|
personsPerChair |
integer |
Nullable, Greater than Zero |
shortName |
Nullable |
|
url |
Nullable |
3. Relationships
The relationships object of a lift resource MUST contain the following fields:
-
categories: a basic-resource-schema.adoc#anchor-referencetomany category resources that are instantiated by the lift. See Section Categories. Nullable. Non-empty.The standard recommends the following categories for lifts:,
"alpinebits:chairlift","alpinebits:gondola","alpinebits:skilift","alpinebits:cablecar,"alpinebits:funicular","alpinebits:magic-carpet","alpinebits:skibus","alpinebits:train". -
connections: a basic-resource-schema.adoc#anchor-referencetomany place resources that identify the places that are physically accessible from the lift, which may include Mountain Areas, other Lifts, Snowparks, and Ski Slopes. Nullable. Non-empty. -
multimediaDescriptions: a basic-resource-schema.adoc#anchor-referencetomany media object resources (see Media Objects) that are related to the lift. 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 |
connections |
basic-resource-schema.adoc#anchor-referencetomany object to Mountain Areas, Ski Slopes, Lifts, and Snowparks |
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. Endpoints
The following endpoints in this API specification return lift resources:
-
https://example.com /2021-04/lifts: returns a collection of lifts. -
https://example.com /2021-04/lifts/:id: returns the lift identified by the:idparameter. -
https://example.com /2021-04/lifts/:id/connections: returns a collection of resources that may include lifts. -
https://example.com /2021-04/mountainAreas/:id/lifts: returns a collection of lifts. -
https://example.com /2021-04/mountainAreas/:id/connections: returns a collection of resources that may include lifts. -
https://example.com /2021-04/snowparks/:id/connections: returns a collection of resources that may include lifts. -
https://example.com /2021-04/skiSlopes/:id/connections: returns a collection of resources that 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,
"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,
"categories": null,
"multimediaDescriptions": null
},
"links": {
"self": "https://example.com/2021-04/lifts/1"
}
}
|
The following example illustrates the fields defined for lift resources:
{
"type": "lifts",
"id": "1",
"meta": {
"dataProvider": "https://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": "https://example.com",
"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": "skiSlopes",
"id": "1"
},
{
"type": "skiSlopes",
"id": "2"
}
],
"links": {
"related": "https://example.com/2021-04/lifts/1/connections/"
}
},
"categories": {
"data": [
{
"type": "categories",
"id": "alpinebits:cablecar"
}
],
"links": {
"related": "https://example.com/2021-04/lifts/1/categories"
}
},
"multimediaDescriptions": {
"data": [
{
"type": "mediaObjects",
"id": "1"
}
],
"links": {
"related": "https://example.com/2021-04/lifts/1/multimediaDescriptions/"
}
}
},
"links": {
"self": "https://example.com/2021-04/lifts/1"
}
}
|