Data Schema

This page documents the schemas of all the tables available via Paddel Buch’s static API.

Common Global Fields

The following fields are common to all tables:

Field	Description
`slug`	A URL slug for the entry. Slugs are guaranteed to be unique within each table, however they may not be unique across tables. This field should be used to join entries across languages (as specified in the `node_locale` field), for example to join the German version of a spot to its English version.
`node_locale`	The language of the entry defined using ISO 639-1 2 letter language codes.
`createdAt`	The date and time at which the entry was first created in ISO 8601 format.
`updatedAt`	The date and time at which the entry last modified in ISO 8601 format.
`name`	The name of the entry. Names are guaranteed to be unique within each table, however they may not be unique across tables.

Fact Tables

These tables contain Paddel Buch's primary data and are updated most frequently.

Common Fact Table Fields

The following fields are common to all fact tables:

Field	Description
`dataSourceType`	The slug of the Data Source Type which applies to the entry.
`dataLicenseType`	The slug of the Data License Type which applies to the entry.

Spots

This table describes places from which a paddle craft may be launched, recovered, or may stop for a break, along a waterway.

Field	Description	Join Field to Table
`description`	A description of the spot in Contentful rich text format as described in the Contentful documentation. Distances given within the description are approximate walking distances along public rights of way, given to the nearest 10 meters. Where no description is provided this field has a value of `null`.
`location`	The GPS coordinates of the spot in decimal degrees, with separate subfields for latitude (`lat`) and longitude (`lon`).
`approximateAddress`	The approximate street address of the spot as a simple string. This address is chosen to provide try and provide the best user experience when this address is used in a navigation system or app to reach the spot.
`country`	The country the spot is located in, described using ISO 3166-1 alpha-2 format.
`confirmed`	A Boolean describing whether a trusted source, usually a member of FAKO Seekajak at Swiss Canoe, has physically visited the spot and confirmed its suitability. When this has occurred the field has the value `true`. Nulls in this field should be treated as equivalent to `false`.
`rejected`	A Boolean describing whether the spot has been rejected. Spots may have a value of `true` for one of two reasons: 1. The spot was previously listed as usable, however subsequent information has changed this assessment. 2. The spot may appear usable when approached from the water, however signage or the environment on the land side render it unusable. Rejected spots are shown in the web interface under the title “No Entry Spot”.
`waterway`	The slug of the waterway on which the spot is located under the subfield `slug`.	Waterways
`spotType`	The slug of the spot type which describes the spot under the subfield `slug`.	Spot Types
`paddlingEnvironmentType`	The slug of the paddling environment type which describes the type of water paddlers can expect at this spot, under the subfield `slug`.	Paddling Environment Types
`paddleCraftType`	A list of the slugs for the paddle craft types which can use the spot. Each item in the list has a `slug` field containing the slug.	Paddle Craft Types
`waterway_event_notice`	A list of the slugs of any waterway event notices which affect the spot. Each item in the list has a `slug` field containing the slug. This field has a null value when no waterway event notices affect the spot.	Waterway Event Notices
`obstacle`	A list of the slugs of any obstacles with which the spot is associated. Each item in the list has a `slug` field containing the slug. This field has a null value when the spot is not associated with any obstacles.	Obstacle

Waterway Event Notices

This table contains Waterway Event Notices provided by the Kantons and other stakeholders to the Swiss Canoe Meldestelle für absehbare Gewässerereignisse.

Only notices which affect a lake or river section of Whitewater class 2 or below are included in this table.

Field	Description	Join Field to Table
`startDate`	The date at which the event starts, in the format `YYYY-MM-DD`.
`endDate`	The date at which the event ends, in the format `YYYY-MM-DD`.
`description`	The content of the waterway event notice in Contentful rich text format as described in the Contentful documentation. Where no description is provided this field has a value of `null`.
`affectedArea`	A GeoJSON geometry describing the area affected by the waterway event notice, under the subfield path “`internal` > `content`”.
`spot`	A list of the slugs of any spots with which are affected by this waterway event notice. Each item in the list has a `slug` field containing the slug. This field has a null value when there are no spots affected by the waterway event notice.	Spots
`waterway`	A list of the slugs of the waterways which are affected by this waterway event notice. Each item in the list has a `slug` field containing the slug.	Waterways

Obstacles

This table describes obstacles on waterways, such as dams, locks, or closed river sections.

Field	Description	Join Field to Table
`description`	A description of the obstacle in Contentful rich text format as described in the Contentful documentation. Where no description is provided this field has a value of `null`.
`geometry`	A GeoJSON geometry describing the extents of the obstacle, under the subfield path “`internal` > `content`”.
`isPortageNecessary`	A Boolean describing whether portage over land is necessary to traverse this obstacle. This field has a null value when it is not known whether portage is necessary.
`isPortagePossible`	A Boolean describing whether portage over land is possible to traverse this obstacle. This field has a null value when it is not known whether portage is possible.
`portageRoute`	A GeoJSON geometry describing the portage route, if one is known, under the subfield path “`internal` > `content`”.
`portageDistance`	An integer giving the portage distance in meters if a portage route is known.
`portageDescription`	A description of the portage route for the obstacle in Contentful rich text format as described in the Contentful documentation. Where no description is provided this field has a value of `null`.
`obstacleType`	The slug of the obstacle type which describes the obstacle under the subfield `slug`.	Obstacles
`waterway`	The slug of the waterway on which the obstacle is located under the subfield `slug`.	Waterways

Protected Areas

This table describes an area on a waterway or waterways which are legally protected, such as nature reserves and swimming areas, or where paddle craft are not permitted.

Field	Description	Join Field to Table
`description`	A description of the protected area in Contentful rich text format as described in the Contentful documentation. Where no description is provided this field has a value of `null`.
`geometry`	A GeoJSON geometry describing the extents of the protected area, under the subfield path “`internal` > `content`”.
`isAreaMarked`	A Boolean describing whether the protected area is visibly marked on the water, such as by yellow buoys. This field has a null value when it is not known whether the protected area is marked.
`protectedAreaType`	The slug of the protected area type which describes the protected area under the subfield `slug`.	Protected Area Types
`waterway`	A list of the slugs of the waterways which this protected area lies. Each item in the list has a `slug` field containing the slug.	Waterways

Waterways

This table describes waterways, such as lakes or rivers.

Field	Description	Join Field to Table
`length`	The length of the waterway in kilometres. This field is intended for waterways of `paddlingEnvironment = fluss` and has a null value for other types of waterway.
`area`	Approximate surface area of the waterway in square kilometres. This field is intended for waterways of `paddlingEnvironment = see` and has a null value for other types of waterway.
`geometry`	A GeoJSON geometry describing the extents of the waterway, under the subfield path “`internal` > `content`”.
`paddlingEnvironmentType`	The slug of the paddling environment type which describes the waterway, under the subfield `slug`.	Paddling Environment Type

Dimension Tables

These tables contain dimension data referenced by entries in the fact tables via their slugs.

Data License Types

This table contains types of data licenses applicable to entries in the fact tables.

Field	Description
`summaryUrl`	The URL for the summary text of the license type.
`fullTextUrl`	The URL for the full, legal text of the license type.

Data Source Types

This table contains types of data sources for entries in the fact tables used to perform basic data lineage tracking.

Field	Description
`description`	A description of the data source type in Contentful rich text format as described in the Contentful documentation.

Obstacle Types

This table contains types of obstacles found on waterways.

This table only contains the common global fields.

Paddle Craft Types

This table contains types of paddle craft which could potentially use the spots and features described in other tables.

Field	Description
`description`	A description of the paddle craft type in Contentful rich text format as described in the Contentful documentation.

Protected Area Types

This table contains types of protected areas found on waterways.

This table only contains the common global fields.

Spot Types

This table contains types of spots found on waterways.

This table only contains the common global fields.

Last Updated: 08 Jan 2025